- 1.19.0 (latest)
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.0
- 1.12.0
- 1.11.0
- 1.10.0
- 1.9.0
- 1.8.0
- 1.7.0
- 1.6.0
- 1.5.0
- 1.4.0
- 1.3.0
- 1.2.0
- 1.1.0
- 1.0.0
- 0.64.0
- 0.63.0
- 0.62.0
- 0.61.0
- 0.60.0
- 0.59.0
- 0.58.0
- 0.57.0
- 0.56.0
- 0.55.0
- 0.54.0
- 0.53.0
- 0.52.0
- 0.51.0
- 0.50.0
- 0.49.0
- 0.48.0
- 0.47.0
- 0.46.0
- 0.45.0
- 0.44.0
- 0.43.0
- 0.42.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.38.0
- 0.37.0
- 0.36.0
- 0.35.0
- 0.34.0
- 0.33.0
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.0
- 0.25.0
- 0.24.0
- 0.23.0
- 0.22.0
- 0.21.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.14.0
- 0.13.0
- 0.12.0
- 0.11.0
- 0.10.0
- 0.9.1
- 0.8.0
- 0.7.0
- 0.6.0
- 0.5.0
- 0.4.0
- 0.3.0
- 0.2.0
- 0.1.0
Reference documentation and code samples for the Vertex AI V1 API class Google::Cloud::AIPlatform::V1::VertexAISearch.
Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#data_store_specs
def data_store_specs() -> ::Array<::Google::Cloud::AIPlatform::V1::VertexAISearch::DataStoreSpec>
Returns
- (::Array<::Google::Cloud::AIPlatform::V1::VertexAISearch::DataStoreSpec>) — Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used.
#data_store_specs=
def data_store_specs=(value) -> ::Array<::Google::Cloud::AIPlatform::V1::VertexAISearch::DataStoreSpec>
Parameter
- value (::Array<::Google::Cloud::AIPlatform::V1::VertexAISearch::DataStoreSpec>) — Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used.
Returns
- (::Array<::Google::Cloud::AIPlatform::V1::VertexAISearch::DataStoreSpec>) — Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used.
#datastore
def datastore() -> ::String
Returns
-
(::String) — Optional. Fully-qualified Vertex AI Search data store resource ID.
Format:
projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}
#datastore=
def datastore=(value) -> ::String
Parameter
-
value (::String) — Optional. Fully-qualified Vertex AI Search data store resource ID.
Format:
projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}
Returns
-
(::String) — Optional. Fully-qualified Vertex AI Search data store resource ID.
Format:
projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}
#engine
def engine() -> ::String
Returns
-
(::String) — Optional. Fully-qualified Vertex AI Search engine resource ID.
Format:
projects/{project}/locations/{location}/collections/{collection}/engines/{engine}
#engine=
def engine=(value) -> ::String
Parameter
-
value (::String) — Optional. Fully-qualified Vertex AI Search engine resource ID.
Format:
projects/{project}/locations/{location}/collections/{collection}/engines/{engine}
Returns
-
(::String) — Optional. Fully-qualified Vertex AI Search engine resource ID.
Format:
projects/{project}/locations/{location}/collections/{collection}/engines/{engine}
#filter
def filter() -> ::String
Returns
- (::String) — Optional. Filter strings to be passed to the search API.
#filter=
def filter=(value) -> ::String
Parameter
- value (::String) — Optional. Filter strings to be passed to the search API.
Returns
- (::String) — Optional. Filter strings to be passed to the search API.
#max_results
def max_results() -> ::Integer
Returns
- (::Integer) — Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10.
#max_results=
def max_results=(value) -> ::Integer
Parameter
- value (::Integer) — Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10.
Returns
- (::Integer) — Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10.