Method: projects.locations.collections.dataConnector.buildActionInvocation

Crea una chiamata di azione utilizzando DataConnector.

Richiesta HTTP

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

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
name

string

Obbligatorio. DataConnector risorsa.

Il connettore dati utilizzato per creare la chiamata all'azione.

Corpo della richiesta

Il corpo della richiesta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "actionName": string,
  "languageCode": string
}
Campi
actionName

string

Obbligatorio. Il nome dell'azione.

Ad esempio: "send_email"
languageCode

string

Facoltativo. Lingua da utilizzare per i messaggi di stato e di errore.

Corpo della risposta

Risposta per il metodo DataConnectorService.BuildActionInvocation.

In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "actionInvocation": {
    object (ActionInvocation)
  }
}
Campi
actionInvocation

object (ActionInvocation)

L'invocazione dell'azione.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

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

Per ulteriori informazioni, consulta Authentication Overview.

Autorizzazioni IAM

Richiede la seguente autorizzazione IAM per la risorsa name:

  • discoveryengine.dataConnectors.buildActionInvocation

Per saperne di più, consulta la documentazione di IAM.

ActionInvocation

Rappresenta una chiamata di azione.

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

string

(Facoltativo) Il nome dell'agente che esegue l'azione.
actionName

string

Nome dell'azione.

Ad esempio: "send_email"
args

object (Struct format)

Argomenti denominati dell'azione.

Ad esempio: {"recipient": "tom@...", "subject": ... }

Quando viene offerta a un utente, questa parte potrebbe essere modificabile.

Se sono presenti più opzioni per gli argomenti dell'azione (ad es. più fasce orarie possibili per un evento del calendario), questo campo descrive la prima opzione.
dataConnector

string

DataConnector risorsa.

Il connettore di dati utilizzato per eseguire l'azione.
dataSource

string

Solo output. Il nome dell'origine dati.
invocationId

string

Solo output. L'ID chiamata dell'azione.
actionDisplayName

string

Solo output. Nome dell'azione leggibile dall'utente.
userConfirmationMessage

string

Solo output. Messaggio leggibile mostrato all'utente insieme alla finestra di dialogo di conferma.
authorizationUrl

string

Solo output. URL di autorizzazione.
resendQueryOnUserAuthorization

boolean

Solo output. Se è true, il chiamante deve inviare nuovamente la query dopo l'autorizzazione dell'utente.
parameterDeclaration

object (Struct format)

Solo output. Descrizione dei parametri dell'azione, incluse le informazioni di rendering/convalida. Il suo formato si basa sulla specifica dei parametri di OpenAPI. In base a: https://swagger.io/docs/specification/describing-parameters/

Esempio:

{
    "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)

Solo output. Se esistono più opzioni per gli argomenti dell'azione (ad es. più fasce orarie possibili per un evento del calendario), questi candidati aggiuntivi per gli argomenti sono elencati in questo campo.

Contiene un elenco di set di argomenti, ognuno dei quali è formattato in modo simile al campo args. I set di argomenti contengono solo gli argomenti diversi dal campo args. Quando vengono offerti a un utente, questi valori potrebbero essere modificabili.

Ad esempio:

args contiene la prima opzione con tutti gli argomenti:

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

argSetCandidates contiene il resto delle opzioni, ma vengono compilati solo gli argomenti diversi:

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