Vertex AI V1 API - Class Google::Cloud::AIPlatform::V1::RagCorpus (v1.27.0)

Reference documentation and code samples for the Vertex AI V1 API class Google::Cloud::AIPlatform::V1::RagCorpus.

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

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#corpus_status

def corpus_status() -> ::Google::Cloud::AIPlatform::V1::CorpusStatus
Returns

#create_time

def create_time() -> ::Google::Protobuf::Timestamp
Returns

#description

def description() -> ::String
Returns
  • (::String) — Optional. The description of the RagCorpus.

#description=

def description=(value) -> ::String
Parameter
  • value (::String) — Optional. The description of the RagCorpus.
Returns
  • (::String) — Optional. The description of the RagCorpus.

#display_name

def display_name() -> ::String
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.

#display_name=

def display_name=(value) -> ::String
Parameter
  • value (::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.
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.

#encryption_spec

def encryption_spec() -> ::Google::Cloud::AIPlatform::V1::EncryptionSpec
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.

#encryption_spec=

def encryption_spec=(value) -> ::Google::Cloud::AIPlatform::V1::EncryptionSpec
Parameter
  • value (::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.
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.

#name

def name() -> ::String
Returns
  • (::String) — Output only. The resource name of the RagCorpus.

#update_time

def update_time() -> ::Google::Protobuf::Timestamp
Returns

#vector_db_config

def vector_db_config() -> ::Google::Cloud::AIPlatform::V1::RagVectorDbConfig
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.

#vector_db_config=

def vector_db_config=(value) -> ::Google::Cloud::AIPlatform::V1::RagVectorDbConfig
Parameter
  • value (::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.

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.

#vertex_ai_search_config

def vertex_ai_search_config() -> ::Google::Cloud::AIPlatform::V1::VertexAiSearchConfig
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.

#vertex_ai_search_config=

def vertex_ai_search_config=(value) -> ::Google::Cloud::AIPlatform::V1::VertexAiSearchConfig
Parameter
  • value (::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.

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.