Google Cloud Ces V1 Client - Class EngineSource (0.1.0)

Reference documentation and code samples for the Google Cloud Ces V1 Client class EngineSource.

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

Generated from protobuf message google.cloud.ces.v1.DataStoreTool.EngineSource

Namespace

Google \ Cloud \ Ces \ V1 \ DataStoreTool

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ engine	string Required. Full resource name of the Engine. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}
↳ data_store_sources	array<DataStoreSource> Optional. Use to target specific DataStores within the Engine. If empty, the search applies to all DataStores associated with the Engine.
↳ filter	string Optional. A filter applied to the search across the Engine. Not relevant and not used if 'data_store_sources' is provided. See: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata

getEngine

Required. Full resource name of the Engine.

Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}

Returns
Type	Description
string

setEngine

Required. Full resource name of the Engine.

Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getDataStoreSources

Optional. Use to target specific DataStores within the Engine.

If empty, the search applies to all DataStores associated with the Engine.

Returns
Type	Description
Google\Protobuf\Internal\RepeatedField

setDataStoreSources

Optional. Use to target specific DataStores within the Engine.

If empty, the search applies to all DataStores associated with the Engine.

Parameter
Name	Description
var	array<DataStoreSource>

Returns
Type	Description
$this

getFilter

Optional. A filter applied to the search across the Engine. Not relevant and not used if 'data_store_sources' is provided. See: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata

Returns
Type	Description
string

setFilter

Optional. A filter applied to the search across the Engine. Not relevant and not used if 'data_store_sources' is provided. See: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata

Parameter
Name	Description
var	string

Returns
Type	Description
$this