OpenAI.Files (openai_client v0.5.3)
Files are used to upload documents that can be used with features like Fine-tuning.
Link to this section Summary
Functions
Delete a file.
Returns a list of files that belong to the user's organization.
Returns information about a specific file.
Returns the content of the specified file.
Upload a file that contains document(s) to be used across various endpoints/features. Currently, the size of all the files uploaded by one organization can be up to 1 GB. Please contact us if you need to increase the storage limit.
Link to this section Types
upload_params()
Link to this section Functions
delete(client, id, opts \\ [])
@spec delete(OpenAI.Client.t(), String.t(), Keyword.t()) :: OpenAI.Client.result()
Delete a file.
list(client, opts \\ [])
@spec list(OpenAI.Client.t(), Keyword.t()) :: OpenAI.Client.result()
Returns a list of files that belong to the user's organization.
retrieve(client, id, opts \\ [])
@spec retrieve(OpenAI.Client.t(), String.t(), Keyword.t()) :: OpenAI.Client.result()
Returns information about a specific file.
retrieve_content(client, id, opts \\ [])
@spec retrieve_content(OpenAI.Client.t(), String.t(), Keyword.t()) :: OpenAI.Client.result()
Returns the content of the specified file.
upload(client, params, opts \\ [])
@spec upload(OpenAI.Client.t(), upload_params(), Keyword.t()) :: OpenAI.Client.result()
Upload a file that contains document(s) to be used across various endpoints/features. Currently, the size of all the files uploaded by one organization can be up to 1 GB. Please contact us if you need to increase the storage limit.