Method: projects.locations.collections.dataConnector.executeAction

Ejecuta una acción de terceros con DataConnector.

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta de acceso

Parámetros
name

string

Obligatorio. Recurso DataConnector.

Es el conector de datos que se usa para ejecutar la acción.

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos con la siguiente estructura:

Representación JSON 
{
  "actionName": string,
  "args": {
    object
  },
  "languageCode": string,
  "assistAnswerInfo": {
    object (AssistAnswerInfo)
  }
}
Campos
actionName

string

Obligatorio. Es el nombre de la acción.

Por ejemplo, "send_email"
args

object (Struct format)

Obligatorio. Son los argumentos con nombre de la acción.

Por ejemplo: {"recipient": "tom@...", "subject": ... }

Cuando se le ofrece a un usuario, es posible que esta parte se pueda editar.
languageCode

string

Opcional. Es el idioma que se usará para los mensajes de estado y error creados por las acciones.
assistAnswerInfo

object (AssistAnswerInfo)

Opcional. Si se especifica, el resultado de la ejecución de la acción se asociará con la respuesta de asistencia proporcionada. Esto permite que el asistente tenga en cuenta el resultado en las respuestas posteriores de la misma sesión.

Debe existir el recurso de respuesta de asistencia al que se hace referencia.

Cuerpo de la respuesta

Respuesta del método DataConnectorService.ExecuteAction.

Si se ejecuta correctamente, el cuerpo de la respuesta contiene datos con la siguiente estructura:

Representación JSON 
{
  "status": {
    object (Status)
  },
  "textResult": string,
  "result": {
    object
  }
}
Campos
status

object (Status)

Es el estado de la ejecución de la acción.
textResult

string

Es el resultado legible de la ejecución de la acción en caso de éxito.
result

object (Struct format)

Es el resultado detallado de la ejecución de la acción en caso de éxito.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta Authentication Overview.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso name:

  • discoveryengine.dataConnectors.executeAction

Para obtener más información, consulta la documentación de IAM.

AssistAnswerInfo

Es un mensaje que identifica una invocación de acción en la respuesta de asistencia.

Representación JSON 
{
  "assistAnswer": string,
  "invocationId": string
}
Campos
assistAnswer

string

Obligatorio. Es el nombre de la respuesta de asistencia.

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

string

Obligatorio. Es el ID de invocación de la acción.