Gemini Enterprise for Customer Experience V1 API - Class Google::Cloud::Ces::V1::DataStoreTool (v0.1.0)

Reference documentation and code samples for the Gemini Enterprise for Customer Experience V1 API class Google::Cloud::Ces::V1::DataStoreTool.

Tool to retrieve from Vertex AI Search datastore or engine for grounding. Accepts either a datastore or an engine, but not both. See Vertex AI Search: https://cloud.google.com/generative-ai-app-builder/docs/enterprise-search-introduction.

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#boost_specs

def boost_specs() -> ::Array<::Google::Cloud::Ces::V1::DataStoreTool::BoostSpecs>

Returns

• (::Array<::Google::Cloud::Ces::V1::DataStoreTool::BoostSpecs>) — Optional. Boost specification to boost certain documents.

#boost_specs=

def boost_specs=(value) -> ::Array<::Google::Cloud::Ces::V1::DataStoreTool::BoostSpecs>

Parameter

• value (::Array<::Google::Cloud::Ces::V1::DataStoreTool::BoostSpecs>) — Optional. Boost specification to boost certain documents.

Returns

• (::Array<::Google::Cloud::Ces::V1::DataStoreTool::BoostSpecs>) — Optional. Boost specification to boost certain documents.

#data_store_source

def data_store_source() -> ::Google::Cloud::Ces::V1::DataStoreTool::DataStoreSource

Returns

• (::Google::Cloud::Ces::V1::DataStoreTool::DataStoreSource) — Optional. Search within a single specific DataStore.

  Note: The following fields are mutually exclusive: data_store_source, engine_source. If a field in that set is populated, all other fields in the set will automatically be cleared.

#data_store_source=

def data_store_source=(value) -> ::Google::Cloud::Ces::V1::DataStoreTool::DataStoreSource

Parameter

• value (::Google::Cloud::Ces::V1::DataStoreTool::DataStoreSource) — Optional. Search within a single specific DataStore.

  Note: The following fields are mutually exclusive: data_store_source, engine_source. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

• (::Google::Cloud::Ces::V1::DataStoreTool::DataStoreSource) — Optional. Search within a single specific DataStore.

  Note: The following fields are mutually exclusive: data_store_source, engine_source. If a field in that set is populated, all other fields in the set will automatically be cleared.

#description

def description() -> ::String

Returns

• (::String) — Optional. The tool description.

#description=

def description=(value) -> ::String

Parameter

• value (::String) — Optional. The tool description.

Returns

• (::String) — Optional. The tool description.

#engine_source

def engine_source() -> ::Google::Cloud::Ces::V1::DataStoreTool::EngineSource

Returns

• (::Google::Cloud::Ces::V1::DataStoreTool::EngineSource) — Optional. Search within an Engine (potentially across multiple DataStores).

  Note: The following fields are mutually exclusive: engine_source, data_store_source. If a field in that set is populated, all other fields in the set will automatically be cleared.

#engine_source=

def engine_source=(value) -> ::Google::Cloud::Ces::V1::DataStoreTool::EngineSource

Parameter

• value (::Google::Cloud::Ces::V1::DataStoreTool::EngineSource) — Optional. Search within an Engine (potentially across multiple DataStores).

  Note: The following fields are mutually exclusive: engine_source, data_store_source. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

• (::Google::Cloud::Ces::V1::DataStoreTool::EngineSource) — Optional. Search within an Engine (potentially across multiple DataStores).

  Note: The following fields are mutually exclusive: engine_source, data_store_source. If a field in that set is populated, all other fields in the set will automatically be cleared.

#filter_parameter_behavior

def filter_parameter_behavior() -> ::Google::Cloud::Ces::V1::DataStoreTool::FilterParameterBehavior

Returns

• (::Google::Cloud::Ces::V1::DataStoreTool::FilterParameterBehavior) — Optional. The filter parameter behavior.

#filter_parameter_behavior=

def filter_parameter_behavior=(value) -> ::Google::Cloud::Ces::V1::DataStoreTool::FilterParameterBehavior

Parameter

• value (::Google::Cloud::Ces::V1::DataStoreTool::FilterParameterBehavior) — Optional. The filter parameter behavior.

Returns

• (::Google::Cloud::Ces::V1::DataStoreTool::FilterParameterBehavior) — Optional. The filter parameter behavior.

#modality_configs

def modality_configs() -> ::Array<::Google::Cloud::Ces::V1::DataStoreTool::ModalityConfig>

Returns

• (::Array<::Google::Cloud::Ces::V1::DataStoreTool::ModalityConfig>) — Optional. The modality configs for the data store.

#modality_configs=

def modality_configs=(value) -> ::Array<::Google::Cloud::Ces::V1::DataStoreTool::ModalityConfig>

Parameter

• value (::Array<::Google::Cloud::Ces::V1::DataStoreTool::ModalityConfig>) — Optional. The modality configs for the data store.

Returns

• (::Array<::Google::Cloud::Ces::V1::DataStoreTool::ModalityConfig>) — Optional. The modality configs for the data store.

#name

def name() -> ::String

Returns

• (::String) — Required. The data store tool name.

#name=

def name=(value) -> ::String

Parameter

• value (::String) — Required. The data store tool name.

Returns

• (::String) — Required. The data store tool name.