Azure OpenAI API version 2024-06-01
Get a list of all files
Gets a list of all files owned by the Azure OpenAI resource.
These include user uploaded content like files with purpose "fine-tune" for training or validation of fine-tunes models
as well as files that are generated by the service such as "fine-tune-results" which contains various metrics for the corresponding fine-tune job.
Create a new file entity
Creates a new file entity by uploading data from a local machine. Uploaded files can, for example, be used for training or evaluating fine-tuned models.
Create a new file entity by importing data from a provided url
Creates a new file entity by importing data from a provided url. Uploaded files can, for example, be used for training or evaluating fine-tuned models.
Get details for a single file
Gets details for a single file specified by the given file-id including status, size, purpose, etc.
Delete the file
Deletes the file with the given file-id.
Deletion is also allowed if a file was used, e.g., as training file in a fine-tune job.
Get the content of a specific file
Gets the content of the file specified by the given file-id.
Files can be user uploaded content or generated by the service like result metrics of a fine-tune job.
Get a list of all fine-tune jobs
Gets a list of all fine-tune jobs owned by the Azure OpenAI resource.
The details that are returned for each fine-tune job contain besides its identifier
the base model, training and validation files, hyper parameters, time stamps, status and events.
Events are created when the job status changes, e.g. running or complete, and when results are uploaded.
Create a job that fine-tunes a specified model from a given training file
Creates a job that fine-tunes a specified model from a given training file.
Response includes details of the enqueued job including job status and hyper parameters.
The name of the fine-tuned model is added to the response once complete.
Get details for a single fine-tune job
Gets details for a single fine-tune job specified by the given fine-tune-id.
The details contain the base model, training and validation files, hyper parameters, time stamps, status and events.
Events are created when the job status changes, e.g. running or complete, and when results are uploaded.
Delete the fine-tune job
Deletes the fine-tune job specified by the given fine-tune-id.
Cancel the fine-tune job by id
Cancels the processing of the fine-tune job specified by the given fine-tune-id.
Get the checkpoints for the fine-tune job
Gets the checkpoints for the fine-tune job specified by the given fine-tune-id.
Checkpoints are created at the end of successful epochs during training.
Get the events for the fine-tune job by id
Gets the events for the fine-tune job specified by the given fine-tune-id.
Events are created when the job status changes, e.g. running or complete, and when results are uploaded.
Models_List
Gets a list of all models that are accessible by the Azure OpenAI resource.
These include base models as well as all successfully completed fine-tuned models owned by the Azure OpenAI resource.
Models_Get
Gets details for the model specified by the given modelId.
Azure OpenAI Inference API
Generate speech from text
Generates text-to-speech audio from the input text.
Get audio transcription as plain text
Gets transcribed text and associated metadata from provided spoken audio data. Audio will be transcribed in the
written language corresponding to the language it was spoken in.
Get audio translation as plain text
Gets English language transcribed text and associated metadata from provided spoken audio data.
Get chat completions
Gets chat completions for the provided chat messages.
Completions support a wide variety of tasks and generate text that continues from or "completes"
provided prompt data.
Get completions
Gets completions for the provided input prompts.
Completions support a wide variety of tasks and generate text that continues from or "completes"
provided prompt data.
Get embeddings
Return the embeddings for a given prompt.
Get image generations
Creates an image given a prompt.
