Complete upload
client.Uploads.Complete(ctx, uploadID, body) (*Upload, error)
post /uploads/{upload_id}/complete
Completes the Upload.
Within the returned Upload object, there is a nested File object that is ready to use in the rest of the platform.
You can specify the order of the Parts by passing in an ordered list of the Part IDs.
The number of bytes uploaded upon completion must match the number of bytes initially specified when creating the Upload object. No Parts may be added after an Upload is completed.
Returns the Upload object with status completed, including an additional file property containing the created usable File object.
Parameters
-
uploadID string -
body UploadCompleteParams-
PartIDs param.Field[[]string]The ordered list of Part IDs.
-
Md5 param.Field[string]The optional md5 checksum for the file contents to verify if the bytes uploaded matches what you expect.
-
Returns
-
type Upload struct{…}The Upload object can accept byte chunks in the form of Parts.
-
ID stringThe Upload unique identifier, which can be referenced in API endpoints.
-
Bytes int64The intended number of bytes to be uploaded.
-
CreatedAt int64The Unix timestamp (in seconds) for when the Upload was created.
-
ExpiresAt int64The Unix timestamp (in seconds) for when the Upload will expire.
-
Filename stringThe name of the file to be uploaded.
-
Object UploadThe object type, which is always "upload".
const UploadUpload Upload = "upload"
-
Purpose stringThe intended purpose of the file. Please refer here for acceptable values.
-
Status UploadStatusThe status of the Upload.
-
const UploadStatusPending UploadStatus = "pending" -
const UploadStatusCompleted UploadStatus = "completed" -
const UploadStatusCancelled UploadStatus = "cancelled" -
const UploadStatusExpired UploadStatus = "expired"
-
-
File FileObjectThe
Fileobject represents a document that has been uploaded to OpenAI.-
ID stringThe file identifier, which can be referenced in the API endpoints.
-
Bytes int64The size of the file, in bytes.
-
CreatedAt int64The Unix timestamp (in seconds) for when the file was created.
-
Filename stringThe name of the file.
-
Object FileThe object type, which is always
file.const FileFile File = "file"
-
Purpose FileObjectPurposeThe intended purpose of the file. Supported values are
assistants,assistants_output,batch,batch_output,fine-tune,fine-tune-results,vision, anduser_data.-
const FileObjectPurposeAssistants FileObjectPurpose = "assistants" -
const FileObjectPurposeAssistantsOutput FileObjectPurpose = "assistants_output" -
const FileObjectPurposeBatch FileObjectPurpose = "batch" -
const FileObjectPurposeBatchOutput FileObjectPurpose = "batch_output" -
const FileObjectPurposeFineTune FileObjectPurpose = "fine-tune" -
const FileObjectPurposeFineTuneResults FileObjectPurpose = "fine-tune-results" -
const FileObjectPurposeVision FileObjectPurpose = "vision" -
const FileObjectPurposeUserData FileObjectPurpose = "user_data"
-
-
Status FileObjectStatusDeprecated. The current status of the file, which can be either
uploaded,processed, orerror.-
const FileObjectStatusUploaded FileObjectStatus = "uploaded" -
const FileObjectStatusProcessed FileObjectStatus = "processed" -
const FileObjectStatusError FileObjectStatus = "error"
-
-
ExpiresAt int64The Unix timestamp (in seconds) for when the file will expire.
-
StatusDetails stringDeprecated. For details on why a fine-tuning training file failed validation, see the
errorfield onfine_tuning.job.
-
-
Example
package main
import (
"context"
"fmt"
"github.com/openai/openai-go"
"github.com/openai/openai-go/option"
)
func main() {
client := openai.NewClient(
option.WithAPIKey("My API Key"),
)
upload, err := client.Uploads.Complete(
context.TODO(),
"upload_abc123",
openai.UploadCompleteParams{
PartIDs: []string{"string"},
},
)
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", upload.ID)
}
Response
{
"id": "id",
"bytes": 0,
"created_at": 0,
"expires_at": 0,
"filename": "filename",
"object": "upload",
"purpose": "purpose",
"status": "pending",
"file": {
"id": "id",
"bytes": 0,
"created_at": 0,
"filename": "filename",
"object": "file",
"purpose": "assistants",
"status": "uploaded",
"expires_at": 0,
"status_details": "status_details"
}
}