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

Listet alle Agents unter einem Assistant auf, die vom Aufrufer erstellt wurden

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
parent

string

Erforderlich. Der Name der übergeordneten Ressource. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}

Suchparameter

Parameter
pageSize

integer

Optional. Maximale Anzahl der zurückzugebenden Agents. Wenn sie nicht angegeben ist, wird sie standardmäßig auf 100 gesetzt. Der maximal zulässige Wert beträgt 1000. Werte über 1000 werden in 1000 geändert.
pageToken

string

Optional. Ein ListAgentsResponse.next_page_token-Seitentoken, das über einen vorherigen AgentService.ListAgents-Aufruf empfangen wurde. Geben Sie dieses an, um die nachfolgende Seite abzurufen.

Beim Paginieren müssen alle anderen für agents.list bereitgestellten Parameter mit dem Aufruf übereinstimmen, der das Seitentoken bereitgestellt hat.
orderBy

string

Optional. Eine durch Kommas getrennte Liste von Feldern, nach denen in aufsteigender Reihenfolge sortiert werden soll. Verwenden Sie „desc“ nach einem Feldnamen für die absteigende Sortierung. Unterstützte Felder:

  • updateTime
  • isPinned

Beispiel:

  • „updateTime desc“
  • „isPinned desc,updateTime desc“: Agenten zuerst nach isPinned, dann nach updateTime auflisten

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Antwortnachricht für die Methode AgentService.ListAgents.

Wenn der Vorgang erfolgreich abgeschlossen wurde, enthält der Antworttext Daten mit der folgenden Struktur:

JSON-Darstellung 
{
  "agents": [
    {
      object (Agent)
    }
  ],
  "nextPageToken": string
}
Felder
agents[]

object (Agent)

Die KI-Agenten, die für den Aufrufer unter dem übergeordneten Assistant sichtbar sind.
nextPageToken

string

Ein Token, das als ListAgentsRequest.page_token gesendet werden kann, um die nächste Seite abzurufen. Wenn dieses Feld weggelassen wird, gibt es keine nachfolgenden Seiten.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

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

Weitere Informationen finden Sie unter Authentication Overview.

IAM-Berechtigungen

Erfordert die folgende IAM-Berechtigung für die Ressource parent:

  • discoveryengine.agents.list

Weitere Informationen finden Sie in der IAM-Dokumentation.