Class RagCorpus (1.101.0) 

RagCorpus(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes
Name Description
vector_db_config google.cloud.aiplatform_v1beta1.types.RagVectorDbConfig
Optional. Immutable. The config for the Vector DBs. This field is a member of oneof_ backend_config.
vertex_ai_search_config google.cloud.aiplatform_v1beta1.types.VertexAiSearchConfig
Optional. Immutable. The config for the Vertex AI Search. This field is a member of oneof_ backend_config.
name str
Output only. The resource name of the RagCorpus.
display_name str
Required. The display name of the RagCorpus. The name can be up to 128 characters long and can consist of any UTF-8 characters.
description str
Optional. The description of the RagCorpus.
rag_embedding_model_config google.cloud.aiplatform_v1beta1.types.RagEmbeddingModelConfig
Optional. Immutable. The embedding model config of the RagCorpus.
rag_vector_db_config google.cloud.aiplatform_v1beta1.types.RagVectorDbConfig
Optional. Immutable. The Vector DB config of the RagCorpus.
create_time google.protobuf.timestamp_pb2.Timestamp
Output only. Timestamp when this RagCorpus was created.
update_time google.protobuf.timestamp_pb2.Timestamp
Output only. Timestamp when this RagCorpus was last updated.
corpus_status google.cloud.aiplatform_v1beta1.types.CorpusStatus
Output only. RagCorpus state.
rag_files_count int
Output only. Number of RagFiles in the RagCorpus.
encryption_spec google.cloud.aiplatform_v1beta1.types.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.
corpus_type_config google.cloud.aiplatform_v1beta1.types.RagCorpus.CorpusTypeConfig
Optional. The corpus type config of the RagCorpus.

Classes

CorpusTypeConfig

CorpusTypeConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The config for the corpus type of the RagCorpus.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Methods

RagCorpus

RagCorpus(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields