Method: answerQuery

Responde una búsqueda con generación fundamentada.

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación de gRPC.

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos con la siguiente estructura:

Representación JSON 
{
  "query": string
}
Campos
query

string

Obligatorio. Es la búsqueda para responder.

Cuerpo de la respuesta

Mensaje de respuesta para DeveloperKnowledge.AnswerQuery.

Si se ejecuta correctamente, el cuerpo de la respuesta contiene datos con la siguiente estructura:

Representación JSON 
{
  "answer": {
    object (Answer)
  }
}
Campos
answer

object (Answer)

Es la respuesta a la búsqueda.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta OAuth 2.0 Overview.

Respuesta

Es la respuesta a una búsqueda.

Representación JSON 
{
  "answerText": string,
  "citations": [
    {
      object (AnswerCitation)
    }
  ],
  "references": [
    {
      object (AnswerReference)
    }
  ]
}
Campos
answerText

string

Contiene el texto de la respuesta.
citations[]

object (AnswerCitation)

Solo salida. Contiene citas para la respuesta.
references[]

object (AnswerReference)

Solo salida. Contiene referencias para la respuesta.

AnswerCitation

Es la información de la cita de un segmento.

Representación JSON 
{
  "startIndex": integer,
  "endIndex": integer,
  "sources": [
    {
      object (CitationSource)
    }
  ]
}
Campos
startIndex

integer

Solo salida. Indica el inicio del segmento, medido en bytes (Unicode UTF-8), inclusive. Si hay caracteres multibyte, como caracteres no ASCII, la medición del índice es más larga que la longitud de la cadena.
endIndex

integer

Solo salida. Indica el final del segmento, medido en bytes (Unicode UTF-8), exclusivo. Si hay caracteres multibyte, como caracteres no ASCII, la medición del índice es más larga que la longitud de la cadena.
sources[]

object (CitationSource)

Solo salida. Contiene las fuentes de citas del segmento atribuido.

CitationSource

Es la fuente de la cita.

Representación JSON 
{
  "referenceIndex": integer
}
Campos
referenceIndex

integer

Solo salida. Contiene el índice de Answer.AnswerReference en el campo repetido references.

AnswerReference

Representa una referencia a una fuente.

Representación 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ón content. Contiene el contenido de la referencia. content puede ser solo uno de los parámetros siguientes:
documentReference

object (DocumentReference)

Solo salida. Es el documento de referencia.

DocumentReference

Representa una referencia a un documento.

Representación JSON 
{
  "documentChunk": {
    object (DocumentChunk)
  }
}
Campos
documentChunk

object (DocumentChunk)

Solo salida. Contiene el fragmento del documento. El campo documentChunk.id no está configurado y estará vacío.