Method: projects.locations.collections.dataConnector.buildActionInvocation

Cria uma invocação de ação usando o DataConnector.

Solicitação HTTP

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

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

Parâmetros de caminho

Parâmetros
name

string

Obrigatório. Recurso DataConnector.

O conector de dados usado para criar a invocação de ação.

Corpo da solicitação

O corpo da solicitação 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 ser usado para mensagens de status e erro.

Corpo da resposta

Resposta para o método DataConnectorService.BuildActionInvocation.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

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

object (ActionInvocation)

A invocação de ação.

Escopos de autorização

Requer um dos seguintes escopos do 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

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do 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
    }
  ],
  "executedArgs": {
    object
  }
}
Campos
agentName

string

Opcional. Nome do agente que está realizando a ação.
actionName

string

Nome da ação.

Por exemplo: "send_email"
args

object (Struct format)

Argumentos nomeados da ação.

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

Quando oferecida a um usuário, essa parte pode ser editável.

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

string

Recurso DataConnector.

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

string

Apenas saída. O nome da fonte 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 que é mostrada ao usuário.
userConfirmationMessage

string

Apenas saída. Mensagem legível mostrada ao usuário junto com a caixa de diálogo de confirmação.
authorizationUrl

string

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

boolean

Apenas saída. Se verdadeiro, o autor da chamada precisa reenviar a consulta após a autorização do usuário.
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 é baseado 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 houver várias opções para os argumentos de ação (por exemplo, vários horários possíveis para um evento de calendário), esses candidatos de argumento adicionais serão listados neste campo.

Contém uma lista de conjuntos de argumentos, cada um formatado de maneira semelhante ao campo de argumentos. Os conjuntos de argumentos contêm apenas os argumentos que diferem do campo de argumentos. Quando oferecidos a um usuário, esses 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 o restante das 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" }]

executedArgs

object (Struct format)

Apenas saída. Representa os argumentos que foram realmente usados para execução, possivelmente modificados pelo usuário dos argumentos iniciais.