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 \ V1Methods
__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 |
|