public final class RagCorpus extends GeneratedMessageV3 implements RagCorpusOrBuilder
A RagCorpus is a RagFile container and a project can have multiple
RagCorpora.
Protobuf type google.cloud.aiplatform.v1beta1.RagCorpus
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
public static final int CORPUS_STATUS_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
public static final int CREATE_TIME_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
public static final int DESCRIPTION_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
public static final int NAME_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
public static final int RAG_EMBEDDING_MODEL_CONFIG_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
public static final int RAG_VECTOR_DB_CONFIG_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
public static final int UPDATE_TIME_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
public static final int VECTOR_DB_CONFIG_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
public static final int VERTEX_AI_SEARCH_CONFIG_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
Static Methods
public static RagCorpus getDefaultInstance()
public static final Descriptors.Descriptor getDescriptor()
public static RagCorpus.Builder newBuilder()
public static RagCorpus.Builder newBuilder(RagCorpus prototype)
Parameter |
Name |
Description |
prototype |
RagCorpus
|
public static RagCorpus parseDelimitedFrom(InputStream input)
public static RagCorpus parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static RagCorpus parseFrom(byte[] data)
Parameter |
Name |
Description |
data |
byte[]
|
public static RagCorpus parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static RagCorpus parseFrom(ByteString data)
public static RagCorpus parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static RagCorpus parseFrom(CodedInputStream input)
public static RagCorpus parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static RagCorpus parseFrom(InputStream input)
public static RagCorpus parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static RagCorpus parseFrom(ByteBuffer data)
public static RagCorpus parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Parser<RagCorpus> parser()
Methods
public boolean equals(Object obj)
Parameter |
Name |
Description |
obj |
Object
|
Overrides
public RagCorpus.BackendConfigCase getBackendConfigCase()
public CorpusStatus getCorpusStatus()
Output only. RagCorpus state.
.google.cloud.aiplatform.v1beta1.CorpusStatus corpus_status = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
public CorpusStatusOrBuilder getCorpusStatusOrBuilder()
Output only. RagCorpus state.
.google.cloud.aiplatform.v1beta1.CorpusStatus corpus_status = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
public Timestamp getCreateTime()
Output only. Timestamp when this RagCorpus was created.
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns |
Type |
Description |
Timestamp |
The createTime.
|
public TimestampOrBuilder getCreateTimeOrBuilder()
Output only. Timestamp when this RagCorpus was created.
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
public RagCorpus getDefaultInstanceForType()
public String getDescription()
Optional. The description of the RagCorpus.
string description = 3 [(.google.api.field_behavior) = OPTIONAL];
Returns |
Type |
Description |
String |
The description.
|
public ByteString getDescriptionBytes()
Optional. The description of the RagCorpus.
string description = 3 [(.google.api.field_behavior) = OPTIONAL];
Returns |
Type |
Description |
ByteString |
The bytes for description.
|
public String getDisplayName()
Required. The display name of the RagCorpus.
The name can be up to 128 characters long and can consist of any UTF-8
characters.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
Returns |
Type |
Description |
String |
The displayName.
|
public ByteString getDisplayNameBytes()
Required. The display name of the RagCorpus.
The name can be up to 128 characters long and can consist of any UTF-8
characters.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
Returns |
Type |
Description |
ByteString |
The bytes for displayName.
|
Output only. The resource name of the RagCorpus.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns |
Type |
Description |
String |
The name.
|
public ByteString getNameBytes()
Output only. The resource name of the RagCorpus.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns |
Type |
Description |
ByteString |
The bytes for name.
|
public Parser<RagCorpus> getParserForType()
Overrides
public RagEmbeddingModelConfig getRagEmbeddingModelConfig()
Deprecated. google.cloud.aiplatform.v1beta1.RagCorpus.rag_embedding_model_config is deprecated.
See google/cloud/aiplatform/v1beta1/vertex_rag_data.proto;l=268
Optional. Immutable. The embedding model config of the RagCorpus.
.google.cloud.aiplatform.v1beta1.RagEmbeddingModelConfig rag_embedding_model_config = 6 [deprecated = true, (.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];
public RagEmbeddingModelConfigOrBuilder getRagEmbeddingModelConfigOrBuilder()
Optional. Immutable. The embedding model config of the RagCorpus.
.google.cloud.aiplatform.v1beta1.RagEmbeddingModelConfig rag_embedding_model_config = 6 [deprecated = true, (.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];
public RagVectorDbConfig getRagVectorDbConfig()
Deprecated. google.cloud.aiplatform.v1beta1.RagCorpus.rag_vector_db_config is deprecated. See
google/cloud/aiplatform/v1beta1/vertex_rag_data.proto;l=275
Optional. Immutable. The Vector DB config of the RagCorpus.
.google.cloud.aiplatform.v1beta1.RagVectorDbConfig rag_vector_db_config = 7 [deprecated = true, (.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];
public RagVectorDbConfigOrBuilder getRagVectorDbConfigOrBuilder()
Optional. Immutable. The Vector DB config of the RagCorpus.
.google.cloud.aiplatform.v1beta1.RagVectorDbConfig rag_vector_db_config = 7 [deprecated = true, (.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];
public int getSerializedSize()
Returns |
Type |
Description |
int |
|
Overrides
public Timestamp getUpdateTime()
Output only. Timestamp when this RagCorpus was last updated.
.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns |
Type |
Description |
Timestamp |
The updateTime.
|
public TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. Timestamp when this RagCorpus was last updated.
.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
public RagVectorDbConfig getVectorDbConfig()
Optional. Immutable. The config for the Vector DBs.
.google.cloud.aiplatform.v1beta1.RagVectorDbConfig vector_db_config = 9 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];
public RagVectorDbConfigOrBuilder getVectorDbConfigOrBuilder()
Optional. Immutable. The config for the Vector DBs.
.google.cloud.aiplatform.v1beta1.RagVectorDbConfig vector_db_config = 9 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];
public VertexAiSearchConfig getVertexAiSearchConfig()
Optional. Immutable. The config for the Vertex AI Search.
.google.cloud.aiplatform.v1beta1.VertexAiSearchConfig vertex_ai_search_config = 10 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];
public VertexAiSearchConfigOrBuilder getVertexAiSearchConfigOrBuilder()
Optional. Immutable. The config for the Vertex AI Search.
.google.cloud.aiplatform.v1beta1.VertexAiSearchConfig vertex_ai_search_config = 10 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];
public boolean hasCorpusStatus()
Output only. RagCorpus state.
.google.cloud.aiplatform.v1beta1.CorpusStatus corpus_status = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns |
Type |
Description |
boolean |
Whether the corpusStatus field is set.
|
public boolean hasCreateTime()
Output only. Timestamp when this RagCorpus was created.
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns |
Type |
Description |
boolean |
Whether the createTime field is set.
|
public boolean hasRagEmbeddingModelConfig()
Deprecated. google.cloud.aiplatform.v1beta1.RagCorpus.rag_embedding_model_config is deprecated.
See google/cloud/aiplatform/v1beta1/vertex_rag_data.proto;l=268
Optional. Immutable. The embedding model config of the RagCorpus.
.google.cloud.aiplatform.v1beta1.RagEmbeddingModelConfig rag_embedding_model_config = 6 [deprecated = true, (.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];
Returns |
Type |
Description |
boolean |
Whether the ragEmbeddingModelConfig field is set.
|
public boolean hasRagVectorDbConfig()
Deprecated. google.cloud.aiplatform.v1beta1.RagCorpus.rag_vector_db_config is deprecated. See
google/cloud/aiplatform/v1beta1/vertex_rag_data.proto;l=275
Optional. Immutable. The Vector DB config of the RagCorpus.
.google.cloud.aiplatform.v1beta1.RagVectorDbConfig rag_vector_db_config = 7 [deprecated = true, (.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];
Returns |
Type |
Description |
boolean |
Whether the ragVectorDbConfig field is set.
|
public boolean hasUpdateTime()
Output only. Timestamp when this RagCorpus was last updated.
.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns |
Type |
Description |
boolean |
Whether the updateTime field is set.
|
public boolean hasVectorDbConfig()
Optional. Immutable. The config for the Vector DBs.
.google.cloud.aiplatform.v1beta1.RagVectorDbConfig vector_db_config = 9 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];
Returns |
Type |
Description |
boolean |
Whether the vectorDbConfig field is set.
|
public boolean hasVertexAiSearchConfig()
Optional. Immutable. The config for the Vertex AI Search.
.google.cloud.aiplatform.v1beta1.VertexAiSearchConfig vertex_ai_search_config = 10 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];
Returns |
Type |
Description |
boolean |
Whether the vertexAiSearchConfig field is set.
|
Returns |
Type |
Description |
int |
|
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
public final boolean isInitialized()
Overrides
public RagCorpus.Builder newBuilderForType()
protected RagCorpus.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Returns |
Type |
Description |
Object |
|
Overrides
public RagCorpus.Builder toBuilder()
public void writeTo(CodedOutputStream output)
Overrides