Method: projects.locations.collections.dataConnector.buildActionInvocation

Crea una invocación de acción con DataConnector.

Solicitud HTTP

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

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 ha usado para crear la invocación de la acción.

Cuerpo de la solicitud

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

Representación JSON 
{
  "actionName": string,
  "languageCode": string
}
Campos
actionName

string

Obligatorio. Nombre de la acción.

Por ejemplo: "send_email"
languageCode

string

Opcional. Idioma que se usará para los mensajes de estado y de error.

Cuerpo de la respuesta

Respuesta del método DataConnectorService.BuildActionInvocation.

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

Representación JSON 
{
  "actionInvocation": {
    object (ActionInvocation)
  }
}
Campos
actionInvocation

object (ActionInvocation)

La invocación de la acción.

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

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

ActionInvocation

Representa una invocación de acción.

Representación 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
    }
  ]
}
Campos
agentName

string

Opcional. Nombre del agente que realiza la acción.
actionName

string

Nombre de la acción.

Por ejemplo: "send_email"
args

object (Struct format)

Argumentos con nombre de la acción.

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

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

Si hay varias opciones para los argumentos de la acción (por ejemplo, varias horas posibles para un evento del calendario), este campo describe la primera opción.
dataConnector

string

DataConnector.

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

string

Solo de salida. El nombre de la fuente de datos.
invocationId

string

Solo de salida. Es el ID de invocación de la acción.
actionDisplayName

string

Solo de salida. Nombre legible de la acción que se muestra al usuario.
userConfirmationMessage

string

Solo de salida. Mensaje legible por humanos que se muestra al usuario junto con el cuadro de diálogo de confirmación.
authorizationUrl

string

Solo de salida. URL de autorización.
resendQueryOnUserAuthorization

boolean

Solo de salida. Si es true, la persona que llama debe volver a enviar la consulta cuando el usuario haya dado su autorización.
parameterDeclaration

object (Struct format)

Solo salida. Descripción de los parámetros de la acción, incluida la información de renderización o validación. Su formato se basa en la especificación de parámetros de OpenAPI. Basado en: https://swagger.io/docs/specification/describing-parameters/

Ejemplo:

{
    "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 de salida. Si hay varias opciones para los argumentos de la acción (por ejemplo, varias horas posibles para un evento del calendario), estas opciones adicionales se muestran en este campo.

Contiene una lista de conjuntos de argumentos, cada uno de los cuales tiene un formato similar al del campo args. Los conjuntos de argumentos solo contienen los argumentos que difieren del campo args. Cuando se ofrecen a un usuario, estos valores pueden editarse.

Por ejemplo:

args contiene la primera opción con todos los argumentos:

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

argSetCandidates contiene el resto de las opciones, pero solo se rellenan los argumentos diferentes:

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