Vertex AI V1 API - Class Google::Cloud::AIPlatform::V1::VertexAISearch (v1.17.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

#data_store_specs=

def data_store_specs=(value) -> ::Array<::Google::Cloud::AIPlatform::V1::VertexAISearch::DataStoreSpec>
Parameter
Returns

#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.