Method: projects.locations.collections.dataObjects.query

查询数据对象。

HTTP 请求

POST https://vectorsearch.googleapis.com/v1/{parent}/dataObjects:query

路径参数

参数
parent

string

必需。要查询的集合的资源名称。格式：projects/{project}/locations/{location}/collections/{collection}

请求正文

请求正文中包含结构如下的数据：

JSON 表示法 
{
  "filter": {
    object
  },
  "outputFields": {
    object (OutputFields)
  },
  "pageSize": integer,
  "pageToken": string
}
字段
filter

object (Struct format)

可选。JSON 过滤条件表达式，例如 {"genre": {"$eq": "sci-fi"}}，表示为 google.protobuf.Struct。
outputFields

object (OutputFields)

可选。指定要返回的字段的掩码。
pageSize

integer

可选。标准列表页面大小。
pageToken

string

可选。标准列表页面令牌。 通常通过上一个 DataObjectSearchService.QueryDataObjects 调用的 QueryDataObjectsResponse.next_page_token 获取。

响应正文

DataObjectSearchService.QueryDataObjects 的响应消息。

如果成功，响应正文将包含结构如下的数据：

JSON 表示法 
{
  "dataObjects": [
    {
      object (DataObject)
    }
  ],
  "nextPageToken": string
}
字段
dataObjects[]

object (DataObject)

与查询匹配的 dataObject 列表。
nextPageToken

string

用于检索下一页结果的令牌。 传递给 [DataObjectSearchService.QueryDataObjectsRequest.page_token][] 即可获取该页面。

授权范围

需要以下 OAuth 范围：

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

如需了解详情，请参阅 Authentication Overview。

IAM 权限

需要拥有 parent 资源的以下 IAM 权限：

  • vectorsearch.dataObjects.query

如需了解详情，请参阅 IAM 文档。