Class: Google::Cloud::AIPlatform::V1::RagRetrievalConfig

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/aiplatform/v1/tool.rb

Overview

Specifies the context retrieval config.

Defined Under Namespace

Classes: Filter

Instance Attribute Summary collapse

Instance Attribute Details

#filter ⇒ ::Google::Cloud::AIPlatform::V1::RagRetrievalConfig::Filter

Returns Optional. Config for filters.

Returns:



394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
 
# File 'proto_docs/google/cloud/aiplatform/v1/tool.rb', line 394

class RagRetrievalConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Config for filters.
  # @!attribute [rw] vector_distance_threshold
  #   @return [::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.
  # @!attribute [rw] vector_similarity_threshold
  #   @return [::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.
  # @!attribute [rw] metadata_filter
  #   @return [::String]
  #     Optional. String for metadata filtering.
  class Filter
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#top_k ⇒ ::Integer

Returns Optional. The number of contexts to retrieve.

Returns:

  • (::Integer) —

    Optional. The number of contexts to retrieve.



394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
 
# File 'proto_docs/google/cloud/aiplatform/v1/tool.rb', line 394

class RagRetrievalConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Config for filters.
  # @!attribute [rw] vector_distance_threshold
  #   @return [::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.
  # @!attribute [rw] vector_similarity_threshold
  #   @return [::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.
  # @!attribute [rw] metadata_filter
  #   @return [::String]
  #     Optional. String for metadata filtering.
  class Filter
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end