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

Muestra todos los Agents de un Assistant que haya creado el llamante.

Solicitud HTTP

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

La URL utiliza la sintaxis de transcodificación a gRPC.

Parámetros de ruta

Parámetros
parent

string

Obligatorio. Nombre del recurso superior. Formato: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}

Los parámetros de consulta

Parámetros
pageSize

integer

Opcional. Número máximo de Agents que se devolverán. Si no se especifica, el valor predeterminado es 100. El valor máximo permitido es 1000. Los valores superiores se reducirán a 1000.
pageToken

string

Opcional. Un token de página ListAgentsResponse.next_page_token, recibido de una llamada AgentService.ListAgents anterior. Proporciona este elemento para obtener la siguiente página.

Al hacer la paginación, todos los demás parámetros proporcionados a agents.list deben ser los mismos que aparecen en la llamada que proporcionó el token de la página.
orderBy

string

Opcional. Lista separada por comas de campos por los que se ordenará el resultado, ordenados de forma ascendente. Usa "desc" después del nombre de un campo para ordenarlo de forma descendente. Campos admitidos:

  • updateTime
  • isPinned

Ejemplo:

  • "updateTime desc"
  • "isPinned desc,updateTime desc": muestra los agentes por isPinned primero y, después, por updateTime.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Mensaje de respuesta del método AgentService.ListAgents.

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

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

object (Agent)

Los agentes que puede ver la persona que llama en la Assistant principal.
nextPageToken

string

Token que se puede enviar como ListAgentsRequest.page_token para obtener la siguiente página. Si se omite este campo, no hay páginas posteriores.

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 parent:

  • discoveryengine.agents.list

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