Method: projects.locations.collections.dataConnector.executeAction

Führt eine Drittanbieteraktion mit dem DataConnector aus

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
name

string

Erforderlich. Ressource DataConnector.

Der Datenconnector, der zum Ausführen der Aktion verwendet wird

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung 
{
  "actionName": string,
  "args": {
    object
  },
  "languageCode": string,
  "assistAnswerInfo": {
    object (AssistAnswerInfo)
  }
}
Felder
actionName

string

Erforderlich. Name der Aktion.

Beispiel: „send_email“
args

object (Struct format)

Erforderlich. Benannte Argumente der Aktion.

Beispiel: {"recipient": "tom@...", "subject": ... }

Wenn dieser Teil einem Nutzer angeboten wird, ist er möglicherweise bearbeitbar.
languageCode

string

Optional. Sprache, die für Status- und Fehlermeldungen verwendet werden soll, die von Aktionen erstellt werden.
assistAnswerInfo

object (AssistAnswerInfo)

Optional. Falls angegeben, wird das Ergebnis der Aktionsausführung mit der angegebenen Antwort des Assistenten verknüpft. So kann der Assistent das Ergebnis in nachfolgenden Antworten in derselben Sitzung berücksichtigen.

Die referenzierte Ressource der Antwort des Assistenten muss vorhanden sein.

Antworttext

Antwort für die Methode DataConnectorService.ExecuteAction.

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

JSON-Darstellung 
{
  "status": {
    object (Status)
  },
  "textResult": string,
  "result": {
    object
  }
}
Felder
status

object (Status)

Status der Aktionsausführung
textResult

string

Menschenlesbares Ergebnis der Aktionsausführung im Erfolgsfall
result

object (Struct format)

Detailliertes Ergebnis der Aktionsausführung im Erfolgsfall

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

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

Weitere Informationen finden Sie unter Authentication Overview.

IAM-Berechtigungen

Erfordert die folgende IAM-Berechtigung für die Ressource name:

  • discoveryengine.dataConnectors.executeAction

Weitere Informationen finden Sie in der IAM-Dokumentation.

AssistAnswerInfo

Nachricht, die einen Aktionsaufruf in der Antwort des Assistenten identifiziert

JSON-Darstellung 
{
  "assistAnswer": string,
  "invocationId": string
}
Felder
assistAnswer

string

Erforderlich. Name der Antwort des Assistenten.

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

string

Erforderlich. Die ID des Aktionsaufrufs