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

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

Options for combining the results of the batch search operations.

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

Namespace

Google \ Cloud \ VectorSearch \ V1 \ BatchSearchDataObjectsRequest

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ ranker`	`Google\Cloud\VectorSearch\V1\Ranker` Required. The ranker to use for combining the results.
`↳ output_fields`	`Google\Cloud\VectorSearch\V1\OutputFields` Optional. Mask specifying which fields to return.
`↳ top_k`	`int` Optional. The number of results to return. If not set, a default value will be used.

getRanker

Required. The ranker to use for combining the results.

Returns
Type	Description
`Google\Cloud\VectorSearch\V1\Ranker\|null`

hasRanker

clearRanker

setRanker

Required. The ranker to use for combining the results.

Parameter
Name	Description
`var`	`Google\Cloud\VectorSearch\V1\Ranker`

Returns
Type	Description
`$this`

getOutputFields

Optional. Mask specifying which fields to return.

Returns
Type	Description
`Google\Cloud\VectorSearch\V1\OutputFields\|null`

hasOutputFields

clearOutputFields

setOutputFields