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

Listet alle Assistants unter einem Engine auf.

HTTP-Anfrage

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

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}

Suchparameter

Parameter
pageSize

integer

Maximale Anzahl der zurückzugebenden Assistant. 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

Ein Seitentoken ListAssistantsResponse.next_page_token, das von einem vorherigen AssistantService.ListAssistants-Aufruf empfangen wurde. Geben Sie dieses an, um die nachfolgende Seite abzurufen.

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

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Antwortnachricht für die Methode AssistantService.ListAssistants.

Wenn der Vorgang erfolgreich ist, enthält der Antworttext Daten mit folgender Struktur:

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

object (Assistant)

Alle Assistants des Kunden.
nextPageToken

string

Ein Token, das als ListAssistantsRequest.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.assistants.list

Weitere Informationen finden Sie in der IAM-Dokumentation.