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

Elenca tutti i Agent in un Assistant creati dal chiamante.

Richiesta HTTP

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

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
parent

string

Obbligatorio. Il nome della risorsa padre. Formato: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}

Parametri di query

Parametri
pageSize

integer

Facoltativo. Il numero massimo di Agent da restituire. Se non specificato, il valore predefinito è 100. Il valore massimo consentito è 1000; qualsiasi valore superiore verrà forzato a 1000.
pageToken

string

Facoltativo. Un token di pagina ListAgentsResponse.next_page_token, ricevuto da una precedente chiamata AgentService.ListAgents. Forniscilo per recuperare la pagina successiva.

Durante la paginazione, tutti gli altri parametri forniti a agents.list devono corrispondere alla chiamata che ha fornito il token di pagina.
orderBy

string

Facoltativo. Un elenco separato da virgole di campi in base a cui eseguire l'ordinamento, ordinati in ordine crescente. Utilizza "desc" dopo il nome di un campo per l'ordine decrescente. Campi supportati:

  • updateTime
  • isPinned

Esempio:

  • "updateTime desc"
  • "isPinned desc,updateTime desc": elenca gli agenti prima in base a isPinned e poi in base a updateTime.

Corpo della richiesta

Il corpo della richiesta deve essere vuoto.

Corpo della risposta

Messaggio di risposta per il metodo AgentService.ListAgents.

In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "agents": [
    {
      object (Agent)
    }
  ],
  "nextPageToken": string
}
Campi
agents[]

object (Agent)

Gli agenti visibili al chiamante nella Assistant principale.
nextPageToken

string

Un token che può essere inviato come ListAgentsRequest.page_token per recuperare la pagina successiva. Se questo campo viene omesso, non verranno visualizzate altre pagine.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

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

Per ulteriori informazioni, consulta la Authentication Overview.

Autorizzazioni IAM

Richiede la seguente autorizzazione IAM per la risorsa parent:

  • discoveryengine.agents.list

Per ulteriori informazioni, consulta la documentazione di IAM.