OpenAI
Attributes
- 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
Value parameters
- fineTuneId
-
The ID of the fine-tune job to cancel.
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.
Value parameters
- chatBody
-
Chat request body.
Attributes
Creates and streams a model response as chunk objects for the given chat conversation defined in chatBody.
Creates and streams a model response as chunk objects for the given chat conversation defined in chatBody.
Value parameters
- chatBody
-
Chat request body.
- s
-
The streams implementation to use.
Attributes
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
Value parameters
- completionBody
-
Create completion request body.
Attributes
Creates a new edit for provided request body.
Creates a new edit for provided request body.
Value parameters
- editRequestBody
-
Edit request body.
Attributes
Gets info about the fine-tune job.
Gets info about the fine-tune job.
https://platform.openai.com/docs/api-reference/embeddings/create
Value parameters
- embeddingsBody
-
Embeddings request body.
Attributes
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
Value parameters
- fineTunesRequestBody
-
Request body that will be used to create a fine-tune.
Attributes
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
Value parameters
- imageCreationBody
-
Create image request body.
Attributes
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
Value parameters
- moderationsBody
-
Moderation request body.
Attributes
Transcribes audio into the input language.
Transcribes audio into the input language.
Value parameters
- 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.
Attributes
Transcribes audio into the input language.
Transcribes audio into the input language.
Value parameters
- 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.
Attributes
Transcribes audio into the input language.
Transcribes audio into the input language.
Value parameters
- transcriptionConfig
-
An instance of the case class TranscriptionConfig containing the necessary parameters for the audio transcription
Attributes
- Returns
-
An url to edited image.
Translates audio into English text.
Translates audio into English text.
Value parameters
- 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.
Attributes
Translates audio into English text.
Translates audio into English text.
Value parameters
- 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.
Attributes
Translates audio into English text.
Translates audio into English text.
Value parameters
- translationConfig
-
An instance of the case class TranslationConfig containing the necessary parameters for the audio translation.
Attributes
Delete a file.
Delete a file.
Value parameters
- fileId
-
The ID of the file to use for this request.
Attributes
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
Value parameters
- model
-
The model to delete.
Attributes
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
Value parameters
- fineTuneId
-
The ID of the fine-tune job to get events for.
Attributes
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
Value parameters
- 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.
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
Value parameters
- 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
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
Value parameters
- imageEditsConfig
-
An instance of the case class ImageEditConfig containing the necessary parameters for editing the image.
Attributes
Creates a variation of a given image.
Creates a variation of a given image.
https://platform.openai.com/docs/api-reference/images/create-variation
Value parameters
- image
-
The image to use as the basis for the variation. Must be a valid PNG file, less than 4MB, and square.
Attributes
Creates a variation of a given image.
Creates a variation of a given image.
https://platform.openai.com/docs/api-reference/images/create-variation
Value parameters
- systemPath
-
Path to the image to use as the basis for the variation. Must be a valid PNG file, less than 4MB, and square.
Attributes
Creates a variation of a given image.
Creates a variation of a given image.
https://platform.openai.com/docs/api-reference/images/create-variation
Value parameters
- imageVariationsConfig
-
An instance of the case class ImageVariationsConfig containing the necessary parameters for the image variation.
Attributes
Returns information about a specific file.
Returns information about a specific file.
https://platform.openai.com/docs/api-reference/files/retrieve
Value parameters
- fileId
-
The ID of the file to use for this request.
Attributes
Returns the contents of the specified file.
Returns the contents of the specified file.
https://platform.openai.com/docs/api-reference/files/retrieve-content
Value parameters
- fileId
-
The ID of the file.
Attributes
Gets info about the fine-tune job.
Gets info about the fine-tune job.
https://platform.openai.com/docs/api-reference/fine-tunes/retrieve
Value parameters
- fineTuneId
-
The ID of the fine-tune job.
Attributes
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
Value parameters
- modelId
-
The ID of the model to use for this request.
Attributes
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.
Value parameters
- 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.
Attributes
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.
Value parameters
- 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.
Attributes
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.
Value parameters
- 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.
Attributes
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.
Value parameters
- 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.