Class: Google::Cloud::AIPlatform::V1::RagVectorDbConfig

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

Overview

Config for the Vector DB to use for RAG.

Defined Under Namespace

Classes: Pinecone, RagManagedDb, VertexVectorSearch

Instance Attribute Summary collapse

Instance Attribute Details

#api_auth ⇒ ::Google::Cloud::AIPlatform::V1::ApiAuth

Returns Authentication config for the chosen Vector DB.

Returns:



82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'proto_docs/google/cloud/aiplatform/v1/vertex_rag_data.rb', line 82

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

  # The config for the default RAG-managed Vector DB.
  class RagManagedDb
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The config for the Pinecone.
  # @!attribute [rw] index_name
  #   @return [::String]
  #     Pinecone index name.
  #     This value cannot be changed after it's set.
  class Pinecone
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The config for the Vertex Vector Search.
  # @!attribute [rw] index_endpoint
  #   @return [::String]
  #     The resource name of the Index Endpoint.
  #     Format:
  #     `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`
  # @!attribute [rw] index
  #   @return [::String]
  #     The resource name of the Index.
  #     Format:
  #     `projects/{project}/locations/{location}/indexes/{index}`
  class VertexVectorSearch
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#pinecone ⇒ ::Google::Cloud::AIPlatform::V1::RagVectorDbConfig::Pinecone

Returns The config for the Pinecone.

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

Returns:



82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'proto_docs/google/cloud/aiplatform/v1/vertex_rag_data.rb', line 82

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

  # The config for the default RAG-managed Vector DB.
  class RagManagedDb
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The config for the Pinecone.
  # @!attribute [rw] index_name
  #   @return [::String]
  #     Pinecone index name.
  #     This value cannot be changed after it's set.
  class Pinecone
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The config for the Vertex Vector Search.
  # @!attribute [rw] index_endpoint
  #   @return [::String]
  #     The resource name of the Index Endpoint.
  #     Format:
  #     `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`
  # @!attribute [rw] index
  #   @return [::String]
  #     The resource name of the Index.
  #     Format:
  #     `projects/{project}/locations/{location}/indexes/{index}`
  class VertexVectorSearch
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#rag_embedding_model_config ⇒ ::Google::Cloud::AIPlatform::V1::RagEmbeddingModelConfig

Returns Optional. Immutable. The embedding model config of the Vector DB.

Returns:



82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'proto_docs/google/cloud/aiplatform/v1/vertex_rag_data.rb', line 82

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

  # The config for the default RAG-managed Vector DB.
  class RagManagedDb
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The config for the Pinecone.
  # @!attribute [rw] index_name
  #   @return [::String]
  #     Pinecone index name.
  #     This value cannot be changed after it's set.
  class Pinecone
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The config for the Vertex Vector Search.
  # @!attribute [rw] index_endpoint
  #   @return [::String]
  #     The resource name of the Index Endpoint.
  #     Format:
  #     `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`
  # @!attribute [rw] index
  #   @return [::String]
  #     The resource name of the Index.
  #     Format:
  #     `projects/{project}/locations/{location}/indexes/{index}`
  class VertexVectorSearch
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#rag_managed_db ⇒ ::Google::Cloud::AIPlatform::V1::RagVectorDbConfig::RagManagedDb

Returns The config for the RAG-managed Vector DB.

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

Returns:



82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'proto_docs/google/cloud/aiplatform/v1/vertex_rag_data.rb', line 82

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

  # The config for the default RAG-managed Vector DB.
  class RagManagedDb
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The config for the Pinecone.
  # @!attribute [rw] index_name
  #   @return [::String]
  #     Pinecone index name.
  #     This value cannot be changed after it's set.
  class Pinecone
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The config for the Vertex Vector Search.
  # @!attribute [rw] index_endpoint
  #   @return [::String]
  #     The resource name of the Index Endpoint.
  #     Format:
  #     `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`
  # @!attribute [rw] index
  #   @return [::String]
  #     The resource name of the Index.
  #     Format:
  #     `projects/{project}/locations/{location}/indexes/{index}`
  class VertexVectorSearch
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#vertex_vector_search ⇒ ::Google::Cloud::AIPlatform::V1::RagVectorDbConfig::VertexVectorSearch

Returns The config for the Vertex Vector Search.

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

Returns:



82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'proto_docs/google/cloud/aiplatform/v1/vertex_rag_data.rb', line 82

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

  # The config for the default RAG-managed Vector DB.
  class RagManagedDb
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The config for the Pinecone.
  # @!attribute [rw] index_name
  #   @return [::String]
  #     Pinecone index name.
  #     This value cannot be changed after it's set.
  class Pinecone
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The config for the Vertex Vector Search.
  # @!attribute [rw] index_endpoint
  #   @return [::String]
  #     The resource name of the Index Endpoint.
  #     Format:
  #     `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`
  # @!attribute [rw] index
  #   @return [::String]
  #     The resource name of the Index.
  #     Format:
  #     `projects/{project}/locations/{location}/indexes/{index}`
  class VertexVectorSearch
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end