Reference documentation and code samples for the Google Cloud Ces V1 Client class 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.
Generated from protobuf message google.cloud.ces.v1.DataStoreTool
Namespace
Google \ Cloud \ Ces \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ data_store_source |
DataStoreTool\DataStoreSource
Optional. Search within a single specific DataStore. |
↳ engine_source |
DataStoreTool\EngineSource
Optional. Search within an Engine (potentially across multiple DataStores). |
↳ name |
string
Required. The data store tool name. |
↳ description |
string
Optional. The tool description. |
↳ boost_specs |
array<DataStoreTool\BoostSpecs>
Optional. Boost specification to boost certain documents. |
↳ modality_configs |
array<DataStoreTool\ModalityConfig>
Optional. The modality configs for the data store. |
↳ filter_parameter_behavior |
int
Optional. The filter parameter behavior. |
getDataStoreSource
Optional. Search within a single specific DataStore.
| Returns | |
|---|---|
| Type | Description |
DataStoreTool\DataStoreSource|null |
|
hasDataStoreSource
setDataStoreSource
Optional. Search within a single specific DataStore.
| Parameter | |
|---|---|
| Name | Description |
var |
DataStoreTool\DataStoreSource
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEngineSource
Optional. Search within an Engine (potentially across multiple DataStores).
| Returns | |
|---|---|
| Type | Description |
DataStoreTool\EngineSource|null |
|
hasEngineSource
setEngineSource
Optional. Search within an Engine (potentially across multiple DataStores).
| Parameter | |
|---|---|
| Name | Description |
var |
DataStoreTool\EngineSource
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getName
Required. The data store tool name.
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Required. The data store tool name.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDescription
Optional. The tool description.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDescription
Optional. The tool description.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getBoostSpecs
Optional. Boost specification to boost certain documents.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setBoostSpecs
Optional. Boost specification to boost certain documents.
| Parameter | |
|---|---|
| Name | Description |
var |
array<DataStoreTool\BoostSpecs>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getModalityConfigs
Optional. The modality configs for the data store.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setModalityConfigs
Optional. The modality configs for the data store.
| Parameter | |
|---|---|
| Name | Description |
var |
array<DataStoreTool\ModalityConfig>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getFilterParameterBehavior
Optional. The filter parameter behavior.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type FilterParameterBehavior. |
setFilterParameterBehavior
Optional. The filter parameter behavior.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type FilterParameterBehavior. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSearchSource
| Returns | |
|---|---|
| Type | Description |
string |
|