SearchDataObjectsResponse

Response for a search request.

JSON representation 
{
  "results": [
    {
      object (SearchResult)
    }
  ],
  "nextPageToken": string,
  "searchResponseMetadata": {
    object (SearchResponseMetadata)
  }
}
Fields
results[]

object (SearchResult)

Output only. The list of dataObjects that match the search criteria.
nextPageToken

string

Output only. A token to retrieve next page of results. Pass to [DataObjectSearchService.SearchDataObjectsRequest.page_token][] to obtain that page.
searchResponseMetadata

object (SearchResponseMetadata)

Output only. Metadata about the search execution.

SearchResult

A single search result.

JSON representation 
{
  "dataObject": {
    object (DataObject)
  },
  "distance": number
}
Fields
dataObject

object (DataObject)

Output only. The matching data object.
distance

number

Output only. The similarity distance.

SearchResponseMetadata

Metadata about the search execution.

JSON representation 
{

  // 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.
}
Fields
Union field index_type. The type of index used. index_type can be only one of the following:
usedIndex

object (IndexInfo)

Indicates that the search used a particular index.
usedKnn

boolean

Output only. If true, the search used the system's default K-Nearest Neighbor (KNN) index engine.

IndexInfo

Message that indicates the index used for the search.

JSON representation 
{
  "name": string
}
Fields
name

string

Output only. The resource name of the index used for the search. Format: projects/{project}/locations/{location}/collections/{collection}/indexes/{index}