Method: media.upload

Upload a file into a RagCorpus.

Endpoint

  • Upload URI, for media upload requests:
 post https://{service-endpoint}/upload/v1beta1/{parent}/ragFiles:upload
  • Metadata URI, for metadata-only requests:
 post https://{service-endpoint}/v1beta1/{parent}/ragFiles:upload

Where {service-endpoint} is one of the supported service endpoints.

Path parameters

parent string

Required. The name of the RagCorpus resource into which to upload the file. Format: projects/{project}/locations/{location}/ragCorpora/{ragCorpus}

Request body

The request body contains data with the following structure:

Fields
ragFile object (RagFile)

Required. The RagFile to upload.

uploadRagFileConfig object (UploadRagFileConfig)

Required. The config for the RagFiles to be uploaded into the RagCorpus. VertexRagDataService.UploadRagFile.

Response body

Response message for VertexRagDataService.UploadRagFile.

If successful, the response body contains data with the following structure:

Fields

Union field result.

result can be only one of the following:

ragFile object (RagFile)

The RagFile that had been uploaded into the RagCorpus.

error object (Status)

The error that occurred while processing the RagFile.

JSON representation 
{

  // Union field result can be only one of the following:
  "ragFile": {
    object (RagFile)
  },
  "error": {
    object (Status)
  }
  // End of list of possible types for union field result.
}

UploadRagFileConfig

Config for uploading RagFile.

Fields
ragFileChunkingConfig object (RagFileChunkingConfig)

Specifies the size and overlap of chunks after uploading RagFile.

JSON representation 
{
  "ragFileChunkingConfig": {
    object (RagFileChunkingConfig)
  }
}