Method: projects.locations.collections.dataConnector.buildActionInvocation

Erstellt einen Aktionsaufruf mit dem DataConnector.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
name

string

Erforderlich. DataConnector-Ressource.

Der Datenconnector, der zum Erstellen des Aktionsaufrufs verwendet wurde.

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung 
{
  "actionName": string,
  "languageCode": string
}
Felder
actionName

string

Erforderlich. Name der Aktion.

Beispiel: „send_email“
languageCode

string

Optional. Sprache, die für Status- und Fehlermeldungen verwendet werden soll.

Antworttext

Antwort für die Methode DataConnectorService.BuildActionInvocation.

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

JSON-Darstellung 
{
  "actionInvocation": {
    object (ActionInvocation)
  }
}
Felder
actionInvocation

object (ActionInvocation)

Der Aufruf der Aktion.

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.buildActionInvocation

Weitere Informationen finden Sie in der IAM-Dokumentation.

ActionInvocation

Stellt einen Aktionsaufruf dar.

JSON-Darstellung 
{
  "agentName": string,
  "actionName": string,
  "args": {
    object
  },
  "dataConnector": string,
  "dataSource": string,
  "invocationId": string,
  "actionDisplayName": string,
  "userConfirmationMessage": string,
  "authorizationUrl": string,
  "resendQueryOnUserAuthorization": boolean,
  "parameterDeclaration": {
    object
  },
  "argSetCandidates": [
    {
      object
    }
  ]
}
Felder
agentName

string

Optional. Name des Agents, der die Aktion ausführt.
actionName

string

Name der Aktion.

Beispiel: „send_email“
args

object (Struct format)

Benannte Argumente der Aktion.

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

Wenn dieser Teil einem Nutzer angeboten wird, kann er möglicherweise bearbeitet werden.

Wenn es mehrere Optionen für die Aktionsargumente gibt (z.B. mehrere mögliche Zeitfenster für einen Kalendertermin), wird in diesem Feld die erste Option beschrieben.
dataConnector

string

DataConnector-Ressource.

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

string

Nur Ausgabe. Der Name der Datenquelle.
invocationId

string

Nur Ausgabe. Die ID des Aktionsaufrufs.
actionDisplayName

string

Nur Ausgabe. Für Menschen lesbarer Name der Aktion, die dem Nutzer angezeigt wird.
userConfirmationMessage

string

Nur Ausgabe. Für Menschen lesbare Nachricht, die dem Nutzer zusammen mit dem Bestätigungsdialogfeld angezeigt wird.
authorizationUrl

string

Nur Ausgabe. Autorisierungs-URL.
resendQueryOnUserAuthorization

boolean

Nur Ausgabe. Wenn „true“, muss der Anrufer die Anfrage nach der Nutzerautorisierung noch einmal senden.
parameterDeclaration

object (Struct format)

Gib nur die Beschreibung der Parameter der Aktion aus, einschließlich Rendering-/Validierungsinformationen. Das Format basiert auf der Parameterspezifikation von OpenAPI. Basierend auf: https://swagger.io/docs/specification/describing-parameters/

Beispiel:

{
    "type": "object",
    "properties": {
        "title": {
            "type": "string",
            "description": "title of the event",
        },
        "startTime": {
            "type": "string",
            "format": "date-time",
            "description": (
                "Start time of the meeting, e.g. 2024-07-12T23:30"
            ),
        },
        "attendees": {
            "type": "array",
            "items": {"type": "string", "format": "email"},
            "description": "List of email addresses of attendees",
        },
        "duration": {
            "type": "integer",
            "format": "int32",
            "minimum": 5,
            "maximum": 240,
            "default": { "numberValue": 30 },
            "description": (
                "Duration of the meeting in minutes. Defaults to 30"
                " minutes."
            ),
        },
        "timezone": {
            "type": "string",
            "description": (
                'IANA time Zone Database name, e.g. "Europe/Zurich". If'
                " omitted, timezone of the user will be used"
            ),
        },
        "eventType": {
            "type": "string",
            "enum": ["meeting", "focus_time", "out_of_office", "task"],
            "description": "type of the event",
        },
    },
    "required": ["startTime", "title", "attendees"]
}
argSetCandidates[]

object (Struct format)

Nur Ausgabe. Wenn es mehrere Optionen für die Aktionsargumente gibt (z.B. mehrere mögliche Zeitfenster für einen Kalendertermin), werden diese zusätzlichen Argumentkandidaten in diesem Feld aufgeführt.

Enthält eine Liste von Argumentgruppen, die jeweils ähnlich wie das Feld „args“ formatiert sind. Die Argumentgruppen enthalten nur die Argumente, die sich vom Feld „args“ unterscheiden. Wenn diese Werte einem Nutzer angeboten werden, sind sie möglicherweise bearbeitbar.

Beispiel:

args enthält die erste Option mit allen Argumenten:

{"title": "Meeting with John", "startTime": "2024-08-01T13:30", ... }

argSetCandidates enthält die restlichen Optionen, aber nur die unterschiedlichen Argumente werden ausgefüllt:

[{ "startTime": "2024-08-01T14:00" }, { "startTime": "2024-08-01T14:30" }, { "startTime": "2024-08-01T15:30" }]