Google Cloud Ai Platform V1 Client - Class RagCorpus (1.32.1)

Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class RagCorpus.

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

Generated from protobuf message google.cloud.aiplatform.v1.RagCorpus

Namespace

Google \ Cloud \ AIPlatform \ V1

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ vector_db_config
RagVectorDbConfig

Optional. Immutable. The config for the Vector DBs.

↳ vertex_ai_search_config
VertexAiSearchConfig

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

↳ name
string

Output only. The resource name of the RagCorpus.

↳ display_name
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.

↳ description
string

Optional. The description of the RagCorpus.

↳ create_time
Google\Protobuf\Timestamp

Output only. Timestamp when this RagCorpus was created.

↳ update_time
Google\Protobuf\Timestamp

Output only. Timestamp when this RagCorpus was last updated.

↳ corpus_status
CorpusStatus

Output only. RagCorpus state.

↳ encryption_spec
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.

getVectorDbConfig

Optional. Immutable. The config for the Vector DBs.

Returns
Type
Description

hasVectorDbConfig

setVectorDbConfig

Optional. Immutable. The config for the Vector DBs.

Parameter
Name
Description
Returns
Type
Description
$this

getVertexAiSearchConfig

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

Returns
Type
Description

hasVertexAiSearchConfig

setVertexAiSearchConfig

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

Parameter
Name
Description
Returns
Type
Description
$this

getName

Output only. The resource name of the RagCorpus.

Returns
Type
Description
string

setName

Output only. The resource name of the RagCorpus.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

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.

Returns
Type
Description
string

setDisplayName

Required. The display name of the RagCorpus.

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

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getDescription

Optional. The description of the RagCorpus.

Returns
Type
Description
string

setDescription

Optional. The description of the RagCorpus.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getCreateTime

Output only. Timestamp when this RagCorpus was created.

Returns
Type
Description

hasCreateTime

clearCreateTime

setCreateTime

Output only. Timestamp when this RagCorpus was created.

Parameter
Name
Description
Returns
Type
Description
$this

getUpdateTime

Output only. Timestamp when this RagCorpus was last updated.

Returns
Type
Description

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. Timestamp when this RagCorpus was last updated.

Parameter
Name
Description
Returns
Type
Description
$this

getCorpusStatus

Output only. RagCorpus state.

Returns
Type
Description
CorpusStatus |null

hasCorpusStatus

clearCorpusStatus

setCorpusStatus

Output only. RagCorpus state.

Parameter
Name
Description
Returns
Type
Description
$this

getEncryptionSpec

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
Type
Description

hasEncryptionSpec

clearEncryptionSpec

setEncryptionSpec

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.

Parameter
Name
Description
Returns
Type
Description
$this

getBackendConfig

Returns
Type
Description
string
Design a Mobile Site
View Site in Mobile | Classic
Share by: