Method: media.upload

Full name: media.upload

Upload a file into a RagCorpus.

Endpoint

  • Upload URI, for media upload requests:
post https: / /{service-endpoint} /upload /v1 /{parent} /ragFiles:upload
  • Metadata URI, for metadata-only requests:
post https: / /{service-endpoint} /v1 /{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
result Union type
The result of the upload. 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
 { 
 // result 
 "ragFile" 
 : 
 { 
 object (  RagFile 
 
) 
 } 
 , 
 "error" 
 : 
 { 
 object (  Status 
 
) 
 } 
 // Union type 
 } 

UploadRagFileConfig

Config for uploading RagFile.

Fields
ragFileTransformationConfig object ( RagFileTransformationConfig )

Specifies the transformation config for RagFiles.

JSON representation
 { 
 "ragFileTransformationConfig" 
 : 
 { 
 object (  RagFileTransformationConfig 
 
) 
 } 
 } 
Create a Mobile Website
View Site in Mobile | Classic
Share by: