Method: projects.locations.collections.engines.assistants.agents.list

Enumera todos los objetos Agent en un objeto Assistant que creó el llamador.

Solicitud HTTP

GET https://discoveryengine.googleapis.com/v1alpha/{parent=projects/*/locations/*/collections/*/engines/*/assistants/*}/agents

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta

Parámetros
parent

string

Obligatorio. Es el nombre del recurso principal. Formato: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}

Parámetros de consulta

Parámetros
pageSize

integer

Es opcional. Es la cantidad máxima de Agent que se devolverán. Si no se especifica, el valor predeterminado es 100. El valor máximo permitido es 1,000, y los valores superiores se convertirán a 1,000.
pageToken

string

Es opcional. Es un token de página ListAgentsResponse.next_page_token, recibido de una llamada a AgentService.ListAgents anterior. Proporciona esto para recuperar la página siguiente.

Cuando se pagina, todos los demás parámetros proporcionados a agents.list deben coincidir con la llamada que proporcionó el token de la página.
orderBy

string

Es opcional. Es una lista de campos separados por comas según los cuales se ordenará el resultado, en orden ascendente. Usa "desc" después del nombre de un campo para el orden descendente. Campos admitidos:

  • updateTime
  • isPinned

Ejemplo:

  • "updateTime desc"
  • "isPinned desc,updateTime desc": Enumera los agentes primero por isPinned y, luego, por updateTime.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Mensaje de respuesta para el método AgentService.ListAgents.

Si se ejecuta correctamente, el cuerpo de la respuesta contiene datos con la siguiente estructura:

Representación JSON 
{
  "agents": [
    {
      object (Agent)
    }
  ],
  "nextPageToken": string
}
Campos
agents[]

object (Agent)

Son los agentes que el llamador puede ver en el elemento superior Assistant.
nextPageToken

string

Es un token que se puede enviar como ListAgentsRequest.page_token para recuperar la página siguiente. Si se omite este campo, no habrá páginas siguientes.

Permisos de autorización

Se necesita 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 Authentication Overview.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso parent:

  • discoveryengine.agents.list

Para obtener más información, consulta la documentación de IAM.