Vertex AI V1 API - Class Google::Cloud::AIPlatform::V1::Retrieval (v1.2.0)

Reference documentation and code samples for the Vertex AI V1 API class Google::Cloud::AIPlatform::V1::Retrieval.

Defines a retrieval tool that model can call to access external knowledge.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#disable_attribution

def disable_attribution() -> ::Boolean
Returns
  • (::Boolean) — Optional. Deprecated. This option is no longer supported.

#disable_attribution=

def disable_attribution=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Optional. Deprecated. This option is no longer supported.
Returns
  • (::Boolean) — Optional. Deprecated. This option is no longer supported.

#vertex_ai_search

def vertex_ai_search() -> ::Google::Cloud::AIPlatform::V1::VertexAISearch
Returns
  • (::Google::Cloud::AIPlatform::V1::VertexAISearch) — Set to use data source powered by Vertex AI Search.

    Note: The following fields are mutually exclusive: vertex_ai_search, vertex_rag_store. If a field in that set is populated, all other fields in the set will automatically be cleared.

#vertex_ai_search=

def vertex_ai_search=(value) -> ::Google::Cloud::AIPlatform::V1::VertexAISearch
Parameter
  • value (::Google::Cloud::AIPlatform::V1::VertexAISearch) — Set to use data source powered by Vertex AI Search.

    Note: The following fields are mutually exclusive: vertex_ai_search, vertex_rag_store. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::AIPlatform::V1::VertexAISearch) — Set to use data source powered by Vertex AI Search.

    Note: The following fields are mutually exclusive: vertex_ai_search, vertex_rag_store. If a field in that set is populated, all other fields in the set will automatically be cleared.

#vertex_rag_store

def vertex_rag_store() -> ::Google::Cloud::AIPlatform::V1::VertexRagStore
Returns
  • (::Google::Cloud::AIPlatform::V1::VertexRagStore) — Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService.

    Note: The following fields are mutually exclusive: vertex_rag_store, vertex_ai_search. If a field in that set is populated, all other fields in the set will automatically be cleared.

#vertex_rag_store=

def vertex_rag_store=(value) -> ::Google::Cloud::AIPlatform::V1::VertexRagStore
Parameter
  • value (::Google::Cloud::AIPlatform::V1::VertexRagStore) — Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService.

    Note: The following fields are mutually exclusive: vertex_rag_store, vertex_ai_search. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::AIPlatform::V1::VertexRagStore) — Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService.

    Note: The following fields are mutually exclusive: vertex_rag_store, vertex_ai_search. If a field in that set is populated, all other fields in the set will automatically be cleared.