Class: Google::Cloud::AIPlatform::V1::RetrieveContextsRequest

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

Overview

Request message for VertexRagService.RetrieveContexts.

Defined Under Namespace

Classes: VertexRagStore

Instance Attribute Summary collapse

Instance Attribute Details

#parent ⇒ ::String

Returns Required. The resource name of the Location from which to retrieve RagContexts. The users must have permission to make a call in the project. Format: projects/{project}/locations/{location}.

Returns:

  • (::String) —

    Required. The resource name of the Location from which to retrieve RagContexts. The users must have permission to make a call in the project. Format: projects/{project}/locations/{location}.



50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'proto_docs/google/cloud/aiplatform/v1/vertex_rag_service.rb', line 50

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

  # The data source for Vertex RagStore.
  # @!attribute [rw] rag_resources
  #   @return [::Array<::Google::Cloud::AIPlatform::V1::RetrieveContextsRequest::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.
  # @!attribute [rw] vector_distance_threshold
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Float]
  #     Optional. Only return contexts with vector distance smaller than the
  #     threshold.
  class VertexRagStore
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The definition of the Rag resource.
    # @!attribute [rw] rag_corpus
    #   @return [::String]
    #     Optional. RagCorpora resource name.
    #     Format:
    #     `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`
    # @!attribute [rw] rag_file_ids
    #   @return [::Array<::String>]
    #     Optional. rag_file_id. The files should be in the same rag_corpus set
    #     in rag_corpus field.
    class RagResource
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end
end

#query ⇒ ::Google::Cloud::AIPlatform::V1::RagQuery

Returns Required. Single RAG retrieve query.

Returns:



50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'proto_docs/google/cloud/aiplatform/v1/vertex_rag_service.rb', line 50

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

  # The data source for Vertex RagStore.
  # @!attribute [rw] rag_resources
  #   @return [::Array<::Google::Cloud::AIPlatform::V1::RetrieveContextsRequest::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.
  # @!attribute [rw] vector_distance_threshold
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Float]
  #     Optional. Only return contexts with vector distance smaller than the
  #     threshold.
  class VertexRagStore
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The definition of the Rag resource.
    # @!attribute [rw] rag_corpus
    #   @return [::String]
    #     Optional. RagCorpora resource name.
    #     Format:
    #     `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`
    # @!attribute [rw] rag_file_ids
    #   @return [::Array<::String>]
    #     Optional. rag_file_id. The files should be in the same rag_corpus set
    #     in rag_corpus field.
    class RagResource
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end
end

#vertex_rag_store ⇒ ::Google::Cloud::AIPlatform::V1::RetrieveContextsRequest::VertexRagStore

Returns The data source for Vertex RagStore.

Returns:



50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'proto_docs/google/cloud/aiplatform/v1/vertex_rag_service.rb', line 50

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

  # The data source for Vertex RagStore.
  # @!attribute [rw] rag_resources
  #   @return [::Array<::Google::Cloud::AIPlatform::V1::RetrieveContextsRequest::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.
  # @!attribute [rw] vector_distance_threshold
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Float]
  #     Optional. Only return contexts with vector distance smaller than the
  #     threshold.
  class VertexRagStore
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The definition of the Rag resource.
    # @!attribute [rw] rag_corpus
    #   @return [::String]
    #     Optional. RagCorpora resource name.
    #     Format:
    #     `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`
    # @!attribute [rw] rag_file_ids
    #   @return [::Array<::String>]
    #     Optional. rag_file_id. The files should be in the same rag_corpus set
    #     in rag_corpus field.
    class RagResource
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end
end