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,
  "filter": string
}
Champs
query

string

Obligatoire. Requête à laquelle répondre.
filter

string

Facultatif. Applique un filtre strict aux résultats de recherche utilisés pour ancrer la réponse. L'expression est compatible avec un sous-ensemble de la syntaxe décrite sur https://google.aip.dev/160.

Champs compatibles avec le filtrage :

  • contentLengthBytes (INTEGER) : longueur du champ Document.content en octets.
  • dataSource (STRING) : source du document, par exemple docs.cloud.google.com. Pour obtenir la liste complète des sources de données du corpus, consultez https://developers.google.com/knowledge/reference/corpus-reference.
  • updateTime (TIMESTAMP) : code temporel de la dernière mise à jour significative du document. Une mise à jour significative est une mise à jour qui modifie le contenu Markdown ou les métadonnées du document.
  • uri (STRING) : URI du document, par exemple https://docs.cloud.google.com/bigquery/docs/tables.

Les champs INTEGER sont compatibles avec les opérateurs =, <, <=, >, et >=.

Les champs STRING sont compatibles avec les opérateurs = (égal à) et != (différent de) pour une correspondance exacte sur l'ensemble de la chaîne. La correspondance partielle, la correspondance de préfixe et la correspondance d'expression régulière ne sont pas compatibles.

Les champs TIMESTAMP sont compatibles avec les opérateurs =, <, <=, >, et >=. Les codes temporels doivent être au format RFC 3339, par exemple "2025-01-01T00:00:00Z".

Vous pouvez combiner des expressions à l'aide des opérateurs logiques AND, OR et NOT (ou -). OR est prioritaire par rapport à AND. Utilisez des parenthèses pour regrouper explicitement les priorités.

Exemples :

  • Filtrer par 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 chaîne filter ne doit pas dépasser 500 caractères. Si elle est plus longue, une erreur INVALID_ARGUMENT est générée.

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/developerprofiles.readonly
  • 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 les citations de la réponse.
references[]

object (AnswerReference)

Uniquement en sortie. Contient les références de la réponse.

AnswerCitation

Informations sur la citation d'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 du segment attribué.

CitationSource

Source de la 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.