Method: projects.locations.collections.dataConnector.executeAction

Esegue un'azione di terze parti utilizzando DataConnector.

Richiesta HTTP

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

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
name

string

Obbligatorio. Risorsa DataConnector.

Il connettore dati utilizzato per l'esecuzione dell'azione.

Corpo della richiesta

Il corpo della richiesta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "actionName": string,
  "args": {
    object
  },
  "languageCode": string,
  "assistAnswerInfo": {
    object (AssistAnswerInfo)
  }
}
Campi
actionName

string

Obbligatorio. Nome dell'azione.

Ad esempio: "send_email"
args

object (Struct format)

Obbligatorio. Argomenti denominati dell'azione.

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

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

string

Facoltativo. Lingua da utilizzare per i messaggi di stato e di errore creati dalle azioni.
assistAnswerInfo

object (AssistAnswerInfo)

Facoltativo. Se specificato, il risultato dell'esecuzione dell'azione verrà associato alla risposta di assistenza fornita. In questo modo, l'assistente può tenere conto del risultato nelle risposte successive nella stessa sessione.

La risorsa di risposta di assistenza a cui viene fatto riferimento deve esistere.

Corpo della risposta

Risposta per il metodo DataConnectorService.ExecuteAction.

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

Rappresentazione JSON 
{
  "status": {
    object (Status)
  },
  "textResult": string,
  "result": {
    object
  }
}
Campi
status

object (Status)

Stato dell'esecuzione dell'azione.
textResult

string

Risultato leggibile dell'esecuzione dell'azione in caso di esito positivo.
result

object (Struct format)

Risultato dettagliato dell'esecuzione dell'azione in caso di esito positivo.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

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

Per saperne di più, consulta la Authentication Overview.

Autorizzazioni IAM

Richiede la seguente autorizzazione IAM per la risorsa name:

  • discoveryengine.dataConnectors.executeAction

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

AssistAnswerInfo

Messaggio che identifica una chiamata di azione nella risposta di assistenza.

Rappresentazione JSON 
{
  "assistAnswer": string,
  "invocationId": string
}
Campi
assistAnswer

string

Obbligatorio. Nome della risposta di assistenza.

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

string

Obbligatorio. L'ID della chiamata di azione.