Method: answerQuery

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

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
}
Campos
query

string

Obrigatório. A consulta a ser respondida.

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/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 de vários bytes, como caracteres não ASCII, a medição do índice será maior que o comprimento da string.
endIndex

integer

Apenas saída. Indica o fim do segmento, medido em bytes (Unicode UTF-8), exclusivo. Se houver caracteres de vários bytes, 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 da citação.

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

integer

Apenas saída. Contém o índice do 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 de um dos tipos a seguir:
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 trecho do documento. O campo documentChunk.id não está definido e vai ficar vazio.