Discovery Engine V1 API - Class Google::Cloud::DiscoveryEngine::V1::StreamAssistRequest::ToolsSpec::VertexAiSearchSpec (v2.4.0)

Reference documentation and code samples for the Discovery Engine V1 API class Google::Cloud::DiscoveryEngine::V1::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::V1::SearchRequest::DataStoreSpec>
Returns
  • (::Array<::Google::Cloud::DiscoveryEngine::V1::SearchRequest::DataStoreSpec>) — Optional. Specs defining {::Google::Cloud::DiscoveryEngine::V1::DataStore DataStore}s to filter on in a search call and configurations for those data stores. This is only considered for {::Google::Cloud::DiscoveryEngine::V1::Engine Engine}s with multiple data stores.

#data_store_specs=

def data_store_specs=(value) -> ::Array<::Google::Cloud::DiscoveryEngine::V1::SearchRequest::DataStoreSpec>
Parameter
  • value (::Array<::Google::Cloud::DiscoveryEngine::V1::SearchRequest::DataStoreSpec>) — Optional. Specs defining {::Google::Cloud::DiscoveryEngine::V1::DataStore DataStore}s to filter on in a search call and configurations for those data stores. This is only considered for {::Google::Cloud::DiscoveryEngine::V1::Engine Engine}s with multiple data stores.
Returns
  • (::Array<::Google::Cloud::DiscoveryEngine::V1::SearchRequest::DataStoreSpec>) — Optional. Specs defining {::Google::Cloud::DiscoveryEngine::V1::DataStore DataStore}s to filter on in a search call and configurations for those data stores. This is only considered for {::Google::Cloud::DiscoveryEngine::V1::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

#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

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