Google Cloud Vector Search V1 Client - Class BatchSearchDataObjectsRequest (0.2.0)

Reference documentation and code samples for the Google Cloud Vector Search V1 Client class BatchSearchDataObjectsRequest.

A request to perform a batch of search operations.

Generated from protobuf message google.cloud.vectorsearch.v1.BatchSearchDataObjectsRequest

Namespace

Google \ Cloud \ VectorSearch \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ parent string

Required. The resource name of the Collection for which to search. Format: projects/{project}/locations/{location}/collections/{collection}
↳ searches array<Search>

Required. A list of search requests to execute in parallel.
↳ combine BatchSearchDataObjectsRequest\CombineResultsOptions

Optional. Options for combining the results of the batch search operations.

getParent

Required. The resource name of the Collection for which to search.

Format: projects/{project}/locations/{location}/collections/{collection}

Returns
Type Description
string

setParent

Required. The resource name of the Collection for which to search.

Format: projects/{project}/locations/{location}/collections/{collection}

Parameter
Name Description
var string
Returns
Type Description
$this

getSearches

Required. A list of search requests to execute in parallel.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setSearches

Required. A list of search requests to execute in parallel.

Parameter
Name Description
var array<Search>
Returns
Type Description
$this

getCombine

Optional. Options for combining the results of the batch search operations.

Returns
Type Description
BatchSearchDataObjectsRequest\CombineResultsOptions|null

hasCombine

clearCombine

setCombine

Optional. Options for combining the results of the batch search operations.

Parameter
Name Description
var BatchSearchDataObjectsRequest\CombineResultsOptions
Returns
Type Description
$this