Method: projects.locations.dataStores.servingConfigs.answer

Méthode Answer query.

Requête HTTP

POST https://discoveryengine.googleapis.com/v1beta/{servingConfig=projects/*/locations/*/dataStores/*/servingConfigs/*}:answer

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
servingConfig

string

Obligatoire. Nom de ressource de la configuration de diffusion servingConfigs.search, par exemple projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config ou projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config.

Ou nom de ressource de la configuration de diffusion du moteur d'agent, par exemple : projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_agent_answer. (à utiliser lorsque enableAgentInvocation est défini sur "true" et que vous avez configuré un moteur d'agent AI_MODE personnalisé)

Ce champ permet d'identifier le nom de la configuration de diffusion, l'ensemble de modèles utilisés pour effectuer la recherche.

Corps de la requête

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

Représentation JSON 
{
  "query": {
    object (Query)
  },
  "session": string,
  "safetySpec": {
    object (SafetySpec)
  },
  "relatedQuestionsSpec": {
    object (RelatedQuestionsSpec)
  },
  "groundingSpec": {
    object (GroundingSpec)
  },
  "answerGenerationSpec": {
    object (AnswerGenerationSpec)
  },
  "searchSpec": {
    object (SearchSpec)
  },
  "queryUnderstandingSpec": {
    object (QueryUnderstandingSpec)
  },
  "asynchronousMode": boolean,
  "userPseudoId": string,
  "userLabels": {
    string: string,
    ...
  },
  "endUserSpec": {
    object (EndUserSpec)
  }
}
Champs
query

object (Query)

Obligatoire. Requête de l'utilisateur actuel.
session

string

Nom de ressource de la session. Facultatif.

Lorsque le champ de session n'est pas défini, l'API est en mode sans session.

Nous acceptons le mode de session automatique : les utilisateurs peuvent utiliser le caractère générique - comme ID de session. Un nouvel ID est généré et attribué automatiquement.
safetySpec

object (SafetySpec)

Spécification du modèle.
relatedQuestionsSpec

object (RelatedQuestionsSpec)

Spécification des questions associées.
groundingSpec

object (GroundingSpec)

Facultatif. Spécification de l'ancrage.
answerGenerationSpec

object (AnswerGenerationSpec)

Spécification de la génération de réponses.
searchSpec

object (SearchSpec)

Spécification servingConfigs.search.
queryUnderstandingSpec

object (QueryUnderstandingSpec)

Spécification de la compréhension des requêtes.
asynchronousMode
(deprecated)

boolean

Obsolète : ce champ est obsolète. L'API de diffusion de réponses sera compatible.

Contrôle du mode asynchrone.

Si cette option est activée, la réponse est renvoyée avec le nom de ressource de la réponse/session sans la réponse finale. Les utilisateurs de l'API doivent effectuer un polling pour obtenir le dernier état de la réponse/session en appelant la méthode ConversationalSearchService.GetAnswer ou ConversationalSearchService.GetSession.
userPseudoId

string

Identifiant unique permettant de suivre les visiteurs. Par exemple, cela peut être implémenté avec un cookie HTTP, qui doit pouvoir identifier de manière unique un visiteur sur un seul appareil. Cet identifiant unique ne doit pas changer si le visiteur se connecte ou se déconnecte du site Web.

Ce champ NE DOIT PAS avoir de valeur fixe telle que unknown_visitor.

Le champ doit être une chaîne encodée au format UTF-8 d'une longueur maximale de 128 caractères. Sinon, une erreur INVALID_ARGUMENT est renvoyée.
userLabels

map (key: string, value: string)

Les libellés utilisateur appliqués à une ressource doivent répondre aux exigences suivantes :

  • Chaque ressource peut posséder plusieurs libellés, jusqu'à un maximum de 64.
  • Chaque libellé doit correspondre à une paire clé/valeur.
  • Les clés doivent comporter au moins 1 caractère et au maximum 63 caractères, et ne peuvent pas être vides. Les valeurs peuvent être vides et comporter au maximum 63 caractères.
  • Les clés et les valeurs ne peuvent contenir que des lettres minuscules, des caractères numériques, des traits de soulignement et des tirets. Tous les caractères doivent être au format d'encodage UTF-8. Les caractères internationaux sont autorisés.
  • La partie clé d'un libellé doit être unique. Toutefois, vous pouvez utiliser la même clé avec plusieurs ressources.
  • Les clés doivent commencer par une lettre minuscule ou un caractère international.

Pour en savoir plus, consultez le document Google Cloud.
endUserSpec

object (EndUserSpec)

Facultatif. Spécification de l'utilisateur final.

Corps de la réponse

Si la requête aboutit, le corps de la réponse contient une instance de AnswerQueryResponse.

Niveaux d'accès des autorisations

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

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite
  • https://www.googleapis.com/auth/discoveryengine.serving.readwrite

Pour plus d'informations, consultez la page Authentication Overview.

Autorisations IAM

Nécessite l'autorisation IAM suivante sur la ressource servingConfig :

  • discoveryengine.servingConfigs.answer

Pour en savoir plus, consultez la documentation IAM.