Method: projects.locations.apps.runAssistant

Exécute l'agent d'assistance pour la session d'assistance spécifiée.

Requête HTTP

POST https://ces.googleapis.com/v1beta/{app=projects/*/locations/*/apps/*}:runAssistant

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
app

string

Obligatoire. L'application pour laquelle exécuter l'assistant. Format : projects/{project}/locations/{location}/apps/{app}

Corps de la requête

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

Représentation JSON 
{
  "assistantSession": string,
  "message": {
    object (AssistantMessage)
  },
  "interactionType": enum (RunAssistantRequest.InteractionType)
}
Champs
assistantSession

string

Obligatoire. Session de l'assistant à utiliser pour exécuter l'assistant. Format : projects/{project}/locations/{location}/apps/{app}/assistantSessions/{assistantSession}
message

object (AssistantMessage)

Obligatoire. Message à envoyer à l'agent de l'assistant.
interactionType

enum (RunAssistantRequest.InteractionType)

Facultatif. Différents types d'interaction pour le message de l'assistant.

Corps de la réponse

Message de réponse pour AssistantService.RunAssistant.

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

Représentation JSON 
{
  "output": {
    object (AssistantOutput)
  },
  "state": enum (AssistantSessionState)
}
Champs
output

object (AssistantOutput)

Obligatoire. La sortie de l'agent assistant.
state

enum (AssistantSessionState)

Uniquement en sortie. État de la session de l'assistant.

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/ces

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

Autorisations IAM

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

  • ces.apps.update

Pour en savoir plus, consultez la documentation IAM.

RunAssistantRequest.InteractionType

Type d'interaction pour le message envoyé à l'assistant.

Enums
INTERACTION_TYPE_UNSPECIFIED Valeur par défaut. Cette valeur est utilisée si le type n'est pas spécifié.
NEW_MESSAGE Le message est une entrée utilisateur. L'entrée utilisateur est fournie dans la liste des fragments.
POLL Le message sert à interroger l'état de la session de l'assistant.
DISMISS Le message sert à ignorer la session de l'assistant en attente d'examen. La session de l'Assistant passe alors à l'état inactif.

AssistantOutput

La sortie de l'agent assistant.

Représentation JSON 
{
  "message": {
    object (AssistantMessage)
  },
  "userResponseSuggestions": {
    object (UserResponseSuggestions)
  }
}
Champs
message

object (AssistantMessage)

Obligatoire. Réponse de l'agent assistant.
userResponseSuggestions

object (UserResponseSuggestions)

Uniquement en sortie. Réponses suggérées de l'utilisateur par l'agent assistant.