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。