rag_corpora

Creates, updates, deletes, gets or lists a rag_corpora resource.

Overview

Name	rag_corpora
Type	Resource
Id	google.aiplatform.rag_corpora

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string	Output only. The resource name of the RagCorpus.
corpusStatus	object	Output only. RagCorpus state. (id: GoogleCloudAiplatformV1CorpusStatus)
createTime	string (google-datetime)	Output only. Timestamp when this RagCorpus was created.
description	string	Optional. The description of the RagCorpus.
displayName	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.
encryptionSpec	object	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. (id: GoogleCloudAiplatformV1EncryptionSpec)
satisfiesPzi	boolean	Output only. Reserved for future use.
satisfiesPzs	boolean	Output only. Reserved for future use.
updateTime	string (google-datetime)	Output only. Timestamp when this RagCorpus was last updated.
vectorDbConfig	object	Optional. Immutable. The config for the Vector DBs. (id: GoogleCloudAiplatformV1RagVectorDbConfig)
vertexAiSearchConfig	object	Optional. Immutable. The config for the Vertex AI Search. (id: GoogleCloudAiplatformV1VertexAiSearchConfig)

list

Name	Datatype	Description
name	string	Output only. The resource name of the RagCorpus.
corpusStatus	object	Output only. RagCorpus state. (id: GoogleCloudAiplatformV1CorpusStatus)
createTime	string (google-datetime)	Output only. Timestamp when this RagCorpus was created.
description	string	Optional. The description of the RagCorpus.
displayName	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.
encryptionSpec	object	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. (id: GoogleCloudAiplatformV1EncryptionSpec)
satisfiesPzi	boolean	Output only. Reserved for future use.
satisfiesPzs	boolean	Output only. Reserved for future use.
updateTime	string (google-datetime)	Output only. Timestamp when this RagCorpus was last updated.
vectorDbConfig	object	Optional. Immutable. The config for the Vector DBs. (id: GoogleCloudAiplatformV1RagVectorDbConfig)
vertexAiSearchConfig	object	Optional. Immutable. The config for the Vertex AI Search. (id: GoogleCloudAiplatformV1VertexAiSearchConfig)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, ragCorporaId		Gets a RagCorpus.
list	select	projectsId, locationsId	pageSize, pageToken	Lists RagCorpora in a Location.
create	insert	projectsId, locationsId		Creates a RagCorpus.
patch	update	projectsId, locationsId, ragCorporaId		Updates a RagCorpus.
delete	delete	projectsId, locationsId, ragCorporaId	force	Deletes a RagCorpus.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
locationsId	string
projectsId	string
ragCorporaId	string
force	boolean
pageSize	integer (int32)
pageToken	string

SELECT examples

get

Gets a RagCorpus.

SELECT
name,
corpusStatus,
createTime,
description,
displayName,
encryptionSpec,
satisfiesPzi,
satisfiesPzs,
updateTime,
vectorDbConfig,
vertexAiSearchConfig
FROM google.aiplatform.rag_corpora
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND ragCorporaId = '{{ ragCorporaId }}' -- required
;

list

Lists RagCorpora in a Location.

SELECT
name,
corpusStatus,
createTime,
description,
displayName,
encryptionSpec,
satisfiesPzi,
satisfiesPzs,
updateTime,
vectorDbConfig,
vertexAiSearchConfig
FROM google.aiplatform.rag_corpora
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
;

INSERT examples

create

Creates a RagCorpus.

INSERT INTO google.aiplatform.rag_corpora (
data__description,
data__displayName,
data__encryptionSpec,
data__vectorDbConfig,
data__vertexAiSearchConfig,
projectsId,
locationsId
)
SELECT 
'{{ description }}',
'{{ displayName }}',
'{{ encryptionSpec }}',
'{{ vectorDbConfig }}',
'{{ vertexAiSearchConfig }}',
'{{ projectsId }}',
'{{ locationsId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: rag_corpora
props:
  - name: projectsId
    value: "{{ projectsId }}"
    description: Required parameter for the rag_corpora resource.
  - name: locationsId
    value: "{{ locationsId }}"
    description: Required parameter for the rag_corpora resource.
  - name: description
    value: "{{ description }}"
    description: |
      Optional. The description of the RagCorpus.
  - name: displayName
    value: "{{ displayName }}"
    description: |
      Required. The display name of the RagCorpus. The name can be up to 128 characters long and can consist of any UTF-8 characters.
  - name: encryptionSpec
    description: |
      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.
    value:
      kmsKeyName: "{{ kmsKeyName }}"
  - name: vectorDbConfig
    description: |
      Optional. Immutable. The config for the Vector DBs.
    value:
      apiAuth:
        apiKeyConfig:
          apiKeySecretVersion: "{{ apiKeySecretVersion }}"
          apiKeyString: "{{ apiKeyString }}"
      pinecone:
        indexName: "{{ indexName }}"
      ragEmbeddingModelConfig:
        vertexPredictionEndpoint:
          endpoint: "{{ endpoint }}"
          model: "{{ model }}"
          modelVersionId: "{{ modelVersionId }}"
      ragManagedDb:
        ann:
          leafCount: {{ leafCount }}
          treeDepth: {{ treeDepth }}
        knn: "{{ knn }}"
      vertexVectorSearch:
        index: "{{ index }}"
        indexEndpoint: "{{ indexEndpoint }}"
  - name: vertexAiSearchConfig
    description: |
      Optional. Immutable. The config for the Vertex AI Search.
    value:
      servingConfig: "{{ servingConfig }}"

UPDATE examples

patch

Updates a RagCorpus.

UPDATE google.aiplatform.rag_corpora
SET 
data__description = '{{ description }}',
data__displayName = '{{ displayName }}',
data__encryptionSpec = '{{ encryptionSpec }}',
data__vectorDbConfig = '{{ vectorDbConfig }}',
data__vertexAiSearchConfig = '{{ vertexAiSearchConfig }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND ragCorporaId = '{{ ragCorporaId }}' --required
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples

delete

Deletes a RagCorpus.

DELETE FROM google.aiplatform.rag_corpora
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND ragCorporaId = '{{ ragCorporaId }}' --required
AND force = '{{ force }}'
;