Method: answerQuery

Risponde a una query utilizzando la generazione basata su dati di riferimento.

Richiesta HTTP

POST https://developerknowledge.googleapis.com/v1alpha: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 su dati di riferimento. L'espressione supporta un sottoinsieme della sintassi descritta all'indirizzo https://google.aip.dev/160.

Campi supportati per il filtro:

  • contentLengthBytes (INTEGER): la lunghezza del campo Document.content in byte.
  • dataSource (STRING): l'origine del documento, ad es. docs.cloud.google.com. Per l'elenco completo delle origini dati nel corpus, consulta https://developers.google.com/knowledge/reference/corpus-reference.
  • updateTime (TIMESTAMP): il timestamp dell'ultimo aggiornamento significativo del documento. Un aggiornamento significativo è quello che modifica i contenuti Markdown o i metadati del documento.
  • uri (STRING): 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) e != (diverso) per la corrispondenza esatta dell'intera stringa. La corrispondenza parziale, la corrispondenza del prefisso e la corrispondenza con espressioni regolari non sono supportate.

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

Puoi combinare le espressioni utilizzando gli operatori logici AND, OR e NOT (o -). OR ha una precedenza maggiore rispetto a AND. Utilizza le parentesi per raggruppare la precedenza in modo esplicito.

Esempi:

  • Filtra per Document.content_length_bytes: contentLengthBytes < 50000
  • dataSource = "docs.cloud.google.com" OR dataSource = "firebase.google.com"
  • dataSource != "firebase.google.com"
  • updateTime < "2024-01-01T00:00:00Z"
  • updateTime >= "2025-01-22T00:00:00Z" AND (dataSource = "developer.chrome.com" OR dataSource = "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 per la risposta.
references[]

object (AnswerReference)

Solo output. Contiene i 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), inclusivo. 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, misurato in byte (Unicode UTF-8), esclusivo. 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 origini delle citazioni per il segmento attribuito.

CitationSource

Origine 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 un'origine.

Rappresentazione JSON 
{

  // Union field content can be only one of the following:
  "documentReference": {
    object (DocumentReference)
  }
  // End of list of possible types for union field content.
}
Campi
Campo unione content. Contiene i contenuti del riferimento. content può essere solo uno dei seguenti tipi:
documentReference

object (DocumentReference)

Solo output. Il documento di riferimento.

DocumentReference

Rappresenta un riferimento a un documento.

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

object (DocumentChunk)

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