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

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

HTTP-Anfrage

GET https://discoveryengine.googleapis.com/v1alpha/{parent=projects/*/locations/*/collections/*/engines/*}/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 Agent. Wenn nicht angegeben, lautet die Standardeinstellung 100. Der maximal zulässige Wert beträgt 1.000. Werte über 1.000 werden implizit auf 1.000 umgewandelt.
pageToken

string

Optional. Ein Seitentoken ListAgentsResponse.next_page_token, das von einem 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“: Die Liste der Kundenservicemitarbeiter wird zuerst nach „isPinned“ und dann nach „updateTime“ sortiert.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Wenn der Vorgang erfolgreich abgeschlossen wurde, enthält der Antworttext eine Instanz von ListAgentsResponse.

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.