java/resources/uploads/methods/cancel/index.md

Cancel upload

Upload uploads().cancel(UploadCancelParamsparams = UploadCancelParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

post /uploads/{upload_id}/cancel

Cancels the Upload. No Parts may be added after an Upload is cancelled.

Returns the Upload object with status cancelled.

Parameters

UploadCancelParams params
- Optional<String> uploadId

Returns

class Upload:

The Upload object can accept byte chunks in the form of Parts.
- String id
  
  The Upload unique identifier, which can be referenced in API endpoints.
- long bytes
  
  The intended number of bytes to be uploaded.
- long createdAt
  
  The Unix timestamp (in seconds) for when the Upload was created.
- long expiresAt
  
  The Unix timestamp (in seconds) for when the Upload will expire.
- String filename
  
  The name of the file to be uploaded.
- JsonValue; object_ "upload"constant
  
  The object type, which is always "upload".
  - UPLOAD("upload")
- String purpose
  
  The intended purpose of the file. Please refer here for acceptable values.
- Status status
  
  The status of the Upload.
  - PENDING("pending")
  - COMPLETED("completed")
  - CANCELLED("cancelled")
  - EXPIRED("expired")
- Optional<FileObject> file
  
  The File object represents a document that has been uploaded to OpenAI.
  - String id
    
    The file identifier, which can be referenced in the API endpoints.
  - long bytes
    
    The size of the file, in bytes.
  - long createdAt
    
    The Unix timestamp (in seconds) for when the file was created.
  - String filename
    
    The name of the file.
  - JsonValue; object_ "file"constant
    
    The object type, which is always file.
    - FILE("file")
  - Purpose purpose
    
    The intended purpose of the file. Supported values are assistants, assistants_output, batch, batch_output, fine-tune, fine-tune-results, vision, and user_data.
    - ASSISTANTS("assistants")
    - ASSISTANTS_OUTPUT("assistants_output")
    - BATCH("batch")
    - BATCH_OUTPUT("batch_output")
    - FINE_TUNE("fine-tune")
    - FINE_TUNE_RESULTS("fine-tune-results")
    - VISION("vision")
    - USER_DATA("user_data")
  - Status status
    
    Deprecated. The current status of the file, which can be either uploaded, processed, or error.
    - UPLOADED("uploaded")
    - PROCESSED("processed")
    - ERROR("error")
  - Optional<Long> expiresAt
    
    The Unix timestamp (in seconds) for when the file will expire.
  - Optional<String> statusDetails
    
    Deprecated. For details on why a fine-tuning training file failed validation, see the error field on fine_tuning.job.

Example

package com.openai.example;

import com.openai.client.OpenAIClient;
import com.openai.client.okhttp.OpenAIOkHttpClient;
import com.openai.models.uploads.Upload;
import com.openai.models.uploads.UploadCancelParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        OpenAIClient client = OpenAIOkHttpClient.fromEnv();

        Upload upload = client.uploads().cancel("upload_abc123");
    }
}

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"
  }
}

java/resources/uploads/methods/cancel/index.md +174 −0 created

1## Cancel upload

3`Upload uploads().cancel(UploadCancelParamsparams = UploadCancelParams.none(), RequestOptionsrequestOptions = RequestOptions.none())`

5**post** `/uploads/{upload_id}/cancel`

7Cancels the Upload. No Parts may be added after an Upload is cancelled.

9Returns the Upload object with status `cancelled`.

11### Parameters

13- `UploadCancelParams params`

15 - `Optional<String> uploadId`

17### Returns

19- `class Upload:`

21 The Upload object can accept byte chunks in the form of Parts.

23 - `String id`

25 The Upload unique identifier, which can be referenced in API endpoints.

27 - `long bytes`

29 The intended number of bytes to be uploaded.

31 - `long createdAt`

33 The Unix timestamp (in seconds) for when the Upload was created.

35 - `long expiresAt`

37 The Unix timestamp (in seconds) for when the Upload will expire.

39 - `String filename`

41 The name of the file to be uploaded.

43 - `JsonValue; object_ "upload"constant`

45 The object type, which is always "upload".

47 - `UPLOAD("upload")`

49 - `String purpose`

51 The intended purpose of the file. [Please refer here](https://platform.openai.com/docs/api-reference/files/object#files/object-purpose) for acceptable values.

53 - `Status status`

55 The status of the Upload.

57 - `PENDING("pending")`

59 - `COMPLETED("completed")`

61 - `CANCELLED("cancelled")`

63 - `EXPIRED("expired")`

65 - `Optional<FileObject> file`

67 The `File` object represents a document that has been uploaded to OpenAI.

69 - `String id`

71 The file identifier, which can be referenced in the API endpoints.

73 - `long bytes`

75 The size of the file, in bytes.

77 - `long createdAt`

79 The Unix timestamp (in seconds) for when the file was created.

81 - `String filename`

83 The name of the file.

85 - `JsonValue; object_ "file"constant`

87 The object type, which is always `file`.

89 - `FILE("file")`

91 - `Purpose purpose`

93 The intended purpose of the file. Supported values are `assistants`, `assistants_output`, `batch`, `batch_output`, `fine-tune`, `fine-tune-results`, `vision`, and `user_data`.

95 - `ASSISTANTS("assistants")`

97 - `ASSISTANTS_OUTPUT("assistants_output")`

99 - `BATCH("batch")`

100

101 - `BATCH_OUTPUT("batch_output")`

102

103 - `FINE_TUNE("fine-tune")`

104

105 - `FINE_TUNE_RESULTS("fine-tune-results")`

106

107 - `VISION("vision")`

108

109 - `USER_DATA("user_data")`

110

111 - `Status status`

112

113 Deprecated. The current status of the file, which can be either `uploaded`, `processed`, or `error`.

114

115 - `UPLOADED("uploaded")`

116

117 - `PROCESSED("processed")`

118

119 - `ERROR("error")`

120

121 - `Optional<Long> expiresAt`

122

123 The Unix timestamp (in seconds) for when the file will expire.

124

125 - `Optional<String> statusDetails`

126

127 Deprecated. For details on why a fine-tuning training file failed validation, see the `error` field on `fine_tuning.job`.

128

129### Example

130

131```java

132package com.openai.example;

133

134import com.openai.client.OpenAIClient;

135import com.openai.client.okhttp.OpenAIOkHttpClient;

136import com.openai.models.uploads.Upload;

137import com.openai.models.uploads.UploadCancelParams;

138

139public final class Main {

140 private Main() {}

141

142 public static void main(String[] args) {

143 OpenAIClient client = OpenAIOkHttpClient.fromEnv();

144

145 Upload upload = client.uploads().cancel("upload_abc123");

146 }

147}

148```

149

150#### Response

151

152```json

153{

154 "id": "id",

155 "bytes": 0,

156 "created_at": 0,

157 "expires_at": 0,

158 "filename": "filename",

159 "object": "upload",

160 "purpose": "purpose",

161 "status": "pending",

162 "file": {

163 "id": "id",

164 "bytes": 0,

165 "created_at": 0,

166 "filename": "filename",

167 "object": "file",

168 "purpose": "assistants",

169 "status": "uploaded",

170 "expires_at": 0,

171 "status_details": "status_details"

172 }

173}

174```