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

列出 Assistant 下的所有 CannedQuery。

HTTP 要求

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

這個網址使用 gRPC 轉碼語法。

路徑參數

參數
parent

string

這是必要旗標，父項資源名稱。格式：projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}

查詢參數

參數
filter

string

(選用步驟) 篩選運算式。

支援的欄位：

  • enabled
  • googleDefined

範例：

  • enabled=true
  • googleDefined=true
  • enabled=true AND googleDefined=true
pageSize

integer

要傳回的罐頭查詢數量上限。如未指定，則預設為 100。允許的最大值為 1000；超出的數值將一律指定為 1000。
pageToken

string

接收自前一個 CannedQueryService.ListCannedQueries 呼叫的網頁權杖。提供此項目即可擷取後續網頁。

進行分頁時，提供至 CannedQueryService.ListCannedQueries 的所有其他參數須與提供網頁權杖的呼叫相符。

要求主體

要求主體必須為空白。

回應主體

CannedQueryService.ListCannedQueries 方法的回應訊息。

如果成功，回應主體會含有以下結構的資料：

JSON 表示法 
{
  "cannedQueries": [
    {
      object (CannedQuery)
    }
  ],
  "nextPageToken": string
}
欄位
cannedQueries[]

object (CannedQuery)

符合要求的 CannedQuery 清單。
nextPageToken

string

可做為 ListCannedQueriesRequest.page_token 傳送的權杖，用於擷取後續網頁。如果省略這個欄位，就不會有後續頁面。

授權範圍

需要下列其中一種 OAuth 範圍：

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

詳情請參閱Authentication Overview。