Vertex AI V1 API - Class Google::Cloud::AIPlatform::V1::RagRetrievalConfig::Filter (v1.34.0)

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

Config for filters.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#metadata_filter

def metadata_filter() -> ::String
Returns
  • (::String) — Optional. String for metadata filtering.

#metadata_filter=

def metadata_filter=(value) -> ::String
Parameter
  • value (::String) — Optional. String for metadata filtering.
Returns
  • (::String) — Optional. String for metadata filtering.

#vector_distance_threshold

def vector_distance_threshold() -> ::Float
Returns
  • (::Float) — Optional. Only returns contexts with vector distance smaller than the threshold.

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

#vector_distance_threshold=

def vector_distance_threshold=(value) -> ::Float
Parameter
  • value (::Float) — Optional. Only returns contexts with vector distance smaller than the threshold.

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

Returns
  • (::Float) — Optional. Only returns contexts with vector distance smaller than the threshold.

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

#vector_similarity_threshold

def vector_similarity_threshold() -> ::Float
Returns
  • (::Float) — Optional. Only returns contexts with vector similarity larger than the threshold.

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

#vector_similarity_threshold=

def vector_similarity_threshold=(value) -> ::Float
Parameter
  • value (::Float) — Optional. Only returns contexts with vector similarity larger than the threshold.

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

Returns
  • (::Float) — Optional. Only returns contexts with vector similarity larger than the threshold.

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