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, Ranking

Instance Attribute Summary collapse

Instance Attribute Details

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

Returns Optional. Config for filters.

Returns:



493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
 
# File 'proto_docs/google/cloud/aiplatform/v1/tool.rb', line 493

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

  # Config for ranking and reranking.
  # @!attribute [rw] rank_service
  #   @return [::Google::Cloud::AIPlatform::V1::RagRetrievalConfig::Ranking::RankService]
  #     Optional. Config for Rank Service.
  #
  #     Note: The following fields are mutually exclusive: `rank_service`, `llm_ranker`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] llm_ranker
  #   @return [::Google::Cloud::AIPlatform::V1::RagRetrievalConfig::Ranking::LlmRanker]
  #     Optional. Config for LlmRanker.
  #
  #     Note: The following fields are mutually exclusive: `llm_ranker`, `rank_service`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  class Ranking
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Config for Rank Service.
    # @!attribute [rw] model_name
    #   @return [::String]
    #     Optional. The model name of the rank service.
    #     Format: `semantic-ranker-512@latest`
    class RankService
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Config for LlmRanker.
    # @!attribute [rw] model_name
    #   @return [::String]
    #     Optional. The model name used for ranking.
    #     Format: `gemini-1.5-pro`
    class LlmRanker
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end
end

#ranking ⇒ ::Google::Cloud::AIPlatform::V1::RagRetrievalConfig::Ranking

Returns Optional. Config for ranking and reranking.

Returns:



493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
 
# File 'proto_docs/google/cloud/aiplatform/v1/tool.rb', line 493

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

  # Config for ranking and reranking.
  # @!attribute [rw] rank_service
  #   @return [::Google::Cloud::AIPlatform::V1::RagRetrievalConfig::Ranking::RankService]
  #     Optional. Config for Rank Service.
  #
  #     Note: The following fields are mutually exclusive: `rank_service`, `llm_ranker`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] llm_ranker
  #   @return [::Google::Cloud::AIPlatform::V1::RagRetrievalConfig::Ranking::LlmRanker]
  #     Optional. Config for LlmRanker.
  #
  #     Note: The following fields are mutually exclusive: `llm_ranker`, `rank_service`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  class Ranking
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Config for Rank Service.
    # @!attribute [rw] model_name
    #   @return [::String]
    #     Optional. The model name of the rank service.
    #     Format: `semantic-ranker-512@latest`
    class RankService
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Config for LlmRanker.
    # @!attribute [rw] model_name
    #   @return [::String]
    #     Optional. The model name used for ranking.
    #     Format: `gemini-1.5-pro`
    class LlmRanker
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end
end

#top_k ⇒ ::Integer

Returns Optional. The number of contexts to retrieve.

Returns:

  • (::Integer) —

    Optional. The number of contexts to retrieve.



493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
 
# File 'proto_docs/google/cloud/aiplatform/v1/tool.rb', line 493

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

  # Config for ranking and reranking.
  # @!attribute [rw] rank_service
  #   @return [::Google::Cloud::AIPlatform::V1::RagRetrievalConfig::Ranking::RankService]
  #     Optional. Config for Rank Service.
  #
  #     Note: The following fields are mutually exclusive: `rank_service`, `llm_ranker`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] llm_ranker
  #   @return [::Google::Cloud::AIPlatform::V1::RagRetrievalConfig::Ranking::LlmRanker]
  #     Optional. Config for LlmRanker.
  #
  #     Note: The following fields are mutually exclusive: `llm_ranker`, `rank_service`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  class Ranking
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Config for Rank Service.
    # @!attribute [rw] model_name
    #   @return [::String]
    #     Optional. The model name of the rank service.
    #     Format: `semantic-ranker-512@latest`
    class RankService
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Config for LlmRanker.
    # @!attribute [rw] model_name
    #   @return [::String]
    #     Optional. The model name used for ranking.
    #     Format: `gemini-1.5-pro`
    class LlmRanker
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end
end