SearchDataObjectsResponse

検索リクエストのレスポンス。

JSON 表現
{
  "results": [
    {
      object (SearchResult)
    }
  ],
  "nextPageToken": string,
  "searchResponseMetadata": {
    object (SearchResponseMetadata)
  }
}
フィールド
results[]

object (SearchResult)

出力専用。検索条件に一致する dataObject のリスト。

nextPageToken

string

出力専用。結果の次ページを取得するためのトークン。[DataObjectSearchService.SearchDataObjectsRequest.page_token][] に渡して、そのページを取得します。

searchResponseMetadata

object (SearchResponseMetadata)

出力専用。検索の実行に関するメタデータ。

SearchResult

単一の検索結果。

JSON 表現
{
  "dataObject": {
    object (DataObject)
  },
  "distance": number
}
フィールド
dataObject

object (DataObject)

出力専用。一致するデータ オブジェクト。

distance

number

出力専用。類似性距離。

SearchResponseMetadata

検索の実行に関するメタデータ。

JSON 表現
{

  // Union field index_type can be only one of the following:
  "usedIndex": {
    object (IndexInfo)
  },
  "usedKnn": boolean
  // End of list of possible types for union field index_type.
}
フィールド
共用体フィールド index_type。使用されるインデックスのタイプ。index_type は次のいずれかになります。
usedIndex

object (IndexInfo)

検索で特定のインデックスが使用されたことを示します。

usedKnn

boolean

出力専用。true の場合、検索ではシステムのデフォルトの k 近傍法(KNN)インデックス エンジンが使用されました。

IndexInfo

検索に使用されたインデックスを示すメッセージ。

JSON 表現
{
  "name": string
}
フィールド
name

string

出力専用。検索に使用されるインデックスのリソース名。形式: projects/{project}/locations/{location}/collections/{collection}/indexes/{index}