Method: projects.locations.collections.engines.assistants.assist

Aide l'utilisateur à répondre à une requête.

Requête HTTP

POST https://discoveryengine.googleapis.com/v1alpha/{name=projects/*/locations/*/collections/*/engines/*/assistants/*}:assist

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
name

string

Obligatoire. Nom de ressource du Assistant. Format : projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}

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,
  "assistSkippingMode": enum (AssistSkippingMode),
  "fileIds": [
    string
  ],
  "userMetadata": {
    object (AssistUserMetadata)
  },
  "languageCode": string,
  "webGroundingEnabled": boolean,
  "dataStoreSpecs": [
    {
      object (DataStoreSpec)
    }
  ],
  "assistGenerationConfig": {
    object (AssistGenerationConfig)
  },
  "googleSearchGroundingEnabled": boolean
}
Champs
query

object (Query)

Facultatif. Requête de l'utilisateur actuel.

Les requêtes vides ne sont acceptées que si des fileIds sont fournis. Dans ce cas, la réponse sera générée en fonction de ces fichiers contextuels.
session

string

Facultatif. Session à utiliser pour la requête. Si cette option est spécifiée, l'assistant a accès à l'historique des sessions, et la requête et la réponse y sont stockées.

Si - est spécifié comme ID de session ou s'il est laissé vide, une nouvelle session est créée avec un ID généré automatiquement.

Format : projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}
assistSkippingMode

enum (AssistSkippingMode)

Facultatif. Détermine les cas dans lesquels l'assistant ne répondra pas à la requête. Si la réponse est ignorée, les raisons seront listées dans AssistAnswer.assist_skipped_reasons au sein de AssistResponse.answer.
fileIds[]

string

Facultatif. ID des fichiers à utiliser pour répondre à la demande. Lorsque vous importez un fichier, son ID est renvoyé dans AddContextFileResponse.file_id.
userMetadata

object (AssistUserMetadata)

Facultatif. Informations sur l'utilisateur qui lance la requête.
languageCode

string

Facultatif. Langue à utiliser pour répondre si la détection de la langue échoue. Également utilisé comme langue des messages d'erreur créés par les actions, quels que soient les résultats de la détection de la langue.
webGroundingEnabled

boolean

Facultatif. Si la valeur est "true", l'ancrage avec la recherche sur le Web est activé. Ne fonctionne que si Assistant.web_grounding_type est [WEB_GROUNDING_TYPE_GOOGLE_SEARCH][] ou [WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH][].
dataStoreSpecs[]

object (DataStoreSpec)

Facultatif. Spécifications définissant les DataStore sur lesquels filtrer un appel de recherche et les configurations de ces magasins de données. Cela n'est pris en compte que pour les Engine comportant plusieurs data stores.

Si vous ne définissez pas ce champ, tous les data stores du moteur seront utilisés, sauf si ignoreDataStores est défini sur "true".
assistGenerationConfig

object (AssistGenerationConfig)

Facultatif. Configuration de la génération au niveau de la requête. Permet de remplacer la configuration de génération par défaut au niveau du moteur.
googleSearchGroundingEnabled
(deprecated)

boolean

Facultatif. Obsolète. Utilisez plutôt webGroundingEnabled.

Corps de la réponse

Réponse pour la méthode AssistantService.Assist.

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 (AssistAnswer)
  },
  "sessionInfo": {
    object (SessionInfo)
  },
  "assistToken": string
}
Champs
answer

object (AssistAnswer)

Ressource AssistAnswer générée en réponse à la requête.
sessionInfo

object (SessionInfo)

Informations sur la session.
assistToken

string

ID unique global qui identifie la paire requête/réponse actuelle. Utilisé pour les commentaires et l'assistance.

Niveaux d'accès des autorisations

Nécessite l'un des champs d'application OAuth suivants :

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

Pour plus d'informations, consultez la Authentication Overview.

Autorisations IAM

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

  • discoveryengine.assistants.assist

Pour en savoir plus, consultez la documentation IAM.

AssistSkippingMode

Comportements de désactivation disponibles pour les demandes d'assistance.

Enums
ASSIST_SKIPPING_MODE_UNSPECIFIED Valeur par défaut. Vous pouvez ignorer la réponse si la requête ne demande pas d'aide.
REQUEST_ASSIST Demandez une réponse à l'Assistant. La réponse peut toujours être ignorée si la requête ne respecte pas les règles.

SessionInfo

Informations sur la session.

Représentation JSON 
{
  "session": string,
  "queryId": string
}
Champs
session

string

Nom de la session nouvellement générée ou poursuivie.

Format : projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}
queryId

string

ID de la requête correspondant à cet appel d'API Assist. Une session peut comporter plusieurs tours, chacun avec un ID de requête unique.

En spécifiant le nom de la session et cet ID de requête dans l'appel d'API assistants.assist, la demande d'assistance se produit dans le contexte des résultats de recherche de cet appel de recherche.