Method: tasks.list

Lista as tarefas que correspondem ao filtro especificado.

Solicitação HTTP

GET https://ces.googleapis.com/tasks

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

Parâmetros de consulta

Parâmetros
tenant

string

Opcional. Identificador de roteamento opaco. Precisa corresponder ao valor tenant da AgentInterface selecionada no cartão do agente quando esse campo estiver definido.
contextId

string

Filtre as tarefas pelo ID do contexto para receber tarefas de uma conversa ou sessão específica.
status

enum (TaskState)

Filtre as tarefas pelo estado atual.
pageToken

string

Um token de página recebido de uma chamada tasks.list anterior. ListTasksResponse.next_page_token. Forneça isso para recuperar a página subsequente.
statusTimestampAfter

string (Timestamp format)

Filtre as tarefas que têm um status atualizado após o carimbo de data/hora fornecido no formato ISO 8601 (por exemplo, "2023-10-27T10:00:00Z"). Somente as tarefas com um carimbo de data/hora de status maior ou igual a esse valor serão retornadas.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de Z, outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
pageSize

integer

O número máximo de tarefas a serem retornadas. O serviço pode retornar um valor inferior a este. Se não for especificado, no máximo 50 tarefas serão retornadas. O valor mínimo é 1. O valor máximo é 100.
historyLength

integer

O número máximo de mensagens a serem incluídas no histórico de cada tarefa.
includeArtifacts

boolean

Se os artefatos serão incluídos nas tarefas retornadas. O padrão é "false" para reduzir o tamanho do payload.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Objeto de resultado para o método tasks.list que contém uma matriz de tarefas e informações de paginação.

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

Representação JSON 
{
  "tasks": [
    {
      object (Task)
    }
  ],
  "nextPageToken": string,
  "pageSize": integer,
  "totalSize": integer
}
Campos
tasks[]

object (Task)

Obrigatório. Matriz de tarefas que correspondem aos critérios especificados.
nextPageToken

string

Obrigatório. Um token para recuperar a próxima página de resultados ou vazio se não houver mais resultados na lista.
pageSize

integer

Obrigatório. O tamanho da página usado para essa resposta.
totalSize

integer

Obrigatório. Número total de tarefas disponíveis (antes da paginação).

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Para mais informações, consulte Authentication Overview.