REST Resource: projects.locations.ragCorpora.ragFiles

Resource: RagFile

A RagFile contains user data for chunking, embedding and indexing.

JSON representation 
{
  "name": string,
  "displayName": string,
  "description": string,
  "sizeBytes": string,
  "ragFileType": enum (RagFileType),
  "createTime": string,
  "updateTime": string,

  // Union field rag_file_source can be only one of the following:
  "gcsSource": {
    object (GcsSource)
  },
  "googleDriveSource": {
    object (GoogleDriveSource)
  },
  "directUploadSource": {
    object (DirectUploadSource)
  }
  // End of list of possible types for union field rag_file_source.
}
Fields
name

string

Output only. The resource name of the RagFile.
displayName

string

Required. The display name of the RagFile. The name can be up to 128 characters long and can consist of any UTF-8 characters.
description

string

Optional. The description of the RagFile.
sizeBytes

string (int64 format)

Output only. The size of the RagFile in bytes.
ragFileType

enum (RagFileType)

Output only. The type of the RagFile.
createTime

string (Timestamp format)

Output only. timestamp when this RagFile 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 RagFile 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".
Union field rag_file_source. The origin location of the RagFile if it is imported from Google Cloud Storage or Google Drive. rag_file_source can be only one of the following:
gcsSource

object (GcsSource)

Output only. Google Cloud Storage location of the RagFile. It does not support wildcards in the Cloud Storage uri for now.
googleDriveSource

object (GoogleDriveSource)

Output only. Google Drive location. Supports importing individual files as well as Google Drive folders.
directUploadSource

object (DirectUploadSource)

Output only. The RagFile is encapsulated and uploaded in the UploadRagFile request.

GoogleDriveSource

The Google Drive location for the input content.

JSON representation 
{
  "resourceIds": [
    {
      object (ResourceId)
    }
  ]
}
Fields
resourceIds[]

object (ResourceId)

Required. Google Drive resource IDs.

ResourceId

The type and ID of the Google Drive resource.

JSON representation 
{
  "resourceType": enum (ResourceType),
  "resourceId": string
}
Fields
resourceType

enum (ResourceType)

Required. The type of the Google Drive resource.
resourceId

string

Required. The ID of the Google Drive resource.

ResourceType

The type of the Google Drive resource.

Enums
RESOURCE_TYPE_UNSPECIFIED Unspecified resource type.
RESOURCE_TYPE_FILE File resource type.
RESOURCE_TYPE_FOLDER Folder resource type.

DirectUploadSource

This type has no fields.

The input content is encapsulated and uploaded in the request.

RagFileType

The type of the RagFile.

Enums
RAG_FILE_TYPE_UNSPECIFIED RagFile type is unspecified.
RAG_FILE_TYPE_TXT RagFile type is TXT.
RAG_FILE_TYPE_PDF RagFile type is PDF.

Methods

delete

 Deletes a RagFile.

get

 Gets a RagFile.

import

 Import files from Google Cloud Storage or Google Drive into a RagCorpus.

list

 Lists RagFiles in a RagCorpus.