java/resources/files/methods/retrieve/index.md

Retrieve file

FileObject files().retrieve(FileRetrieveParamsparams = FileRetrieveParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

get /files/{file_id}

Returns information about a specific file.

Parameters

FileRetrieveParams params
- Optional<String> fileId

Returns

class FileObject:

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.files.FileObject;
import com.openai.models.files.FileRetrieveParams;

public final class Main {
    private Main() {}

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

        FileObject fileObject = client.files().retrieve("file_id");
    }
}

Response

{
  "id": "id",
  "bytes": 0,
  "created_at": 0,
  "filename": "filename",
  "object": "file",
  "purpose": "assistants",
  "status": "uploaded",
  "expires_at": 0,
  "status_details": "status_details"
}

java/resources/files/methods/retrieve/index.md +116 −0 created

1## Retrieve file

3`FileObject files().retrieve(FileRetrieveParamsparams = FileRetrieveParams.none(), RequestOptionsrequestOptions = RequestOptions.none())`

5**get** `/files/{file_id}`

7Returns information about a specific file.

9### Parameters

11- `FileRetrieveParams params`

13 - `Optional<String> fileId`

15### Returns

17- `class FileObject:`

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

21 - `String id`

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

25 - `long bytes`

27 The size of the file, in bytes.

29 - `long createdAt`

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

33 - `String filename`

35 The name of the file.

37 - `JsonValue; object_ "file"constant`

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

41 - `FILE("file")`

43 - `Purpose purpose`

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

47 - `ASSISTANTS("assistants")`

49 - `ASSISTANTS_OUTPUT("assistants_output")`

51 - `BATCH("batch")`

53 - `BATCH_OUTPUT("batch_output")`

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

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

59 - `VISION("vision")`

61 - `USER_DATA("user_data")`

63 - `Status status`

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

67 - `UPLOADED("uploaded")`

69 - `PROCESSED("processed")`

71 - `ERROR("error")`

73 - `Optional<Long> expiresAt`

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

77 - `Optional<String> statusDetails`

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

81### Example

83```java

84package com.openai.example;

86import com.openai.client.OpenAIClient;

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

88import com.openai.models.files.FileObject;

89import com.openai.models.files.FileRetrieveParams;

91public final class Main {

92 private Main() {}

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

95 OpenAIClient client = OpenAIOkHttpClient.fromEnv();

97 FileObject fileObject = client.files().retrieve("file_id");

98 }

99}

100```

101

102#### Response

103

104```json

105{

106 "id": "id",

107 "bytes": 0,

108 "created_at": 0,

109 "filename": "filename",

110 "object": "file",

111 "purpose": "assistants",

112 "status": "uploaded",

113 "expires_at": 0,

114 "status_details": "status_details"

115}

116```