Method: projects.locations.collections.dataConnector.executeAction

Ejecuta una acción de terceros mediante DataConnector.

Solicitud HTTP

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

La URL utiliza la sintaxis de transcodificación a gRPC.

Parámetros de ruta

Parámetros
name

string

Obligatorio. DataConnector.

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

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos que presentan la siguiente estructura:

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

string

Obligatorio. Nombre de la acción.

Por ejemplo: "send_email"
args

object (Struct format)

Obligatorio. Argumentos con nombre de la acción.

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

Cuando se ofrece a un usuario, esta parte puede editarse.
languageCode

string

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

object (AssistAnswerInfo)

Opcional. Si se especifica, el resultado de la ejecución de la acción se asociará a la respuesta de asistencia proporcionada. De esta forma, el asistente puede tener en cuenta el resultado en las respuestas posteriores de la misma sesión.

El recurso de respuesta de asistencia al que se hace referencia debe existir.

Cuerpo de la respuesta

Respuesta del método DataConnectorService.ExecuteAction.

Si la solicitud se realiza correctamente, el cuerpo de la respuesta proporciona datos con la siguiente estructura:

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

object (Status)

Estado de la ejecución de la acción.
textResult

string

Resultado legible de la ejecución de la acción en caso de éxito.
result

object (Struct format)

Resultado detallado de la ejecución de la acción en caso de éxito.

Permisos de autorización

Debes disponer de 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 el Authentication Overview.

Permisos de IAM

Requiere el siguiente permiso de gestión de identidades y accesos en el recurso name:

  • discoveryengine.dataConnectors.executeAction

Para obtener más información, consulta la documentación de gestión de identidades y accesos.

AssistAnswerInfo

Mensaje que identifica una invocación de acción en la respuesta del asistente.

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

string

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