Method: answerQuery

Temellendirilmiş üretim kullanarak bir sorguyu yanıtlar.

HTTP isteği

POST https://developerknowledge.googleapis.com/v1alpha:answerQuery

URL, gRPC Kod Dönüştürme söz dizimini kullanır.

İstek metni

İstek içeriği aşağıdaki yapıyla birlikte verileri içerir:

JSON gösterimi 
{
  "query": string,
  "filter": string
}
Alanlar
query

string

Zorunlu. Yanıtlanacak sorgu.
filter

string

İsteğe bağlıdır. Yanıtı temellendirmek için kullanılan arama sonuçlarına katı bir filtre uygular. İfade, https://google.aip.dev/160 adresinde açıklanan söz diziminin bir alt kümesini destekler.

Filtreleme için desteklenen alanlar:

  • content_length_bytes (INTEGER): Document.content alanının bayt cinsinden uzunluğu.
  • data_source (STRING): Belgenin kaynağı (ör. docs.cloud.google.com). Korpusdaki veri kaynaklarının tam listesi için https://developers.google.com/knowledge/reference/corpus-reference adresini ziyaret edin.
  • update_time (TIMESTAMP): Belgenin en son anlamlı şekilde güncellendiği zaman damgası. Anlamlı bir güncelleme, dokümanın Markdown içeriğini veya meta verilerini değiştiren bir güncellemedir.
  • uri (DİZE): Belge URI'si (ör. https://docs.cloud.google.com/bigquery/docs/tables).

INTEGER alanları =, <, <=, > ve >= operatörlerini destekler.

DİZİ alanları, dizenin tamamında tam eşleşme için = (eşittir) ve != (eşit değildir) operatörlerini destekler. Kısmi eşleşme, ön ek eşleşmesi ve normal ifade eşleşmesi desteklenmez.

ZAMAN DAMGASI alanları =, <, <=, > ve >= operatörlerini destekler. Zaman damgaları RFC-3339 biçiminde olmalıdır (ör. "2025-01-01T00:00:00Z").

AND, OR ve NOT (veya -) mantıksal operatörlerini kullanarak ifadeleri birleştirebilirsiniz. OR, AND değerinden daha önceliklidir. Açık öncelik gruplandırması için parantez kullanın.

Örnekler:

  • Document.content_length_bytes: content_length_bytes < 50000 etiketine göre filtrele
  • data_source = "docs.cloud.google.com" OR data_source = "firebase.google.com"
  • data_source != "firebase.google.com"
  • update_time < "2024-01-01T00:00:00Z"
  • update_time >= "2025-01-22T00:00:00Z" AND (data_source = "developer.chrome.com" OR data_source = "web.dev")
  • uri = "https://docs.cloud.google.com/release-notes"

filter dizesi 500 karakteri aşmamalıdır. 500 karakterden uzun değerler INVALID_ARGUMENT hatasına neden olur.

Yanıt metni

DeveloperKnowledge.AnswerQuery için yanıt mesajı.

Başarılı olursa yanıt metni aşağıdaki yapıyla birlikte verileri içerir:

JSON gösterimi 
{
  "answer": {
    object (Answer)
  }
}
Alanlar
answer

object (Answer)

Sorgunun yanıtı.

Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamlarından birini gerektirir:

  • https://www.googleapis.com/auth/devprofiles.full_control
  • https://www.googleapis.com/auth/developerprofiles.readonly
  • https://www.googleapis.com/auth/cloud-platform

Daha fazla bilgi için OAuth 2.0 Overview sayfasına bakın.

Cevap

Bir sorguya verilen yanıt.

JSON gösterimi 
{
  "answerText": string,
  "citations": [
    {
      object (AnswerCitation)
    }
  ],
  "references": [
    {
      object (AnswerReference)
    }
  ]
}
Alanlar
answerText

string

Yanıtın metnini içerir.
citations[]

object (AnswerCitation)

Yalnızca çıkış. Yanıtla ilgili alıntılar içerir.
references[]

object (AnswerReference)

Yalnızca çıkış. Yanıt için referanslar içerir.

AnswerCitation

Bir segmentle ilgili alıntı bilgileri.

JSON gösterimi 
{
  "startIndex": integer,
  "endIndex": integer,
  "sources": [
    {
      object (CitationSource)
    }
  ]
}
Alanlar
startIndex

integer

Yalnızca çıkış. Bayt (UTF-8 Unicode) cinsinden ölçülen ve dahil olan segmentin başlangıcını gösterir. ASCII olmayan karakterler gibi çok baytlı karakterler varsa dizin ölçümü, dize uzunluğundan daha uzundur.
endIndex

integer

Yalnızca çıkış. Bayt (UTF-8 Unicode) cinsinden ölçülen ve hariç tutulan segmentin sonunu gösterir. ASCII olmayan karakterler gibi çok baytlı karakterler varsa dizin ölçümü, dize uzunluğundan daha uzundur.
sources[]

object (CitationSource)

Yalnızca çıkış. Atfedilen segmentin alıntı kaynaklarını içerir.

CitationSource

Alıntı kaynağı.

JSON gösterimi 
{
  "referenceIndex": integer
}
Alanlar
referenceIndex

integer

Yalnızca çıkış. Answer.AnswerReference yinelenen alanındaki references öğesinin dizinini içerir.

AnswerReference

Bir kaynağa yapılan referansı gösterir.

JSON gösterimi 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "documentReference": {
    object (DocumentReference)
  }
  // End of mutually exclusive fields.
}
Alanlar
Referansın içeriğini barındırır. Aşağıda, aynı anda kullanılamayan alanların listesi verilmiştir. Yanıt içinde en fazla bir alan ayarlanır:
documentReference

object (DocumentReference)

Yalnızca çıkış. Referans doküman.
Karşılıklı olarak hariç tutulan alanların sonu.

DocumentReference

Bir belgeye yapılan referansı temsil eder.

JSON gösterimi 
{
  "documentChunk": {
    object (DocumentChunk)
  }
}
Alanlar
documentChunk

object (DocumentChunk)

Yalnızca çıkış. Belge parçasını içerir. documentChunk.id alanı ayarlanmamış ve boş olacaktır.