Package org.springframework.ai.openai.api

Class OpenAiFileApi

java.lang.Object

org.springframework.ai.openai.api.OpenAiFileApi

public class OpenAiFileApi
extends Object

OpenAI File API.

Author:

Sun Yuhan

See Also:

• Files API

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	OpenAiFileApi.Builder
static final record	OpenAiFileApi.DeleteFileResponse
static final record	OpenAiFileApi.FileObject
static final record	OpenAiFileApi.FileObjectResponse
static final record	OpenAiFileApi.ListFileRequest
static enum	OpenAiFileApi.Purpose	The intended purpose of the uploaded file
static final record	OpenAiFileApi.UploadFileRequest

Constructor Summary

Constructors

Constructor	Description
OpenAiFileApi(String baseUrl, ApiKey apiKey, org.springframework.http.HttpHeaders headers, org.springframework.web.client.RestClient.Builder restClientBuilder, org.springframework.web.client.ResponseErrorHandler responseErrorHandler)	Create a new OpenAI file api.
OpenAiFileApi(org.springframework.web.client.RestClient restClient)	Create a new OpenAI file api.

Method Summary

Modifier and Type	Method	Description
static OpenAiFileApi.Builder	builder()
org.springframework.http.ResponseEntity<OpenAiFileApi.DeleteFileResponse>	deleteFile(String fileId)	Delete a file
org.springframework.http.ResponseEntity<OpenAiFileApi.FileObjectResponse>	listFiles(OpenAiFileApi.ListFileRequest listFileRequest)	Returns a list of files
org.springframework.http.ResponseEntity<OpenAiFileApi.FileObject>	retrieveFile(String fileId)	Returns information about a specific file
org.springframework.http.ResponseEntity<String>	retrieveFileContent(String fileId)	Returns the contents of the specified file
org.springframework.http.ResponseEntity<OpenAiFileApi.FileObject>	uploadFile(OpenAiFileApi.UploadFileRequest uploadFileRequest)	Upload a file that can be used across various endpoints

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

OpenAiFileApi

public OpenAiFileApi(String baseUrl,
 ApiKey apiKey,
 org.springframework.http.HttpHeaders headers,
 org.springframework.web.client.RestClient.Builder restClientBuilder,
 org.springframework.web.client.ResponseErrorHandler responseErrorHandler)

Create a new OpenAI file api.

Parameters:

baseUrl - api base URL.

apiKey - OpenAI apiKey.

headers - the http headers to use.

restClientBuilder - RestClient builder.

responseErrorHandler - Response error handler.

OpenAiFileApi

public OpenAiFileApi(org.springframework.web.client.RestClient restClient)

Create a new OpenAI file api.

Parameters:

restClient - RestClient instance.

Method Details

builder

public static OpenAiFileApi.Builder builder()

uploadFile

public org.springframework.http.ResponseEntity<OpenAiFileApi.FileObject> uploadFile(OpenAiFileApi.UploadFileRequest uploadFileRequest)

Upload a file that can be used across various endpoints

Parameters:

uploadFileRequest - The request body

Returns:

Response entity containing the file object

listFiles

public org.springframework.http.ResponseEntity<OpenAiFileApi.FileObjectResponse> listFiles(OpenAiFileApi.ListFileRequest listFileRequest)

Returns a list of files

Parameters:

listFileRequest - The request body

Returns:

Response entity containing the files

retrieveFile

public org.springframework.http.ResponseEntity<OpenAiFileApi.FileObject> retrieveFile(String fileId)

Returns information about a specific file

Parameters:

fileId - The file id

Returns:

Response entity containing the file object

deleteFile

public org.springframework.http.ResponseEntity<OpenAiFileApi.DeleteFileResponse> deleteFile(String fileId)

Delete a file

Parameters:

fileId - The file id

Returns:

Response entity containing the deletion status

retrieveFileContent

public org.springframework.http.ResponseEntity<String> retrieveFileContent(String fileId)

Returns the contents of the specified file

Parameters:

fileId - The file id

Returns:

Response entity containing the file content