REST Resource: projects.locations.ragCorpora

Resource: RagCorpus

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

JSON representation 
{
  "name": string,
  "displayName": string,
  "description": string,
  "ragEmbeddingModelConfig": {
    object (RagEmbeddingModelConfig)
  },
  "createTime": string,
  "updateTime": string
}
Fields
name

string

Output only. The resource name 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.
description

string

Optional. The description of the RagCorpus.
ragEmbeddingModelConfig

object (RagEmbeddingModelConfig)

Optional. Immutable. The embedding model config of the RagCorpus.
createTime

string (Timestamp format)

Output only. timestamp when this RagCorpus was created.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

Output only. timestamp when this RagCorpus was last updated.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

RagEmbeddingModelConfig

Config for the embedding model to use for RAG.

JSON representation 
{

  // Union field model_config can be only one of the following:
  "vertexPredictionEndpoint": {
    object (VertexPredictionEndpoint)
  }
  // End of list of possible types for union field model_config.
}
Fields
Union field model_config. The model config to use. model_config can be only one of the following:
vertexPredictionEndpoint

object (VertexPredictionEndpoint)

The Vertex AI Prediction Endpoint that either refers to a publisher model or an endpoint that is hosting a 1P fine-tuned text embedding model. Endpoints hosting non-1P fine-tuned text embedding models are currently not supported.

VertexPredictionEndpoint

Config representing a model hosted on Vertex Prediction Endpoint.

JSON representation 
{
  "endpoint": string,
  "model": string,
  "modelVersionId": string
}
Fields
endpoint

string

Required. The endpoint resource name. Format: projects/{project}/locations/{location}/publishers/{publisher}/models/{model} or projects/{project}/locations/{location}/endpoints/{endpoint}
model

string

Output only. The resource name of the model that is deployed on the endpoint. Present only when the endpoint is not a publisher model. Pattern: projects/{project}/locations/{location}/models/{model}
modelVersionId

string

Output only. Version ID of the model that is deployed on the endpoint. Present only when the endpoint is not a publisher model.

Methods

create

 Creates a RagCorpus.

delete

 Deletes a RagCorpus.

get

 Gets a RagCorpus.

list

 Lists RagCorpora in a Location.