ExOpenAI.Files.create_file
create_file
, go back to ExOpenAI.Files module for more information.
Specs
create_file(bitstring(), String.t(), openai_organization_key: String.t(), openai_api_key: String.t() ) :: {:ok, ExOpenAI.Components.OpenAIFile.t()} | {:error, any()}
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.
Endpoint: https://api.openai.com/v1/files
Method: POST
Docs: https://platform.openai.com/docs/api-reference/files
Required Arguments:
file
: Name of the JSON Lines file to be uploaded.
If the purpose
is set to "fine-tune", each line is a JSON record with "prompt" and "completion" fields representing your training examples.
purpose
: The intended purpose of the uploaded documents.
Use "fine-tune" for Fine-tuning. This allows us to validate the format of the uploaded file.
Optional Arguments:
openai_api_key
: OpenAI API key to pass directly. If this is specified, it will override theapi_key
config value.openai_organization_key
: OpenAI API key to pass directly. If this is specified, it will override theorganization_key
config value.