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
Value parameters
- fineTuneId
-
The ID of the fine-tune job to cancel.
Attributes
Cancels a run that is in_progress.
Cancels a run that is in_progress.
https://platform.openai.com/docs/api-reference/runs/cancelRun
Value parameters
- runId
-
The ID of the run to cancel.
- threadId
-
The ID of the thread to which this run belongs.
Attributes
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
Create an assistant with a model and instructions.
Create an assistant with a model and instructions.
https://platform.openai.com/docs/api-reference/assistants/createAssistant
Value parameters
- createAssistantBody
-
Create completion request body.
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 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
Create a run.
Value parameters
- createRun
-
Create run request body.
- threadId
-
The ID of the thread to run.
Attributes
Create a thread.
Create a thread.
https://platform.openai.com/docs/api-reference/threads/createThread
Value parameters
- createThreadBody
-
Create completion request body.
Attributes
Create a thread and run it in one request.
Create a thread and run it in one request.
https://platform.openai.com/docs/api-reference/runs/createThreadAndRun
Value parameters
- createThreadAndRun
-
Create thread and run request body.
Attributes
Create a message.
Create a message.
https://platform.openai.com/docs/api-reference/messages/createMessage
Value parameters
- threadId
-
The ID of the thread to create a message for.
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
Creates vector store
Creates vector store
Value parameters
- createVectorStoreBody
-
Options for new vector store
Attributes
- Returns
-
Newly created vector store or exception
Creates vector store file
Creates vector store file
Value parameters
- createVectorStoreFileBody
-
Properties of file
- vectorStoreId
-
Id of vector store for file
Attributes
- Returns
-
Newly created vector store file
Delete an assistant.
Delete an assistant.
https://platform.openai.com/docs/api-reference/assistants/deleteAssistant
Value parameters
- assistantId
-
The ID of the assistant to delete.
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
Delete a thread.
Delete a thread.
https://platform.openai.com/docs/api-reference/threads/deleteThread
Value parameters
- threadId
-
The ID of the thread to delete.
Attributes
Deletes vector store
Deletes vector store
Value parameters
- vectorStoreId
-
Id of vector store to be deleted
Attributes
- Returns
-
Result of deleted operation
Deletes vector store file by id
Deletes vector store file by id
Value parameters
- fileId
-
Id of vector store file
- vectorStoreId
-
Id of vector store
Attributes
- Returns
-
Result of delete operation
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 a list of assistants.
Returns a list of assistants.
https://platform.openai.com/docs/api-reference/assistants/listAssistants
Attributes
Returns a list of run steps belonging to a run.
Returns a list of run steps belonging to a run.
https://platform.openai.com/docs/api-reference/runs/listRunSteps
Value parameters
- runId
-
The ID of the run the run steps belong to.
- threadId
-
The ID of the thread the run and run steps belong to.
Attributes
Returns a list of runs belonging to a thread..
Returns a list of runs belonging to a thread..
https://platform.openai.com/docs/api-reference/runs/listRuns
Value parameters
- threadId
-
The ID of the thread the run belongs to.
Attributes
Returns a list of messages for a given thread.
Returns a list of messages for a given thread.
https://platform.openai.com/docs/api-reference/messages/listMessages
Value parameters
- threadId
-
The ID of the thread the messages belong to.
Attributes
List files belonging to particular datastore
List files belonging to particular datastore
Value parameters
- queryParameters
-
Search params
- vectorStoreId
-
Id of vector store
Attributes
- Returns
-
List of vector store files
Lists vector store
Lists vector store
Value parameters
- queryParameters
-
Search params
Attributes
- Returns
-
List of vector stores matching criteria or exception
Modifies an assistant.
Modifies an assistant.
https://platform.openai.com/docs/api-reference/assistants/modifyAssistant
Value parameters
- assistantId
-
The ID of the assistant to modify.
Attributes
Modifies a message.
Modifies a message.
https://platform.openai.com/docs/api-reference/messages/modifyMessage
Value parameters
- messageId
-
The ID of the message to modify.
- threadId
-
The ID of the thread to which this message belongs.
Attributes
Modifies a run.
Modifies a run.
https://platform.openai.com/docs/api-reference/runs/modifyRun
Value parameters
- runId
-
The ID of the run to modify.
- threadId
-
The ID of the thread that was run.
Attributes
Modifies a thread.
Modifies a thread.
https://platform.openai.com/docs/api-reference/threads/modifyThread
Value parameters
- threadId
-
The ID of the thread to modify. Only the metadata can be modified.
Attributes
Modifies vector store
Modifies vector store
Value parameters
- modifyVectorStoreBody
-
New values for store properties
- vectorStoreId
-
Id of vector store to modify
Attributes
- Returns
-
Modified vector store object
Retrieves an assistant.
Retrieves an assistant.
https://platform.openai.com/docs/api-reference/assistants/getAssistant
Value parameters
- assistantId
-
The ID of the assistant to retrieve.
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
Retrieves a run.
Retrieves a run.
Value parameters
- runId
-
The ID of the run to retrieve.
- threadId
-
The ID of the thread that was run.
Attributes
Retrieves a run step.
Retrieves a run step.
https://platform.openai.com/docs/api-reference/runs/getRunStep
Value parameters
- runId
-
The ID of the run to which the run step belongs.
- stepId
-
The ID of the run step to retrieve.
- threadId
-
The ID of the thread to which the run and run step belongs.
Attributes
Retrieves a thread.
Retrieves a thread.
https://platform.openai.com/docs/api-reference/threads/getThread
Value parameters
- threadId
-
The ID of the thread to retrieve.
Attributes
Retrieve a message.
Retrieve a message.
https://platform.openai.com/docs/api-reference/messages/getMessage
Value parameters
- messageId
-
The ID of the message to retrieve.
- threadId
-
The ID of the thread to which this message belongs.
Attributes
Retrieves vector store by id
Retrieves vector store by id
Value parameters
- vectorStoreId
-
Id of vector store
Attributes
- Returns
-
Vector store object or exception
Retrieves vector store file by id
Retrieves vector store file by id
Value parameters
- fileId
-
Id of vector store file
- vectorStoreId
-
Id of vector store
Attributes
- Returns
-
Vector store file
When a run has the status: "requires_action" and required_action.type is submit_tool_outputs, this endpoint can be used to submit the outputs from the tool calls once they're all completed. All outputs must be submitted in a single request.
When a run has the status: "requires_action" and required_action.type is submit_tool_outputs, this endpoint can be used to submit the outputs from the tool calls once they're all completed. All outputs must be submitted in a single request.
https://platform.openai.com/docs/api-reference/runs/submitToolOutputs
Value parameters
- runId
-
The ID of the run that requires the tool output submission.
- threadId
-
The ID of the thread to which this run belongs.
- toolOutputs
-
A list of tools for which the outputs are being submitted.
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.