Method: answerQuery

Responde a uma consulta usando a geração fundamentada.

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Representação JSON 
{
  "query": string,
  "filter": string
}
Campos
query

string

Obrigatório. A consulta a ser respondida.
filter

string

Opcional. Aplica um filtro estrito aos resultados da pesquisa usados para fundamentar a resposta. A expressão oferece suporte a um subconjunto da sintaxe descrita em https://google.aip.dev/160.

Campos compatíveis com a filtragem:

  • contentLengthBytes (INTEGER): o comprimento do campo Document.content em bytes.
  • dataSource (STRING): a origem do documento, por exemplo, docs.cloud.google.com. Consulte https://developers.google.com/knowledge/reference/corpus-reference para conferir a lista completa de fontes de dados no corpus.
  • updateTime (TIMESTAMP): o carimbo de data/hora da última atualização significativa do documento. Uma atualização significativa é aquela que muda o conteúdo ou os metadados do documento em Markdown.
  • uri (STRING): o URI do documento, por exemplo, https://docs.cloud.google.com/bigquery/docs/tables.

Os campos INTEGER oferecem suporte aos operadores =, <, <=, >, e >=.

Os campos STRING oferecem suporte aos operadores = (igual) e != (diferente) para correspondência exata em toda a string. A correspondência parcial, de prefixo e de expressão regular não são aceitas.

Os campos TIMESTAMP oferecem suporte aos operadores =, <, <=, >, e >=. Os carimbos de data/hora precisam estar no formato RFC-3339, por exemplo, "2025-01-01T00:00:00Z".

É possível combinar expressões usando os operadores lógicos AND, OR e NOT (ou -). OR tem precedência maior que AND. Use parênteses para agrupar a precedência explícita.

Exemplos:

  • Filtrar por 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"

A string filter não pode exceder 500 caracteres. Valores maiores que 500 caracteres vão gerar um erro INVALID_ARGUMENT.

Corpo da resposta

Mensagem de resposta para DeveloperKnowledge.AnswerQuery.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON 
{
  "answer": {
    object (Answer)
  }
}
Campos
answer

object (Answer)

A resposta à consulta.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte OAuth 2.0 Overview.

Resposta

Uma resposta a uma consulta.

Representação JSON 
{
  "answerText": string,
  "citations": [
    {
      object (AnswerCitation)
    }
  ],
  "references": [
    {
      object (AnswerReference)
    }
  ]
}
Campos
answerText

string

Contém o texto da resposta.
citations[]

object (AnswerCitation)

Apenas saída. Contém citações para a resposta.
references[]

object (AnswerReference)

Apenas saída. Contém referências para a resposta.

AnswerCitation

Informações de citação para um segmento.

Representação JSON 
{
  "startIndex": integer,
  "endIndex": integer,
  "sources": [
    {
      object (CitationSource)
    }
  ]
}
Campos
startIndex

integer

Apenas saída. Indica o início do segmento, medido em bytes (Unicode UTF-8), inclusive. Se houver caracteres multibyte, como caracteres não ASCII, a medição do índice será maior que o comprimento da string.
endIndex

integer

Apenas saída. Indica o final do segmento, medido em bytes (Unicode UTF-8), exclusivo. Se houver caracteres multibyte, como caracteres não ASCII, a medição do índice será maior que o comprimento da string.
sources[]

object (CitationSource)

Apenas saída. Contém fontes de citação para o segmento atribuído.

CitationSource

Fonte de citação.

Representação JSON 
{
  "referenceIndex": integer
}
Campos
referenceIndex

integer

Apenas saída. Contém o índice de Answer.AnswerReference no campo repetido references.

AnswerReference

Representa uma referência a uma fonte.

Representação JSON 
{

  // Union field content can be only one of the following:
  "documentReference": {
    object (DocumentReference)
  }
  // End of list of possible types for union field content.
}
Campos
Campo de união content. Contém o conteúdo da referência. content pode ser apenas um dos seguintes:
documentReference

object (DocumentReference)

Apenas saída. O documento de referência.

DocumentReference

Representa uma referência a um documento.

Representação JSON 
{
  "documentChunk": {
    object (DocumentChunk)
  }
}
Campos
documentChunk

object (DocumentChunk)

Apenas saída. Contém o bloco de documentos. O campo documentChunk.id não está definido e ficará vazio.