Method: projects.locations.collections.engines.assistants.cannedQueries.listActiveCannedQueryUserViews

Listet die CannedQueryUserViews für alle aktiven CannedQuerys auf

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
parent

string

Erforderlich. Der Ressourcenname des übergeordneten Assistenten. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}

Suchparameter

Parameter
languageCode

string

Optional. Der Sprachcode, in dem die Standardabfragen zurückgegeben werden sollen. Wenn hier keine Angabe erfolgt oder keine entsprechende Übersetzung gefunden wird, werden die Standardtexte zurückgegeben.
pageSize

integer

Maximale Anzahl der zurückzugebenden CannedQueryUserViews. Wenn sie nicht angegeben ist, wird sie standardmäßig auf 100 gesetzt. Der maximal zulässige Wert beträgt 1.000. Werte über 1.000 werden implizit auf 1.000 umgewandelt.
pageToken

string

Ein ListActiveCannedQueryUserViewsResponse.next_page_token-Seitentoken, das von einem vorherigen CannedQueryService.ListActiveCannedQueryUserViews-Aufruf empfangen wurde. Geben Sie dieses an, um die nachfolgende Seite abzurufen.

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

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Antwortnachricht für die Methode CannedQueryService.ListActiveCannedQueryUserViews.

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

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

object (CannedQueryUserView)

Die CannedQueryUserView, die aktive (vorhandene, aktivierte und die Anforderungen erfüllende) Standardabfragen darstellen.
nextPageToken

string

Ein Token, das als ListActiveCannedQueryUserViewsRequest.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.

CannedQueryUserView

Beschränkte Informationen zu einem CannedQuery, die für die Endnutzer ausreichen.

JSON-Darstellung 
{
  "cannedQuery": string,
  "localizedTexts": {
    object (CannedQueryTexts)
  }
}
Felder
cannedQuery

string

Der Ressourcenname der CannedQuery, für die diese Ansicht gilt. Damit wird die Standardabfrage in der Assist-Anfrage identifiziert.

Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/cannedQueries/{cannedQuery}
localizedTexts

object (CannedQueryTexts)

Die lokalisierten Texte für die Standardabfrage.