Method: projects.locations.collections.dataConnector.buildActionInvocation

Cria uma invocação de ação através do DataConnector.

Pedido HTTP

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

O URL usa a sintaxe de transcodificação de gRPC.

Parâmetros de caminho

Parâmetros
name

string

Obrigatório. DataConnector recurso.

O conetor de dados usado para criar a invocação de ações.

Corpo do pedido

O corpo do pedido contém dados com a seguinte estrutura:

Representação JSON 
{
  "actionName": string,
  "languageCode": string
}
Campos
actionName

string

Obrigatório. Nome da ação.

Por exemplo: "send_email"
languageCode

string

Opcional. Idioma a usar para mensagens de estado e de erro.

Corpo da resposta

Resposta para o método DataConnectorService.BuildActionInvocation.

Se for bem-sucedido, o corpo da resposta contém dados com a seguinte estrutura:

Representação JSON 
{
  "actionInvocation": {
    object (ActionInvocation)
  }
}
Campos
actionInvocation

object (ActionInvocation)

A invocação da ação.

Âmbitos de autorização

Requer um dos seguintes âmbitos do OAuth:

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

Para mais informações, consulte o Authentication Overview.

Autorizações de IAM

Requer a seguinte autorização de IAM no recurso name:

  • discoveryengine.dataConnectors.buildActionInvocation

Para mais informações, consulte a documentação do IAM.

ActionInvocation

Representa uma invocação de ação.

Representação 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. Nome do agente que está a realizar a ação.
actionName

string

Nome da ação.

Por exemplo: "send_email"
args

object (Struct format)

Argumentos com nome da ação.

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

Quando oferecida a um utilizador, esta parte pode ser editável.

Se existirem várias opções para os argumentos da ação (por exemplo, vários horários possíveis para um evento de calendário), este campo descreve a primeira opção.
dataConnector

string

DataConnector recurso.

O conetor de dados usado para realizar a ação.
dataSource

string

Apenas saída. O nome da origem de dados.
invocationId

string

Apenas saída. O ID de invocação da ação.
actionDisplayName

string

Apenas saída. Nome legível da ação apresentado ao utilizador.
userConfirmationMessage

string

Apenas saída. Mensagem legível por humanos apresentada ao utilizador juntamente com a caixa de diálogo de confirmação.
authorizationUrl

string

Apenas saída. URL de autorização.
resendQueryOnUserAuthorization

boolean

Apenas saída. Se for verdadeiro, o autor da chamada tem de reenviar a consulta após a autorização do utilizador.
parameterDeclaration

object (Struct format)

Apenas saída. Descrição dos parâmetros da ação, incluindo informações de renderização/validação. O formato baseia-se na especificação de parâmetros da OpenAPI. Com base em: https://swagger.io/docs/specification/describing-parameters/

Exemplo:

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

Apenas saída. Se existirem várias opções para os argumentos de ação (por exemplo, vários horários possíveis para um evento de calendário), estes candidatos a argumentos adicionais são apresentados neste campo.

Contém uma lista de conjuntos de argumentos, cada um formatado de forma semelhante ao campo args. Os conjuntos de argumentos contêm apenas os argumentos que diferem do campo args. Quando são oferecidos a um utilizador, estes valores podem ser editáveis.

Por exemplo:

args contém a primeira opção com todos os argumentos:

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

argSetCandidates contém as restantes opções, mas apenas os argumentos diferentes são preenchidos:

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