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

Version 1.17.0

• 1.18.0 (latest)
• 1.17.0
• 1.16.0
• 1.15.0
• 1.14.0
• 1.13.1
• 1.12.0
• 1.11.0
• 1.10.0
• 1.9.0
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0
• 0.39.0
• 0.38.0
• 0.37.1
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.2
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.13.0
• 0.12.0
• 0.11.1
• 0.10.0

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.
↳ 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.
↳ vector_db_config	RagVectorDbConfig Optional. Immutable. The config for the Vector DBs.

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
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. Timestamp when this RagCorpus was created.

Parameter
Name	Description
var	Google\Protobuf\Timestamp

Returns
Type	Description
$this

getUpdateTime

Output only. Timestamp when this RagCorpus was last updated.

Returns
Type	Description
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. Timestamp when this RagCorpus was last updated.

Parameter
Name	Description
var	Google\Protobuf\Timestamp

Returns
Type	Description
$this

getCorpusStatus

Output only. RagCorpus state.

Returns
Type	Description
CorpusStatus|null

hasCorpusStatus

clearCorpusStatus

setCorpusStatus

Output only. RagCorpus state.

Parameter
Name	Description
var	CorpusStatus

Returns
Type	Description
$this

getVectorDbConfig

Optional. Immutable. The config for the Vector DBs.

Returns
Type	Description
RagVectorDbConfig|null

hasVectorDbConfig

setVectorDbConfig

Optional. Immutable. The config for the Vector DBs.

Parameter
Name	Description
var	RagVectorDbConfig

Returns
Type	Description
$this

getBackendConfig

Returns
Type	Description
string