Method: projects.locations.collections.dataConnector.executeAction

Exécute une action tierce à l'aide de DataConnector.

Requête HTTP

POST https://discoveryengine.googleapis.com/v1alpha/{name=projects/*/locations/*/collections/*/dataConnector}:executeAction

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
name

string

Obligatoire. Ressource DataConnector.

Connecteur de données utilisé pour exécuter l'action.

Corps de la requête

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

Représentation JSON 
{
  "actionName": string,
  "args": {
    object
  },
  "languageCode": string,
  "assistAnswerInfo": {
    object (AssistAnswerInfo)
  }
}
Champs
actionName

string

Obligatoire. Nom de l'action.

Par exemple : "send_email"
args

object (Struct format)

Obligatoire. Arguments nommés de l'action.

Par exemple : {"recipient": "tom@...", "subject": ... }

Lorsqu'elle est proposée à un utilisateur, cette partie peut être modifiable.
languageCode

string

Facultatif. Langue à utiliser pour les messages d'état et d'erreur créés par les actions.
assistAnswerInfo

object (AssistAnswerInfo)

Facultatif. Si cette propriété est spécifiée, le résultat de l'exécution de l'action sera associé à la réponse d'assistance donnée. Cela permet à l'assistant de tenir compte du résultat dans les réponses suivantes de la même session.

La ressource de réponse d'assistance référencée doit exister.

Corps de la réponse

Réponse pour la méthode DataConnectorService.ExecuteAction.

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

Représentation JSON 
{
  "status": {
    object (Status)
  },
  "textResult": string,
  "result": {
    object
  }
}
Champs
status

object (Status)

l'état d'exécution de l'action.
textResult

string

Résultat lisible de l'exécution de l'action en cas de succès.
result

object (Struct format)

Résultat détaillé de l'exécution de l'action en cas de réussite.

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.dataConnectors.executeAction

Pour en savoir plus, consultez la documentation IAM.

AssistAnswerInfo

Message qui identifie un appel d'action dans la réponse de l'assistance.

Représentation JSON 
{
  "assistAnswer": string,
  "invocationId": string
}
Champs
assistAnswer

string

Obligatoire. Nom de la réponse de l'assistance.

Format : projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assistAnswer}
invocationId

string

Obligatoire. ID d'invocation de l'action.