Class: Google::Cloud::AIPlatform::V1::RagCorpus

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

A RagCorpus is a RagFile container and a project can have multiple RagCorpora.

Instance Attribute Summary collapse

Instance Attribute Details

#corpus_status ⇒ ::Google::Cloud::AIPlatform::V1::CorpusStatus (readonly)

Returns Output only. RagCorpus state.

Returns:



269
270
271
272
 
# File 'proto_docs/google/cloud/aiplatform/v1/vertex_rag_data.rb', line 269

class RagCorpus
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#create_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. Timestamp when this RagCorpus was created.

Returns:



269
270
271
272
 
# File 'proto_docs/google/cloud/aiplatform/v1/vertex_rag_data.rb', line 269

class RagCorpus
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#description ⇒ ::String

Returns Optional. The description of the RagCorpus.

Returns:

  • (::String) —

    Optional. The description of the RagCorpus.



269
270
271
272
 
# File 'proto_docs/google/cloud/aiplatform/v1/vertex_rag_data.rb', line 269

class RagCorpus
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#display_name ⇒ ::String

Returns Required. The display name of the RagCorpus. The name can be up to 128 characters long and can consist of any UTF-8 characters.

Returns:

  • (::String) —

    Required. The display name of the RagCorpus. The name can be up to 128 characters long and can consist of any UTF-8 characters.



269
270
271
272
 
# File 'proto_docs/google/cloud/aiplatform/v1/vertex_rag_data.rb', line 269

class RagCorpus
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#encryption_spec ⇒ ::Google::Cloud::AIPlatform::V1::EncryptionSpec

Returns Optional. Immutable. The CMEK key name used to encrypt at-rest data related to this Corpus. Only applicable to RagManagedDb option for Vector DB. This field can only be set at corpus creation time, and cannot be updated or deleted.

Returns:

  • (::Google::Cloud::AIPlatform::V1::EncryptionSpec) —

    Optional. Immutable. The CMEK key name used to encrypt at-rest data related to this Corpus. Only applicable to RagManagedDb option for Vector DB. This field can only be set at corpus creation time, and cannot be updated or deleted.



269
270
271
272
 
# File 'proto_docs/google/cloud/aiplatform/v1/vertex_rag_data.rb', line 269

class RagCorpus
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#name ⇒ ::String (readonly)

Returns Output only. The resource name of the RagCorpus.

Returns:

  • (::String) —

    Output only. The resource name of the RagCorpus.



269
270
271
272
 
# File 'proto_docs/google/cloud/aiplatform/v1/vertex_rag_data.rb', line 269

class RagCorpus
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#update_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. Timestamp when this RagCorpus was last updated.

Returns:



269
270
271
272
 
# File 'proto_docs/google/cloud/aiplatform/v1/vertex_rag_data.rb', line 269

class RagCorpus
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#vector_db_config ⇒ ::Google::Cloud::AIPlatform::V1::RagVectorDbConfig

Returns Optional. Immutable. The config for the Vector DBs.

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

Returns:

  • (::Google::Cloud::AIPlatform::V1::RagVectorDbConfig) —

    Optional. Immutable. The config for the Vector DBs.

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



269
270
271
272
 
# File 'proto_docs/google/cloud/aiplatform/v1/vertex_rag_data.rb', line 269

class RagCorpus
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#vertex_ai_search_config ⇒ ::Google::Cloud::AIPlatform::V1::VertexAiSearchConfig

Returns Optional. Immutable. The config for the Vertex AI Search.

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

Returns:

  • (::Google::Cloud::AIPlatform::V1::VertexAiSearchConfig) —

    Optional. Immutable. The config for the Vertex AI Search.

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



269
270
271
272
 
# File 'proto_docs/google/cloud/aiplatform/v1/vertex_rag_data.rb', line 269

class RagCorpus
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end