Google Cloud Discovery Engine V1 Client - Class VertexAiSearchSpec (1.11.1)

Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class VertexAiSearchSpec.

Specification of the Vertex AI Search tool.

Generated from protobuf message google.cloud.discoveryengine.v1.StreamAssistRequest.ToolsSpec.VertexAiSearchSpec

Namespace

Google \ Cloud \ DiscoveryEngine \ V1 \ StreamAssistRequest \ ToolsSpec

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ data_store_specs array<Google\Cloud\DiscoveryEngine\V1\SearchRequest\DataStoreSpec>

Optional. Specs defining DataStores to filter on in a search call and configurations for those data stores. This is only considered for Engines with multiple data stores.
↳ filter string

Optional. The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. If this field is unrecognizable, an INVALID_ARGUMENT is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customer might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see Filter

getDataStoreSpecs

Optional. Specs defining DataStores to filter on in a search call and configurations for those data stores. This is only considered for Engines with multiple data stores.

Returns
Type Description
Google\Protobuf\RepeatedField<Google\Cloud\DiscoveryEngine\V1\SearchRequest\DataStoreSpec>

setDataStoreSpecs

Optional. Specs defining DataStores to filter on in a search call and configurations for those data stores. This is only considered for Engines with multiple data stores.

Parameter
Name Description
var array<Google\Cloud\DiscoveryEngine\V1\SearchRequest\DataStoreSpec>
Returns
Type Description
$this

getFilter

Optional. The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive.

If this field is unrecognizable, an INVALID_ARGUMENT is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customer might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see Filter

Returns
Type Description
string

setFilter

Optional. The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive.

If this field is unrecognizable, an INVALID_ARGUMENT is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customer might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see Filter

Parameter
Name Description
var string
Returns
Type Description
$this