Method: answerQuery

Répond à une requête à l'aide de la génération ancrée.

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Corps de la requête

Le corps de la requête contient des données présentant la structure suivante :

Représentation JSON
{
  "query": string
}
Champs
query

string

Obligatoire. Requête à laquelle répondre.

Corps de la réponse

Message de réponse pour DeveloperKnowledge.AnswerQuery.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation JSON
{
  "answer": {
    object (Answer)
  }
}
Champs
answer

object (Answer)

Réponse à la requête.

Niveaux d'accès des autorisations

Nécessite l'un des niveaux d'accès OAuth suivants :

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

Pour plus d'informations, consultez la OAuth 2.0 Overview.

Réponse

Réponse à une requête.

Représentation JSON
{
  "answerText": string,
  "citations": [
    {
      object (AnswerCitation)
    }
  ],
  "references": [
    {
      object (AnswerReference)
    }
  ]
}
Champs
answerText

string

Contient le texte de la réponse.

citations[]

object (AnswerCitation)

Uniquement en sortie. Contient des citations pour la réponse.

references[]

object (AnswerReference)

Uniquement en sortie. Contient des références pour la réponse.

AnswerCitation

Informations de citation pour un segment.

Représentation JSON
{
  "startIndex": integer,
  "endIndex": integer,
  "sources": [
    {
      object (CitationSource)
    }
  ]
}
Champs
startIndex

integer

Uniquement en sortie. Indique le début du segment, mesuré en octets (Unicode UTF-8), inclus. S'il existe des caractères multioctets, tels que des caractères non ASCII, la mesure de l'index est plus longue que la longueur de la chaîne.

endIndex

integer

Uniquement en sortie. Indique la fin du segment, mesurée en octets (Unicode UTF-8), exclus. S'il existe des caractères multioctets, tels que des caractères non ASCII, la mesure de l'index est plus longue que la longueur de la chaîne.

sources[]

object (CitationSource)

Uniquement en sortie. Contient les sources de citation pour le segment attribué.

CitationSource

Source de citation.

Représentation JSON
{
  "referenceIndex": integer
}
Champs
referenceIndex

integer

Uniquement en sortie. Contient l'index de Answer.AnswerReference dans le champ répété references.

AnswerReference

Représente une référence à une source.

Représentation JSON
{

  // Union field content can be only one of the following:
  "documentReference": {
    object (DocumentReference)
  }
  // End of list of possible types for union field content.
}
Champs
Champ d'union content. Contient le contenu de la référence. content ne peut être qu'un des éléments suivants :
documentReference

object (DocumentReference)

Uniquement en sortie. Document de référence.

DocumentReference

Représente une référence à un document.

Représentation JSON
{
  "documentChunk": {
    object (DocumentChunk)
  }
}
Champs
documentChunk

object (DocumentChunk)

Uniquement en sortie. Contient le bloc de document. Le champ documentChunk.id n'est pas défini et sera vide.