Method: projects.locations.collections.engines.conversations.converse

Converse une conversation.

Requête HTTP

POST https://discoveryengine.googleapis.com/v1/{name=projects/*/locations/*/collections/*/engines/*/conversations/*}:converse

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
name

string

Obligatoire. Nom de ressource de la conversation à récupérer. Format: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStoreId}/conversations/{conversationId}. Utilisez projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStoreId}/conversations/- pour activer le mode de session automatique, qui crée automatiquement une conversation dans une session conversations.converse.

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 (TextInput)
  },
  "servingConfig": string,
  "conversation": {
    object (Conversation)
  },
  "safeSearch": boolean,
  "userLabels": {
    string: string,
    ...
  },
  "summarySpec": {
    object (SummarySpec)
  },
  "filter": string,
  "boostSpec": {
    object (BoostSpec)
  }
}
Champs
query

object (TextInput)

Obligatoire. Entrée utilisateur actuelle.
servingConfig

string

Nom de ressource de la configuration de diffusion à utiliser. Format : projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStoreId}/servingConfigs/{servingConfigId}. Si cette valeur n'est pas définie, la configuration de diffusion par défaut est utilisée.
conversation

object (Conversation)

Conversation à utiliser uniquement par la session automatique. Le champ "name" est ignoré, car nous attribuons automatiquement un nouveau nom à la conversation dans la session automatique.
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 chiffres, 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.
summarySpec

object (SummarySpec)

Spécification permettant de configurer le résumé renvoyé dans la réponse.
filter

string

La syntaxe des filtres consiste en un langage d'expression permettant de construire un prédicat à partir d'un ou de plusieurs champs des documents filtrés. Les expressions de filtre sont sensibles à la casse. Elles permettent de filtrer les résultats de recherche, ce qui peut avoir une incidence sur la réponse récapitulative.

Si ce champ n'est pas reconnu, une erreur INVALID_ARGUMENT est renvoyée.

Le filtrage dans Vertex AI Search s'effectue en mappant la clé de filtre LHS à une propriété de clé définie dans le backend de Vertex AI Search. Ce mappage est défini par le client dans son schéma. Par exemple, un client multimédia peut avoir un champ "name" dans son schéma. Dans ce cas, le filtre se présente comme suit : filter --> name:'ANY("king kong")'

Pour en savoir plus sur le filtrage, y compris sur la syntaxe et les opérateurs de filtre, consultez la section Filtre.
boostSpec

object (BoostSpec)

Spécification de boost permettant de mettre en avant certains documents dans les résultats de recherche, ce qui peut avoir une incidence sur la réponse de conversation. Pour en savoir plus sur le boost, consultez la section Boost.

Corps de la réponse

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

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 name :

  • discoveryengine.conversations.converse

Pour en savoir plus, consultez la documentation IAM.