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 說明文件。