Attributes
- Companion:
- object
- Graph
- Supertypes
- class Objecttrait Matchableclass Any
Members list
Value members
Concrete methods
Immediately cancel a fine-tune job.
Immediately cancel a fine-tune job.
https://platform.openai.com/docs/api-reference/fine-tunes/cancel
Attributes
- fineTuneId
The ID of the fine-tune job to cancel.
Closes and releases resources of http client if was not provided explicitly, otherwise works no-op.
Closes and releases resources of http client if was not provided explicitly, otherwise works no-op.
Attributes
Creates a model response for the given chat conversation defined in chatBody.
Creates a model response for the given chat conversation defined in chatBody.
Attributes
- chatBody
Chat request body.
Creates a completion for the provided prompt and parameters given in request body.
Creates a completion for the provided prompt and parameters given in request body.
https://platform.openai.com/docs/api-reference/completions/create
Attributes
- completionBody
Create completion request body.
Creates a new edit for provided request body.
Creates a new edit for provided request body.
Attributes
- editRequestBody
Edit request body.
Gets info about the fine-tune job.
Gets info about the fine-tune job.
https://platform.openai.com/docs/api-reference/embeddings/create
Attributes
- embeddingsBody
Embeddings request body.
Creates a job that fine-tunes a specified model from a given dataset.
Creates a job that fine-tunes a specified model from a given dataset.
https://platform.openai.com/docs/api-reference/fine-tunes/create
Attributes
- fineTunesRequestBody
Request body that will be used to create a fine-tune.
Creates an image given a prompt in request body.
Creates an image given a prompt in request body.
https://platform.openai.com/docs/api-reference/images/create
Attributes
- imageCreationBody
Create image request body.
Classifies if text violates OpenAI's Content Policy.
Classifies if text violates OpenAI's Content Policy.
https://platform.openai.com/docs/api-reference/moderations/create
Attributes
- moderationsBody
Moderation request body.
Transcribes audio into the input language.
Transcribes audio into the input language.
Attributes
- file
The audio file to transcribe, in one of these formats: mp3, mp4, mpeg, mpga, m4a, wav, or webm.
- model
ID of the model to use. Only whisper-1 is currently available.
Transcribes audio into the input language.
Transcribes audio into the input language.
Attributes
- model
ID of the model to use. Only whisper-1 is currently available.
- systemPath
The audio systemPath to transcribe, in one of these formats: mp3, mp4, mpeg, mpga, m4a, wav, or webm.
Transcribes audio into the input language.
Transcribes audio into the input language.
Attributes
- transcriptionConfig
An instance of the case class TranscriptionConfig containing the necessary parameters for the audio transcription
- Returns:
An url to edited image.
Translates audio into English text.
Translates audio into English text.
Attributes
- file
The audio file to translate, in one of these formats: mp3, mp4, mpeg, mpga, m4a, wav, or webm.
- model
ID of the model to use. Only whisper-1 is currently available.
Translates audio into English text.
Translates audio into English text.
Attributes
- model
ID of the model to use. Only whisper-1 is currently available.
- systemPath
The audio systemPath to transcribe, in one of these formats: mp3, mp4, mpeg, mpga, m4a, wav, or webm.
Translates audio into English text.
Translates audio into English text.
Attributes
- translationConfig
An instance of the case class TranslationConfig containing the necessary parameters for the audio translation.
Delete a file.
Delete a file.
Attributes
- fileId
The ID of the file to use for this request.
Delete a fine-tuned model. You must have the Owner role in your organization.
Delete a fine-tuned model. You must have the Owner role in your organization.
https://platform.openai.com/docs/api-reference/fine-tunes/delete-model
Attributes
- model
The model to delete.
Returns a list of files that belong to the user's organization.
Returns a list of files that belong to the user's organization.
Attributes
Get fine-grained status updates for a fine-tune job.
Get fine-grained status updates for a fine-tune job.
https://platform.openai.com/docs/api-reference/fine-tunes/events
Attributes
- fineTuneId
The ID of the fine-tune job to get events for.
List of your organization's fine-tuning jobs.
List of your organization's fine-tuning jobs.
https://platform.openai.com/docs/api-reference/fine-tunes/list
Attributes
Lists the currently available models, and provides basic information about each one such as the owner and availability.
Lists the currently available models, and provides basic information about each one such as the owner and availability.
Attributes
Creates edited or extended images given an original image and a prompt.
Creates edited or extended images given an original image and a prompt.
https://platform.openai.com/docs/api-reference/images/create-edit
Attributes
- image
The image to be edited. Must be a valid PNG file, less than 4MB, and square. If mask is not provided, image must have transparency, which will be used as the mask.
- prompt
A text description of the desired image. The maximum length is 1000 characters.
Creates edited or extended images given an original image and a prompt.
Creates edited or extended images given an original image and a prompt.
https://platform.openai.com/docs/api-reference/images/create-edit
Attributes
- prompt
A text description of the desired image. The maximum length is 1000 characters.
- systemPath
Path to the image to be edited. Must be a valid PNG file, less than 4MB, and square. If mask is not provided, image must have transparency, which will be used as the mask
Creates edited or extended images given an original image and a prompt.
Creates edited or extended images given an original image and a prompt.
https://platform.openai.com/docs/api-reference/images/create-edit
Attributes
- imageEditsConfig
An instance of the case class ImageEditConfig containing the necessary parameters for editing the image.
Creates a variation of a given image.
Creates a variation of a given image.
https://platform.openai.com/docs/api-reference/images/create-variation
Attributes
- image
The image to use as the basis for the variation. Must be a valid PNG file, less than 4MB, and square.
Creates a variation of a given image.
Creates a variation of a given image.
https://platform.openai.com/docs/api-reference/images/create-variation
Attributes
- systemPath
Path to the image to use as the basis for the variation. Must be a valid PNG file, less than 4MB, and square.
Creates a variation of a given image.
Creates a variation of a given image.
https://platform.openai.com/docs/api-reference/images/create-variation
Attributes
- imageVariationsConfig
An instance of the case class ImageVariationsConfig containing the necessary parameters for the image variation.
Returns information about a specific file.
Returns information about a specific file.
https://platform.openai.com/docs/api-reference/files/retrieve
Attributes
- fileId
The ID of the file to use for this request.
Returns the contents of the specified file.
Returns the contents of the specified file.
https://platform.openai.com/docs/api-reference/files/retrieve-content
Attributes
- fileId
The ID of the file.
Gets info about the fine-tune job.
Gets info about the fine-tune job.
https://platform.openai.com/docs/api-reference/fine-tunes/retrieve
Attributes
- fineTuneId
The ID of the fine-tune job.
Retrieves a model instance, providing basic information about the model such as the owner and permissions.
Retrieves a model instance, providing basic information about the model such as the owner and permissions.
https://platform.openai.com/docs/api-reference/models/retrieve
Attributes
- modelId
The ID of the model to use for this request.
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 OpenAI if you need to increase the storage limit.
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 OpenAI if you need to increase the storage limit.
Attributes
- file
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 OpenAI to validate the format of the uploaded 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 OpenAI if you need to increase the storage limit.
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 OpenAI if you need to increase the storage limit.
Attributes
- file
JSON Lines file to be uploaded and the purpose is set to "fine-tune", each line is a JSON record with "prompt" and "completion" fields representing your training examples.
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 OpenAI if you need to increase the storage limit.
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 OpenAI if you need to increase the storage limit.
Attributes
- purpose
The intended purpose of the uploaded documents. Use "fine-tune" for Fine-tuning. This allows OpenAI to validate the format of the uploaded file.
- systemPath
Path to 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.
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 OpenAI if you need to increase the storage limit.
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 OpenAI if you need to increase the storage limit.
Attributes
- systemPath
Path to the JSON Lines file to be uploaded and the purpose is set to "fine-tune", each line is a JSON record with "prompt" and "completion" fields representing your training examples.