Class DataStoreTool (0.3.0)

DataStoreTool(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes

Name Description
data_store_source google.cloud.ces_v1beta.types.DataStoreTool.DataStoreSource
Optional. Search within a single specific DataStore. This field is a member of oneof_ search_source.
engine_source google.cloud.ces_v1beta.types.DataStoreTool.EngineSource
Optional. Search within an Engine (potentially across multiple DataStores). This field is a member of oneof_ search_source.
name str
Required. The data store tool name.
description str
Optional. The tool description.
boost_specs MutableSequence[google.cloud.ces_v1beta.types.DataStoreTool.BoostSpecs]
Optional. Boost specification to boost certain documents.
modality_configs MutableSequence[google.cloud.ces_v1beta.types.DataStoreTool.ModalityConfig]
Optional. The modality configs for the data store.
filter_parameter_behavior google.cloud.ces_v1beta.types.DataStoreTool.FilterParameterBehavior
Optional. The filter parameter behavior.

Classes

BoostSpec

BoostSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Boost specification to boost certain documents.

BoostSpecs

BoostSpecs(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Boost specifications to boost certain documents. For more information, please refer to https://cloud.google.com/generative-ai-app-builder/docs/boosting.

DataStoreSource

DataStoreSource(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Configuration for searching within a specific DataStore.

EngineSource

EngineSource(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Configuration for searching within an Engine, potentially targeting specific DataStores.

FilterParameterBehavior

FilterParameterBehavior(value)

Filter parameter behavior.

GroundingConfig

GroundingConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Grounding configuration.

ModalityConfig

ModalityConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

If specified, will apply the given configuration for the specified modality.

RewriterConfig

RewriterConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Rewriter configuration.

SummarizationConfig

SummarizationConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Summarization configuration.