Vertex AI V1 API - Class Google::Cloud::AIPlatform::V1::VertexRagStore (v0.61.0)

Version latest

• 0.61.0 (latest)
• 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::VertexRagStore.

Retrieve from Vertex RAG Store for grounding.

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#rag_resources

def rag_resources() -> ::Array<::Google::Cloud::AIPlatform::V1::VertexRagStore::RagResource>

Returns

• (::Array<::Google::Cloud::AIPlatform::V1::VertexRagStore::RagResource>) — Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support.

#rag_resources=

def rag_resources=(value) -> ::Array<::Google::Cloud::AIPlatform::V1::VertexRagStore::RagResource>

Parameter

• value (::Array<::Google::Cloud::AIPlatform::V1::VertexRagStore::RagResource>) — Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support.

Returns

• (::Array<::Google::Cloud::AIPlatform::V1::VertexRagStore::RagResource>) — Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support.

#rag_retrieval_config

def rag_retrieval_config() -> ::Google::Cloud::AIPlatform::V1::RagRetrievalConfig

Returns

• (::Google::Cloud::AIPlatform::V1::RagRetrievalConfig) — Optional. The retrieval config for the Rag query.

#rag_retrieval_config=

def rag_retrieval_config=(value) -> ::Google::Cloud::AIPlatform::V1::RagRetrievalConfig

Parameter

• value (::Google::Cloud::AIPlatform::V1::RagRetrievalConfig) — Optional. The retrieval config for the Rag query.

Returns

• (::Google::Cloud::AIPlatform::V1::RagRetrievalConfig) — Optional. The retrieval config for the Rag query.

#similarity_top_k

def similarity_top_k() -> ::Integer

Returns

• (::Integer) — Optional. Number of top k results to return from the selected corpora.

#similarity_top_k=

def similarity_top_k=(value) -> ::Integer

Parameter

• value (::Integer) — Optional. Number of top k results to return from the selected corpora.

Returns

• (::Integer) — Optional. Number of top k results to return from the selected corpora.

#vector_distance_threshold

def vector_distance_threshold() -> ::Float

Returns

• (::Float) — Optional. Only return results with vector distance smaller than the threshold.

#vector_distance_threshold=

def vector_distance_threshold=(value) -> ::Float

Parameter

• value (::Float) — Optional. Only return results with vector distance smaller than the threshold.

Returns

• (::Float) — Optional. Only return results with vector distance smaller than the threshold.