# Discovery Engine V1BETA API - Class Google::Cloud::DiscoveryEngine::V1beta::StreamAssistRequest::ToolsSpec::VertexAiSearchSpec (v0.28.0)

0.28.0 (latest) 0.27.0 0.26.0 0.25.0 0.24.0 0.23.1 0.22.0 0.21.0 0.20.1 0.19.1 0.18.0 0.17.0 0.16.0 0.15.0 0.14.2 0.13.0 0.12.0 0.11.0 0.10.0 0.9.0 0.8.0 0.7.2 0.6.0 0.5.0 0.4.0 0.3.0 0.2.1 0.1.0 Reference documentation and code samples for the Discovery Engine V1BETA API class Google::Cloud::DiscoveryEngine::V1beta::StreamAssistRequest::ToolsSpec::VertexAiSearchSpec.

Specification of the Vertex AI Search tool.

## Inherits

- Object

## Extended By

- Google::Protobuf::MessageExts::ClassMethods

## Includes

- Google::Protobuf::MessageExts

## Methods

### #data_store_specs

    def data_store_specs() -> ::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::DataStoreSpec>

**Returns**

- (::Array\<[::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::DataStoreSpec](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Cloud-DiscoveryEngine-V1beta-SearchRequest-DataStoreSpec)\>) --- Optional. Specs defining {::Google::Cloud::DiscoveryEngine::V1beta::DataStore DataStore}s to filter on in a search call and configurations for those data stores. This is only considered for {::Google::Cloud::DiscoveryEngine::V1beta::Engine Engine}s with multiple data stores.

### #data_store_specs=

    def data_store_specs=(value) -> ::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::DataStoreSpec>

**Parameter**

- **value** (::Array\<[::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::DataStoreSpec](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Cloud-DiscoveryEngine-V1beta-SearchRequest-DataStoreSpec)\>) --- Optional. Specs defining {::Google::Cloud::DiscoveryEngine::V1beta::DataStore DataStore}s to filter on in a search call and configurations for those data stores. This is only considered for {::Google::Cloud::DiscoveryEngine::V1beta::Engine Engine}s with multiple data stores.
**Returns**

- (::Array\<[::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::DataStoreSpec](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Cloud-DiscoveryEngine-V1beta-SearchRequest-DataStoreSpec)\>) --- Optional. Specs defining {::Google::Cloud::DiscoveryEngine::V1beta::DataStore DataStore}s to filter on in a search call and configurations for those data stores. This is only considered for {::Google::Cloud::DiscoveryEngine::V1beta::Engine Engine}s with multiple data stores.

### #filter

    def filter() -> ::String

**Returns**

- (::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](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)

### #filter=

    def filter=(value) -> ::String

**Parameter**

- **value** (::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](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
**Returns**

- (::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](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)