Method: answerQuery

Risponde a una query utilizzando la generazione basata sulle fonti.

Richiesta HTTP

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

L'URL utilizza la sintassi di transcodifica gRPC.

Corpo della richiesta

Il corpo della richiesta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "query": string,
  "filter": string
}
Campi
query

string

Obbligatorio. La query a cui rispondere.
filter

string

Facoltativo. Applica un filtro rigoroso ai risultati di ricerca utilizzati per basare la risposta. L'espressione supporta un sottoinsieme della sintassi descritta all'indirizzo https://google.aip.dev/160.

Campi supportati per il filtro:

  • content_length_bytes (INTEGER): la lunghezza del campo Document.content in byte.
  • data_source (STRING): l'origine del documento, ad es. docs.cloud.google.com. Consulta https://developers.google.com/knowledge/reference/corpus-reference per l'elenco completo delle origini dati nel corpus.
  • update_time (TIMESTAMP): il timestamp dell'ultimo aggiornamento significativo del documento. Un aggiornamento significativo è quello che modifica i contenuti o i metadati Markdown del documento.
  • uri (STRINGA): l'URI del documento, ad es. https://docs.cloud.google.com/bigquery/docs/tables.

I campi INTEGER supportano gli operatori =, <, <=, > e >=.

I campi STRING supportano gli operatori = (uguale a) e != (diverso da) per la corrispondenza esatta dell'intera stringa. La corrispondenza parziale, la corrispondenza del prefisso e la corrispondenza dell'espressione regolare non sono supportate.

I campi TIMESTAMP supportano gli operatori =, <, <=, > e >=. I timestamp devono essere nel formato RFC-3339, ad esempio "2025-01-01T00:00:00Z".

Puoi combinare le espressioni utilizzando gli operatori logici AND, OR e NOT (o -). OR ha una priorità più alta rispetto a AND. Utilizza le parentesi per il raggruppamento esplicito della precedenza.

Esempi:

  • Filtra per Document.content_length_bytes: content_length_bytes < 50000
  • 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"

La stringa filter non deve superare i 500 caratteri; i valori più lunghi di 500 caratteri genereranno un errore INVALID_ARGUMENT.

Corpo della risposta

Messaggio di risposta per DeveloperKnowledge.AnswerQuery.

In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "answer": {
    object (Answer)
  }
}
Campi
answer

object (Answer)

La risposta alla query.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

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

Per saperne di più, consulta la OAuth 2.0 Overview.

Risposta

Una risposta a una query.

Rappresentazione JSON 
{
  "answerText": string,
  "citations": [
    {
      object (AnswerCitation)
    }
  ],
  "references": [
    {
      object (AnswerReference)
    }
  ]
}
Campi
answerText

string

Contiene il testo della risposta.
citations[]

object (AnswerCitation)

Solo output. Contiene le citazioni della risposta.
references[]

object (AnswerReference)

Solo output. Contiene riferimenti per la risposta.

AnswerCitation

Informazioni sulla citazione per un segmento.

Rappresentazione JSON 
{
  "startIndex": integer,
  "endIndex": integer,
  "sources": [
    {
      object (CitationSource)
    }
  ]
}
Campi
startIndex

integer

Solo output. Indica l'inizio del segmento, misurato in byte (Unicode UTF-8), inclusi. Se sono presenti caratteri multibyte, ad esempio caratteri non ASCII, la misurazione dell'indice è più lunga della lunghezza della stringa.
endIndex

integer

Solo output. Indica la fine del segmento, misurata in byte (Unicode UTF-8), esclusa. Se sono presenti caratteri multibyte, ad esempio caratteri non ASCII, la misurazione dell'indice è più lunga della lunghezza della stringa.
sources[]

object (CitationSource)

Solo output. Contiene le fonti delle citazioni per il segmento attribuito.

CitationSource

Fonte della citazione.

Rappresentazione JSON 
{
  "referenceIndex": integer
}
Campi
referenceIndex

integer

Solo output. Contiene l'indice di Answer.AnswerReference nel campo ripetuto references.

AnswerReference

Rappresenta un riferimento a una fonte.

Rappresentazione JSON 
{

  // 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.
}
Campi
Contiene i contenuti del riferimento. Di seguito è riportato un elenco di campi che si escludono a vicenda. In una risposta verrà impostato al massimo uno dei campi:
documentReference

object (DocumentReference)

Solo output. Il documento di riferimento.
Fine dei campi che si escludono a vicenda.

DocumentReference

Rappresenta un riferimento a un documento.

Rappresentazione JSON 
{
  "documentChunk": {
    object (DocumentChunk)
  }
}
Campi
documentChunk

object (DocumentChunk)

Solo output. Contiene il blocco del documento. Il campo documentChunk.id non è impostato e sarà vuoto.