Azure OpenAI API Version 2024-12-01-preview (preview:2024-12-01)

2025/01/07 • 28 new methods

Batch_List (new)
Description :  Gets a list of all batches owned by the Azure OpenAI resource.
Reference :  Link ¶

⚼ Request

GET:  /batches
{
after:
{
Description: Identifier for the last event from the previous pagination request. ,
Required: False ,
}
string ,
limit:
{
Description: Number of batches to retrieve. Defaults to 20. ,
Format: int32 ,
Required: False ,
}
integer ,
$filter:
{
Description: The OData expression to describe the filtering conditions. ,
Required: False ,
}
string ,
$orderby:
{
Description: The OData expression to describe the sorting order. ,
Required: False ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
object:
{
Description: Defines the type of an object. ,
Enum:
{
list: This object represents a list of other objects. ,
fine_tuning.job: This object represents a fine tune job. ,
file: This object represents a file. ,
fine_tuning.job.event: This object represents an event of a fine tuning job. ,
fine_tuning.job.checkpoint: This object represents a checkpoint of a fine tuning job. ,
model: This object represents a model (can be a base model or fine tune job result). ,
upload: This object represents a file upload. ,
upload.part: This object represents part of a file upload. ,
batch: This object represents a batch. ,
}
,
Required: False ,
}
enum ,
data:
{
Description: The list of items. ,
Required: False ,
}
[
{
id:
{
Description: The identity of this item. ,
Required: True ,
}
string ,
object:
{
Description: Defines the type of an object. ,
Enum:
{
list: This object represents a list of other objects. ,
fine_tuning.job: This object represents a fine tune job. ,
file: This object represents a file. ,
fine_tuning.job.event: This object represents an event of a fine tuning job. ,
fine_tuning.job.checkpoint: This object represents a checkpoint of a fine tuning job. ,
model: This object represents a model (can be a base model or fine tune job result). ,
upload: This object represents a file upload. ,
upload.part: This object represents part of a file upload. ,
batch: This object represents a batch. ,
}
,
Required: False ,
}
enum ,
endpoint:
{
Description: The API endpoint used by the batch. ,
Required: False ,
}
string ,
errors:
{
Description: For batches that have failed, this will contain more information on the cause of the failures. ,
Required: False ,
}
{
object:
{
Description: The type of the errors object. This is always 'list'. ,
Required: False ,
}
string ,
data:
{
Description: Error information for a failure in batch. ,
Required: False ,
}
{
code:
{
Description: An error code identifying the error type. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable message providing more details about the error. ,
Required: False ,
}
string ,
param:
{
Description: The name of the parameter that caused the error, if applicable (can be null). ,
Required: False ,
}
string ,
line:
{
Description: The line number of the input file where the error occurred, if applicable (can be null). ,
Required: False ,
}
string ,
}
,
}
,
input_file_id:
{
Description: The ID of the input file for the batch. ,
Required: True ,
}
string ,
completion_window:
{
Description: The time frame within which the batch should be processed. ,
Required: False ,
}
string ,
status:
{
Description: The status of a batch. ,
Enum:
{
validating: The input file is being validated before the batch can begin. ,
failed: The input file has failed the validation process. ,
in_progress: The input file was successfully validated and the batch is currently being executed. ,
finalizing: The batch has completed and the results are being prepared. ,
completed: The batch has been completed and the results are ready. ,
expired: The batch was not able to complete within the 24-hour time window. ,
cancelling: Cancellation of the batch has been initiated. ,
cancelled: The batch was cancelled. ,
}
,
Required: False ,
}
enum ,
output_file_id:
{
Description: The ID of the file containing outputs of successfully executed requests. ,
Required: False ,
}
string ,
error_file_id:
{
Description: The ID of the file containing outputs of requests with errors. ,
Required: False ,
}
string ,
created_at:
{
Description: A timestamp when this batch was created (in unix epochs). ,
Format: unixtime ,
Required: False ,
}
integer ,
in_progress_at:
{
Description: A timestamp when this batch started progressing (in unix epochs). ,
Format: unixtime ,
Required: False ,
}
integer ,
expires_at:
{
Description: A timestamp when this batch will expire (in unix epochs). ,
Format: unixtime ,
Required: False ,
}
integer ,
finalizing_at:
{
Description: A timestamp when this batch started finalizing (in unix epochs). ,
Format: unixtime ,
Required: False ,
}
integer ,
completed_at:
{
Description: A timestamp when this batch was completed (in unix epochs). ,
Format: unixtime ,
Required: False ,
}
integer ,
failed_at:
{
Description: A timestamp when this batch failed (in unix epochs). ,
Format: unixtime ,
Required: False ,
}
integer ,
expired_at:
{
Description: A timestamp when this batch expired (in unix epochs). ,
Format: unixtime ,
Required: False ,
}
integer ,
cancelling_at:
{
Description: A timestamp when this batch started cancelling (in unix epochs). ,
Format: unixtime ,
Required: False ,
}
integer ,
cancelled_at:
{
Description: A timestamp when this batch was cancelled (in unix epochs). ,
Format: unixtime ,
Required: False ,
}
integer ,
request_counts:
{
Description: The request counts for different statuses within the batch. ,
Required: False ,
}
{
total:
{
Description: The total number of requests in the batch. ,
Required: False ,
}
integer ,
completed:
{
Description: The number of requests in the batch that have been completed successfully. ,
Required: False ,
}
integer ,
failed:
{
Description: The number of requests in the batch that have failed. ,
Required: False ,
}
integer ,
}
,
metadata:
{
Description: A set of key-value pairs that can be attached to the batch. This can be useful for storing additional information about the batch in a structured format. ,
Required: False ,
}
object ,
}
,
]
,
first_id:
{
Description: The id of the first batch in the list of batches returned. ,
Required: False ,
}
string ,
last_id:
{
Description: The id of the last batch in the list of batches returned. ,
Required: False ,
}
string ,
has_more:
{
Description: A value indicating whether the list contains more elements than returned. ,
Required: False ,
}
boolean ,
}

⚐ Response (default)

{
error:
{
Description: Error content as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). ,
Required: True ,
}
{
code:
{
Description: Error codes as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). ,
Enum:
{
conflict: The requested operation conflicts with the current resource state. ,
invalidPayload: The request data is invalid for this operation. ,
forbidden: The operation is forbidden for the current user/api key. ,
notFound: The resource is not found. ,
unexpectedEntityState: The operation cannot be executed in the current resource's state. ,
itemDoesAlreadyExist: The item does already exist. ,
serviceUnavailable: The service is currently not available. ,
internalFailure: Internal error. Please retry. ,
quotaExceeded: Quota exceeded. ,
jsonlValidationFailed: Validation of jsonl data failed. ,
fileImportFailed: Import of file failed. ,
tooManyRequests: Too many requests. Please retry later. ,
unauthorized: The current user/api key is not authorized for the operation. ,
contentFilter: Image generation failed as a result of our safety system. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: The message of this error. ,
Required: True ,
}
string ,
target:
{
Description: The location where the error happened if available. ,
Required: False ,
}
string ,
details:
{
Description: The error details if available. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). ,
Required: False ,
}
{
code:
{
Description: Inner error codes as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). ,
Enum:
{
invalidPayload: The request data is invalid for this operation. ,
}
,
Required: False ,
}
enum ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
Batch_Create (new)
Description :  Creates and executes a batch from an uploaded file of requests. Response includes details of the enqueued job including job status. The ID of the result file is added to the response once complete.
Reference :  Link ¶

⚼ Request

POST:  /batches
{
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
createBatchRequest:
{
Description: The specification of the batch to create and execute. ,
Required: True ,
}
{
input_file_id:
{
Description: The ID if the input file for the batch. ,
Required: True ,
}
string ,
endpoint:
{
Description: The API endpoint used by the batch. ,
Required: True ,
}
string ,
completion_window:
{
Description: The time frame within which the batch should be processed. ,
Required: True ,
}
string ,
metadata:
{
Description: A set of key-value pairs that can be attached to the batch. This can be useful for storing additional information about the batch in a structured format. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (201)

{
$headers:
{
deployment-enqueued-tokens:
{
Description: Sum of enqueued tokens of all jobs that target to the deployment. ,
}
integer ,
deployment-maximum-enqueued-tokens:
{
Description: Maximum enqueued tokens of the deployment. ,
}
integer ,
}
,
$schema:
{
Description: Defines the values of a batch. ,
}
{
id:
{
Description: The identity of this item. ,
Required: True ,
}
string ,
object:
{
Description: Defines the type of an object. ,
Enum:
{
list: This object represents a list of other objects. ,
fine_tuning.job: This object represents a fine tune job. ,
file: This object represents a file. ,
fine_tuning.job.event: This object represents an event of a fine tuning job. ,
fine_tuning.job.checkpoint: This object represents a checkpoint of a fine tuning job. ,
model: This object represents a model (can be a base model or fine tune job result). ,
upload: This object represents a file upload. ,
upload.part: This object represents part of a file upload. ,
batch: This object represents a batch. ,
}
,
Required: False ,
}
enum ,
endpoint:
{
Description: The API endpoint used by the batch. ,
Required: False ,
}
string ,
errors:
{
Description: For batches that have failed, this will contain more information on the cause of the failures. ,
Required: False ,
}
{
object:
{
Description: The type of the errors object. This is always 'list'. ,
Required: False ,
}
string ,
data:
{
Description: Error information for a failure in batch. ,
Required: False ,
}
{
code:
{
Description: An error code identifying the error type. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable message providing more details about the error. ,
Required: False ,
}
string ,
param:
{
Description: The name of the parameter that caused the error, if applicable (can be null). ,
Required: False ,
}
string ,
line:
{
Description: The line number of the input file where the error occurred, if applicable (can be null). ,
Required: False ,
}
string ,
}
,
}
,
input_file_id:
{
Description: The ID of the input file for the batch. ,
Required: True ,
}
string ,
completion_window:
{
Description: The time frame within which the batch should be processed. ,
Required: False ,
}
string ,
status:
{
Description: The status of a batch. ,
Enum:
{
validating: The input file is being validated before the batch can begin. ,
failed: The input file has failed the validation process. ,
in_progress: The input file was successfully validated and the batch is currently being executed. ,
finalizing: The batch has completed and the results are being prepared. ,
completed: The batch has been completed and the results are ready. ,
expired: The batch was not able to complete within the 24-hour time window. ,
cancelling: Cancellation of the batch has been initiated. ,
cancelled: The batch was cancelled. ,
}
,
Required: False ,
}
enum ,
output_file_id:
{
Description: The ID of the file containing outputs of successfully executed requests. ,
Required: False ,
}
string ,
error_file_id:
{
Description: The ID of the file containing outputs of requests with errors. ,
Required: False ,
}
string ,
created_at:
{
Description: A timestamp when this batch was created (in unix epochs). ,
Format: unixtime ,
Required: False ,
}
integer ,
in_progress_at:
{
Description: A timestamp when this batch started progressing (in unix epochs). ,
Format: unixtime ,
Required: False ,
}
integer ,
expires_at:
{
Description: A timestamp when this batch will expire (in unix epochs). ,
Format: unixtime ,
Required: False ,
}
integer ,
finalizing_at:
{
Description: A timestamp when this batch started finalizing (in unix epochs). ,
Format: unixtime ,
Required: False ,
}
integer ,
completed_at:
{
Description: A timestamp when this batch was completed (in unix epochs). ,
Format: unixtime ,
Required: False ,
}
integer ,
failed_at:
{
Description: A timestamp when this batch failed (in unix epochs). ,
Format: unixtime ,
Required: False ,
}
integer ,
expired_at:
{
Description: A timestamp when this batch expired (in unix epochs). ,
Format: unixtime ,
Required: False ,
}
integer ,
cancelling_at:
{
Description: A timestamp when this batch started cancelling (in unix epochs). ,
Format: unixtime ,
Required: False ,
}
integer ,
cancelled_at:
{
Description: A timestamp when this batch was cancelled (in unix epochs). ,
Format: unixtime ,
Required: False ,
}
integer ,
request_counts:
{
Description: The request counts for different statuses within the batch. ,
Required: False ,
}
{
total:
{
Description: The total number of requests in the batch. ,
Required: False ,
}
integer ,
completed:
{
Description: The number of requests in the batch that have been completed successfully. ,
Required: False ,
}
integer ,
failed:
{
Description: The number of requests in the batch that have failed. ,
Required: False ,
}
integer ,
}
,
metadata:
{
Description: A set of key-value pairs that can be attached to the batch. This can be useful for storing additional information about the batch in a structured format. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error content as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). ,
Required: True ,
}
{
code:
{
Description: Error codes as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). ,
Enum:
{
conflict: The requested operation conflicts with the current resource state. ,
invalidPayload: The request data is invalid for this operation. ,
forbidden: The operation is forbidden for the current user/api key. ,
notFound: The resource is not found. ,
unexpectedEntityState: The operation cannot be executed in the current resource's state. ,
itemDoesAlreadyExist: The item does already exist. ,
serviceUnavailable: The service is currently not available. ,
internalFailure: Internal error. Please retry. ,
quotaExceeded: Quota exceeded. ,
jsonlValidationFailed: Validation of jsonl data failed. ,
fileImportFailed: Import of file failed. ,
tooManyRequests: Too many requests. Please retry later. ,
unauthorized: The current user/api key is not authorized for the operation. ,
contentFilter: Image generation failed as a result of our safety system. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: The message of this error. ,
Required: True ,
}
string ,
target:
{
Description: The location where the error happened if available. ,
Required: False ,
}
string ,
details:
{
Description: The error details if available. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). ,
Required: False ,
}
{
code:
{
Description: Inner error codes as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). ,
Enum:
{
invalidPayload: The request data is invalid for this operation. ,
}
,
Required: False ,
}
enum ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
Batch_Get (new)
Description :  Gets details for a single batch specified by the given batch-id.
Reference :  Link ¶

⚼ Request

GET:  /batches/{batch-id}
{
batch-id:
{
Description: The identifier of the batch. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The identity of this item. ,
Required: True ,
}
string ,
object:
{
Description: Defines the type of an object. ,
Enum:
{
list: This object represents a list of other objects. ,
fine_tuning.job: This object represents a fine tune job. ,
file: This object represents a file. ,
fine_tuning.job.event: This object represents an event of a fine tuning job. ,
fine_tuning.job.checkpoint: This object represents a checkpoint of a fine tuning job. ,
model: This object represents a model (can be a base model or fine tune job result). ,
upload: This object represents a file upload. ,
upload.part: This object represents part of a file upload. ,
batch: This object represents a batch. ,
}
,
Required: False ,
}
enum ,
endpoint:
{
Description: The API endpoint used by the batch. ,
Required: False ,
}
string ,
errors:
{
Description: For batches that have failed, this will contain more information on the cause of the failures. ,
Required: False ,
}
{
object:
{
Description: The type of the errors object. This is always 'list'. ,
Required: False ,
}
string ,
data:
{
Description: Error information for a failure in batch. ,
Required: False ,
}
{
code:
{
Description: An error code identifying the error type. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable message providing more details about the error. ,
Required: False ,
}
string ,
param:
{
Description: The name of the parameter that caused the error, if applicable (can be null). ,
Required: False ,
}
string ,
line:
{
Description: The line number of the input file where the error occurred, if applicable (can be null). ,
Required: False ,
}
string ,
}
,
}
,
input_file_id:
{
Description: The ID of the input file for the batch. ,
Required: True ,
}
string ,
completion_window:
{
Description: The time frame within which the batch should be processed. ,
Required: False ,
}
string ,
status:
{
Description: The status of a batch. ,
Enum:
{
validating: The input file is being validated before the batch can begin. ,
failed: The input file has failed the validation process. ,
in_progress: The input file was successfully validated and the batch is currently being executed. ,
finalizing: The batch has completed and the results are being prepared. ,
completed: The batch has been completed and the results are ready. ,
expired: The batch was not able to complete within the 24-hour time window. ,
cancelling: Cancellation of the batch has been initiated. ,
cancelled: The batch was cancelled. ,
}
,
Required: False ,
}
enum ,
output_file_id:
{
Description: The ID of the file containing outputs of successfully executed requests. ,
Required: False ,
}
string ,
error_file_id:
{
Description: The ID of the file containing outputs of requests with errors. ,
Required: False ,
}
string ,
created_at:
{
Description: A timestamp when this batch was created (in unix epochs). ,
Format: unixtime ,
Required: False ,
}
integer ,
in_progress_at:
{
Description: A timestamp when this batch started progressing (in unix epochs). ,
Format: unixtime ,
Required: False ,
}
integer ,
expires_at:
{
Description: A timestamp when this batch will expire (in unix epochs). ,
Format: unixtime ,
Required: False ,
}
integer ,
finalizing_at:
{
Description: A timestamp when this batch started finalizing (in unix epochs). ,
Format: unixtime ,
Required: False ,
}
integer ,
completed_at:
{
Description: A timestamp when this batch was completed (in unix epochs). ,
Format: unixtime ,
Required: False ,
}
integer ,
failed_at:
{
Description: A timestamp when this batch failed (in unix epochs). ,
Format: unixtime ,
Required: False ,
}
integer ,
expired_at:
{
Description: A timestamp when this batch expired (in unix epochs). ,
Format: unixtime ,
Required: False ,
}
integer ,
cancelling_at:
{
Description: A timestamp when this batch started cancelling (in unix epochs). ,
Format: unixtime ,
Required: False ,
}
integer ,
cancelled_at:
{
Description: A timestamp when this batch was cancelled (in unix epochs). ,
Format: unixtime ,
Required: False ,
}
integer ,
request_counts:
{
Description: The request counts for different statuses within the batch. ,
Required: False ,
}
{
total:
{
Description: The total number of requests in the batch. ,
Required: False ,
}
integer ,
completed:
{
Description: The number of requests in the batch that have been completed successfully. ,
Required: False ,
}
integer ,
failed:
{
Description: The number of requests in the batch that have failed. ,
Required: False ,
}
integer ,
}
,
metadata:
{
Description: A set of key-value pairs that can be attached to the batch. This can be useful for storing additional information about the batch in a structured format. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: Error content as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). ,
Required: True ,
}
{
code:
{
Description: Error codes as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). ,
Enum:
{
conflict: The requested operation conflicts with the current resource state. ,
invalidPayload: The request data is invalid for this operation. ,
forbidden: The operation is forbidden for the current user/api key. ,
notFound: The resource is not found. ,
unexpectedEntityState: The operation cannot be executed in the current resource's state. ,
itemDoesAlreadyExist: The item does already exist. ,
serviceUnavailable: The service is currently not available. ,
internalFailure: Internal error. Please retry. ,
quotaExceeded: Quota exceeded. ,
jsonlValidationFailed: Validation of jsonl data failed. ,
fileImportFailed: Import of file failed. ,
tooManyRequests: Too many requests. Please retry later. ,
unauthorized: The current user/api key is not authorized for the operation. ,
contentFilter: Image generation failed as a result of our safety system. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: The message of this error. ,
Required: True ,
}
string ,
target:
{
Description: The location where the error happened if available. ,
Required: False ,
}
string ,
details:
{
Description: The error details if available. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). ,
Required: False ,
}
{
code:
{
Description: Inner error codes as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). ,
Enum:
{
invalidPayload: The request data is invalid for this operation. ,
}
,
Required: False ,
}
enum ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
Batch_Cancel (new)
Description :  Cancels the processing of the batch specified by the given batch-id.
Reference :  Link ¶

⚼ Request

POST:  /batches/{batch-id}/cancel
{
batch-id:
{
Description: The identifier of the batch. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The identity of this item. ,
Required: True ,
}
string ,
object:
{
Description: Defines the type of an object. ,
Enum:
{
list: This object represents a list of other objects. ,
fine_tuning.job: This object represents a fine tune job. ,
file: This object represents a file. ,
fine_tuning.job.event: This object represents an event of a fine tuning job. ,
fine_tuning.job.checkpoint: This object represents a checkpoint of a fine tuning job. ,
model: This object represents a model (can be a base model or fine tune job result). ,
upload: This object represents a file upload. ,
upload.part: This object represents part of a file upload. ,
batch: This object represents a batch. ,
}
,
Required: False ,
}
enum ,
endpoint:
{
Description: The API endpoint used by the batch. ,
Required: False ,
}
string ,
errors:
{
Description: For batches that have failed, this will contain more information on the cause of the failures. ,
Required: False ,
}
{
object:
{
Description: The type of the errors object. This is always 'list'. ,
Required: False ,
}
string ,
data:
{
Description: Error information for a failure in batch. ,
Required: False ,
}
{
code:
{
Description: An error code identifying the error type. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable message providing more details about the error. ,
Required: False ,
}
string ,
param:
{
Description: The name of the parameter that caused the error, if applicable (can be null). ,
Required: False ,
}
string ,
line:
{
Description: The line number of the input file where the error occurred, if applicable (can be null). ,
Required: False ,
}
string ,
}
,
}
,
input_file_id:
{
Description: The ID of the input file for the batch. ,
Required: True ,
}
string ,
completion_window:
{
Description: The time frame within which the batch should be processed. ,
Required: False ,
}
string ,
status:
{
Description: The status of a batch. ,
Enum:
{
validating: The input file is being validated before the batch can begin. ,
failed: The input file has failed the validation process. ,
in_progress: The input file was successfully validated and the batch is currently being executed. ,
finalizing: The batch has completed and the results are being prepared. ,
completed: The batch has been completed and the results are ready. ,
expired: The batch was not able to complete within the 24-hour time window. ,
cancelling: Cancellation of the batch has been initiated. ,
cancelled: The batch was cancelled. ,
}
,
Required: False ,
}
enum ,
output_file_id:
{
Description: The ID of the file containing outputs of successfully executed requests. ,
Required: False ,
}
string ,
error_file_id:
{
Description: The ID of the file containing outputs of requests with errors. ,
Required: False ,
}
string ,
created_at:
{
Description: A timestamp when this batch was created (in unix epochs). ,
Format: unixtime ,
Required: False ,
}
integer ,
in_progress_at:
{
Description: A timestamp when this batch started progressing (in unix epochs). ,
Format: unixtime ,
Required: False ,
}
integer ,
expires_at:
{
Description: A timestamp when this batch will expire (in unix epochs). ,
Format: unixtime ,
Required: False ,
}
integer ,
finalizing_at:
{
Description: A timestamp when this batch started finalizing (in unix epochs). ,
Format: unixtime ,
Required: False ,
}
integer ,
completed_at:
{
Description: A timestamp when this batch was completed (in unix epochs). ,
Format: unixtime ,
Required: False ,
}
integer ,
failed_at:
{
Description: A timestamp when this batch failed (in unix epochs). ,
Format: unixtime ,
Required: False ,
}
integer ,
expired_at:
{
Description: A timestamp when this batch expired (in unix epochs). ,
Format: unixtime ,
Required: False ,
}
integer ,
cancelling_at:
{
Description: A timestamp when this batch started cancelling (in unix epochs). ,
Format: unixtime ,
Required: False ,
}
integer ,
cancelled_at:
{
Description: A timestamp when this batch was cancelled (in unix epochs). ,
Format: unixtime ,
Required: False ,
}
integer ,
request_counts:
{
Description: The request counts for different statuses within the batch. ,
Required: False ,
}
{
total:
{
Description: The total number of requests in the batch. ,
Required: False ,
}
integer ,
completed:
{
Description: The number of requests in the batch that have been completed successfully. ,
Required: False ,
}
integer ,
failed:
{
Description: The number of requests in the batch that have failed. ,
Required: False ,
}
integer ,
}
,
metadata:
{
Description: A set of key-value pairs that can be attached to the batch. This can be useful for storing additional information about the batch in a structured format. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: Error content as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). ,
Required: True ,
}
{
code:
{
Description: Error codes as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). ,
Enum:
{
conflict: The requested operation conflicts with the current resource state. ,
invalidPayload: The request data is invalid for this operation. ,
forbidden: The operation is forbidden for the current user/api key. ,
notFound: The resource is not found. ,
unexpectedEntityState: The operation cannot be executed in the current resource's state. ,
itemDoesAlreadyExist: The item does already exist. ,
serviceUnavailable: The service is currently not available. ,
internalFailure: Internal error. Please retry. ,
quotaExceeded: Quota exceeded. ,
jsonlValidationFailed: Validation of jsonl data failed. ,
fileImportFailed: Import of file failed. ,
tooManyRequests: Too many requests. Please retry later. ,
unauthorized: The current user/api key is not authorized for the operation. ,
contentFilter: Image generation failed as a result of our safety system. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: The message of this error. ,
Required: True ,
}
string ,
target:
{
Description: The location where the error happened if available. ,
Required: False ,
}
string ,
details:
{
Description: The error details if available. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). ,
Required: False ,
}
{
code:
{
Description: Inner error codes as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). ,
Enum:
{
invalidPayload: The request data is invalid for this operation. ,
}
,
Required: False ,
}
enum ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
Files_List (new)
Description :  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.
Reference :  Link ¶

⚼ Request

GET:  /files
{
purpose:
{
Description: Only return files with the given purpose. ,
Required: False ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
object:
{
Description: Defines the type of an object. ,
Enum:
{
list: This object represents a list of other objects. ,
fine_tuning.job: This object represents a fine tune job. ,
file: This object represents a file. ,
fine_tuning.job.event: This object represents an event of a fine tuning job. ,
fine_tuning.job.checkpoint: This object represents a checkpoint of a fine tuning job. ,
model: This object represents a model (can be a base model or fine tune job result). ,
upload: This object represents a file upload. ,
upload.part: This object represents part of a file upload. ,
batch: This object represents a batch. ,
}
,
Required: False ,
}
enum ,
data:
{
Description: The list of items. ,
Required: False ,
}
[
{
object:
{
Description: Defines the type of an object. ,
Enum:
{
list: This object represents a list of other objects. ,
fine_tuning.job: This object represents a fine tune job. ,
file: This object represents a file. ,
fine_tuning.job.event: This object represents an event of a fine tuning job. ,
fine_tuning.job.checkpoint: This object represents a checkpoint of a fine tuning job. ,
model: This object represents a model (can be a base model or fine tune job result). ,
upload: This object represents a file upload. ,
upload.part: This object represents part of a file upload. ,
batch: This object represents a batch. ,
}
,
Required: False ,
}
enum ,
created_at:
{
Description: A timestamp when this job or item was created (in unix epochs). ,
Format: unixtime ,
Required: False ,
}
integer ,
id:
{
Description: The identity of this item. ,
Required: False ,
}
string ,
status:
{
Description: The state of a file. ,
Enum:
{
uploaded: The file has been uploaded but it's not yet processed. This state is not returned by Azure OpenAI and exposed only for compatibility. It can be categorized as an inactive state. ,
pending: The operation was created and is not queued to be processed in the future. It can be categorized as an inactive state. ,
running: The operation has started to be processed. It can be categorized as an active state. ,
processed: The operation has successfully be processed and is ready for consumption. It can be categorized as a terminal state. ,
error: The operation has completed processing with a failure and cannot be further consumed. It can be categorized as a terminal state. ,
deleting: The entity is ni the process to be deleted. This state is not returned by Azure OpenAI and exposed only for compatibility. It can be categorized as an active state. ,
deleted: The entity has been deleted but may still be referenced by other entities predating the deletion. It can be categorized as a terminal state. ,
}
,
Required: False ,
}
enum ,
bytes:
{
Description: The size of this file when available (can be null). File sizes larger than 2^53-1 are not supported to ensure compatibility with JavaScript integers. ,
Format: int64 ,
Required: False ,
}
integer ,
purpose:
{
Description: The intended purpose of the uploaded documents. Use "fine-tune" for fine-tuning. This allows us to validate the format of the uploaded file. ,
Enum:
{
fine-tune: This file contains training data for a fine tune job. ,
fine-tune-results: This file contains the results of a fine tune job. ,
assistants: This file contains data to be used in assistants. ,
assistants_output: This file contains the results of an assistant. ,
batch: This file contains the input data for a batch. ,
batch_output: This file contains the results of a batch. ,
}
,
Required: True ,
}
enum ,
filename:
{
Description: The name of the file. ,
Required: True ,
}
string ,
status_details:
{
Description: The error message with details in case processing of this file failed. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Error content as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). ,
Required: True ,
}
{
code:
{
Description: Error codes as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). ,
Enum:
{
conflict: The requested operation conflicts with the current resource state. ,
invalidPayload: The request data is invalid for this operation. ,
forbidden: The operation is forbidden for the current user/api key. ,
notFound: The resource is not found. ,
unexpectedEntityState: The operation cannot be executed in the current resource's state. ,
itemDoesAlreadyExist: The item does already exist. ,
serviceUnavailable: The service is currently not available. ,
internalFailure: Internal error. Please retry. ,
quotaExceeded: Quota exceeded. ,
jsonlValidationFailed: Validation of jsonl data failed. ,
fileImportFailed: Import of file failed. ,
tooManyRequests: Too many requests. Please retry later. ,
unauthorized: The current user/api key is not authorized for the operation. ,
contentFilter: Image generation failed as a result of our safety system. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: The message of this error. ,
Required: True ,
}
string ,
target:
{
Description: The location where the error happened if available. ,
Required: False ,
}
string ,
details:
{
Description: The error details if available. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). ,
Required: False ,
}
{
code:
{
Description: Inner error codes as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). ,
Enum:
{
invalidPayload: The request data is invalid for this operation. ,
}
,
Required: False ,
}
enum ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
Files_Upload (new)
Description :  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.
Reference :  Link ¶

⚼ Request

POST:  /files
{
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
purpose:
{
Description: The intended purpose of the uploaded documents. Use "fine-tune" for fine-tuning. This allows us to validate the format of the uploaded file. ,
Required: True ,
}
string ,
file:
{
Description: Gets or sets the file to upload into Azure OpenAI. ,
Required: True ,
}
file ,
}

⚐ Response (201)

{
$headers:
{
location:
{
Description: The location of the newly created item. ,
}
string ,
}
,
$schema:
{
Description: A file is a document usable for training and validation. It can also be a service generated document with result details. ,
}
{
object:
{
Description: Defines the type of an object. ,
Enum:
{
list: This object represents a list of other objects. ,
fine_tuning.job: This object represents a fine tune job. ,
file: This object represents a file. ,
fine_tuning.job.event: This object represents an event of a fine tuning job. ,
fine_tuning.job.checkpoint: This object represents a checkpoint of a fine tuning job. ,
model: This object represents a model (can be a base model or fine tune job result). ,
upload: This object represents a file upload. ,
upload.part: This object represents part of a file upload. ,
batch: This object represents a batch. ,
}
,
Required: False ,
}
enum ,
created_at:
{
Description: A timestamp when this job or item was created (in unix epochs). ,
Format: unixtime ,
Required: False ,
}
integer ,
id:
{
Description: The identity of this item. ,
Required: False ,
}
string ,
status:
{
Description: The state of a file. ,
Enum:
{
uploaded: The file has been uploaded but it's not yet processed. This state is not returned by Azure OpenAI and exposed only for compatibility. It can be categorized as an inactive state. ,
pending: The operation was created and is not queued to be processed in the future. It can be categorized as an inactive state. ,
running: The operation has started to be processed. It can be categorized as an active state. ,
processed: The operation has successfully be processed and is ready for consumption. It can be categorized as a terminal state. ,
error: The operation has completed processing with a failure and cannot be further consumed. It can be categorized as a terminal state. ,
deleting: The entity is ni the process to be deleted. This state is not returned by Azure OpenAI and exposed only for compatibility. It can be categorized as an active state. ,
deleted: The entity has been deleted but may still be referenced by other entities predating the deletion. It can be categorized as a terminal state. ,
}
,
Required: False ,
}
enum ,
bytes:
{
Description: The size of this file when available (can be null). File sizes larger than 2^53-1 are not supported to ensure compatibility with JavaScript integers. ,
Format: int64 ,
Required: False ,
}
integer ,
purpose:
{
Description: The intended purpose of the uploaded documents. Use "fine-tune" for fine-tuning. This allows us to validate the format of the uploaded file. ,
Enum:
{
fine-tune: This file contains training data for a fine tune job. ,
fine-tune-results: This file contains the results of a fine tune job. ,
assistants: This file contains data to be used in assistants. ,
assistants_output: This file contains the results of an assistant. ,
batch: This file contains the input data for a batch. ,
batch_output: This file contains the results of a batch. ,
}
,
Required: True ,
}
enum ,
filename:
{
Description: The name of the file. ,
Required: True ,
}
string ,
status_details:
{
Description: The error message with details in case processing of this file failed. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error content as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). ,
Required: True ,
}
{
code:
{
Description: Error codes as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). ,
Enum:
{
conflict: The requested operation conflicts with the current resource state. ,
invalidPayload: The request data is invalid for this operation. ,
forbidden: The operation is forbidden for the current user/api key. ,
notFound: The resource is not found. ,
unexpectedEntityState: The operation cannot be executed in the current resource's state. ,
itemDoesAlreadyExist: The item does already exist. ,
serviceUnavailable: The service is currently not available. ,
internalFailure: Internal error. Please retry. ,
quotaExceeded: Quota exceeded. ,
jsonlValidationFailed: Validation of jsonl data failed. ,
fileImportFailed: Import of file failed. ,
tooManyRequests: Too many requests. Please retry later. ,
unauthorized: The current user/api key is not authorized for the operation. ,
contentFilter: Image generation failed as a result of our safety system. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: The message of this error. ,
Required: True ,
}
string ,
target:
{
Description: The location where the error happened if available. ,
Required: False ,
}
string ,
details:
{
Description: The error details if available. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). ,
Required: False ,
}
{
code:
{
Description: Inner error codes as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). ,
Enum:
{
invalidPayload: The request data is invalid for this operation. ,
}
,
Required: False ,
}
enum ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
Files_Import (new)
Description :  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.
Reference :  Link ¶

⚼ Request

POST:  /files/import
{
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
fileImport:
{
Description: The definition of the file to create including its purpose, the file name and the url of the file location. ,
Required: True ,
}
{
purpose:
{
Description: The intended purpose of the uploaded documents. Use "fine-tune" for fine-tuning. This allows us to validate the format of the uploaded file. ,
Enum:
{
fine-tune: This file contains training data for a fine tune job. ,
fine-tune-results: This file contains the results of a fine tune job. ,
assistants: This file contains data to be used in assistants. ,
assistants_output: This file contains the results of an assistant. ,
batch: This file contains the input data for a batch. ,
batch_output: This file contains the results of a batch. ,
}
,
Required: True ,
}
enum ,
filename:
{
Description: The name of the [JSON Lines](https://jsonlines.readthedocs.io/en/latest/) 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. ,
Required: True ,
}
string ,
content_url:
{
Description: The url to download the document from (can be SAS url of a blob or any other external url accessible with a GET request). ,
Format: url ,
Required: True ,
}
string ,
}
,
}

⚐ Response (201)

{
$headers:
{
location:
{
Description: The location of the newly created item. ,
}
string ,
}
,
$schema:
{
Description: A file is a document usable for training and validation. It can also be a service generated document with result details. ,
}
{
object:
{
Description: Defines the type of an object. ,
Enum:
{
list: This object represents a list of other objects. ,
fine_tuning.job: This object represents a fine tune job. ,
file: This object represents a file. ,
fine_tuning.job.event: This object represents an event of a fine tuning job. ,
fine_tuning.job.checkpoint: This object represents a checkpoint of a fine tuning job. ,
model: This object represents a model (can be a base model or fine tune job result). ,
upload: This object represents a file upload. ,
upload.part: This object represents part of a file upload. ,
batch: This object represents a batch. ,
}
,
Required: False ,
}
enum ,
created_at:
{
Description: A timestamp when this job or item was created (in unix epochs). ,
Format: unixtime ,
Required: False ,
}
integer ,
id:
{
Description: The identity of this item. ,
Required: False ,
}
string ,
status:
{
Description: The state of a file. ,
Enum:
{
uploaded: The file has been uploaded but it's not yet processed. This state is not returned by Azure OpenAI and exposed only for compatibility. It can be categorized as an inactive state. ,
pending: The operation was created and is not queued to be processed in the future. It can be categorized as an inactive state. ,
running: The operation has started to be processed. It can be categorized as an active state. ,
processed: The operation has successfully be processed and is ready for consumption. It can be categorized as a terminal state. ,
error: The operation has completed processing with a failure and cannot be further consumed. It can be categorized as a terminal state. ,
deleting: The entity is ni the process to be deleted. This state is not returned by Azure OpenAI and exposed only for compatibility. It can be categorized as an active state. ,
deleted: The entity has been deleted but may still be referenced by other entities predating the deletion. It can be categorized as a terminal state. ,
}
,
Required: False ,
}
enum ,
bytes:
{
Description: The size of this file when available (can be null). File sizes larger than 2^53-1 are not supported to ensure compatibility with JavaScript integers. ,
Format: int64 ,
Required: False ,
}
integer ,
purpose:
{
Description: The intended purpose of the uploaded documents. Use "fine-tune" for fine-tuning. This allows us to validate the format of the uploaded file. ,
Enum:
{
fine-tune: This file contains training data for a fine tune job. ,
fine-tune-results: This file contains the results of a fine tune job. ,
assistants: This file contains data to be used in assistants. ,
assistants_output: This file contains the results of an assistant. ,
batch: This file contains the input data for a batch. ,
batch_output: This file contains the results of a batch. ,
}
,
Required: True ,
}
enum ,
filename:
{
Description: The name of the file. ,
Required: True ,
}
string ,
status_details:
{
Description: The error message with details in case processing of this file failed. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error content as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). ,
Required: True ,
}
{
code:
{
Description: Error codes as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). ,
Enum:
{
conflict: The requested operation conflicts with the current resource state. ,
invalidPayload: The request data is invalid for this operation. ,
forbidden: The operation is forbidden for the current user/api key. ,
notFound: The resource is not found. ,
unexpectedEntityState: The operation cannot be executed in the current resource's state. ,
itemDoesAlreadyExist: The item does already exist. ,
serviceUnavailable: The service is currently not available. ,
internalFailure: Internal error. Please retry. ,
quotaExceeded: Quota exceeded. ,
jsonlValidationFailed: Validation of jsonl data failed. ,
fileImportFailed: Import of file failed. ,
tooManyRequests: Too many requests. Please retry later. ,
unauthorized: The current user/api key is not authorized for the operation. ,
contentFilter: Image generation failed as a result of our safety system. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: The message of this error. ,
Required: True ,
}
string ,
target:
{
Description: The location where the error happened if available. ,
Required: False ,
}
string ,
details:
{
Description: The error details if available. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). ,
Required: False ,
}
{
code:
{
Description: Inner error codes as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). ,
Enum:
{
invalidPayload: The request data is invalid for this operation. ,
}
,
Required: False ,
}
enum ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
Files_Get (new)
Description :  Gets details for a single file specified by the given file-id including status, size, purpose, etc.
Reference :  Link ¶

⚼ Request

GET:  /files/{file-id}
{
file-id:
{
Description: The identifier of the file. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
object:
{
Description: Defines the type of an object. ,
Enum:
{
list: This object represents a list of other objects. ,
fine_tuning.job: This object represents a fine tune job. ,
file: This object represents a file. ,
fine_tuning.job.event: This object represents an event of a fine tuning job. ,
fine_tuning.job.checkpoint: This object represents a checkpoint of a fine tuning job. ,
model: This object represents a model (can be a base model or fine tune job result). ,
upload: This object represents a file upload. ,
upload.part: This object represents part of a file upload. ,
batch: This object represents a batch. ,
}
,
Required: False ,
}
enum ,
created_at:
{
Description: A timestamp when this job or item was created (in unix epochs). ,
Format: unixtime ,
Required: False ,
}
integer ,
id:
{
Description: The identity of this item. ,
Required: False ,
}
string ,
status:
{
Description: The state of a file. ,
Enum:
{
uploaded: The file has been uploaded but it's not yet processed. This state is not returned by Azure OpenAI and exposed only for compatibility. It can be categorized as an inactive state. ,
pending: The operation was created and is not queued to be processed in the future. It can be categorized as an inactive state. ,
running: The operation has started to be processed. It can be categorized as an active state. ,
processed: The operation has successfully be processed and is ready for consumption. It can be categorized as a terminal state. ,
error: The operation has completed processing with a failure and cannot be further consumed. It can be categorized as a terminal state. ,
deleting: The entity is ni the process to be deleted. This state is not returned by Azure OpenAI and exposed only for compatibility. It can be categorized as an active state. ,
deleted: The entity has been deleted but may still be referenced by other entities predating the deletion. It can be categorized as a terminal state. ,
}
,
Required: False ,
}
enum ,
bytes:
{
Description: The size of this file when available (can be null). File sizes larger than 2^53-1 are not supported to ensure compatibility with JavaScript integers. ,
Format: int64 ,
Required: False ,
}
integer ,
purpose:
{
Description: The intended purpose of the uploaded documents. Use "fine-tune" for fine-tuning. This allows us to validate the format of the uploaded file. ,
Enum:
{
fine-tune: This file contains training data for a fine tune job. ,
fine-tune-results: This file contains the results of a fine tune job. ,
assistants: This file contains data to be used in assistants. ,
assistants_output: This file contains the results of an assistant. ,
batch: This file contains the input data for a batch. ,
batch_output: This file contains the results of a batch. ,
}
,
Required: True ,
}
enum ,
filename:
{
Description: The name of the file. ,
Required: True ,
}
string ,
status_details:
{
Description: The error message with details in case processing of this file failed. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error content as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). ,
Required: True ,
}
{
code:
{
Description: Error codes as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). ,
Enum:
{
conflict: The requested operation conflicts with the current resource state. ,
invalidPayload: The request data is invalid for this operation. ,
forbidden: The operation is forbidden for the current user/api key. ,
notFound: The resource is not found. ,
unexpectedEntityState: The operation cannot be executed in the current resource's state. ,
itemDoesAlreadyExist: The item does already exist. ,
serviceUnavailable: The service is currently not available. ,
internalFailure: Internal error. Please retry. ,
quotaExceeded: Quota exceeded. ,
jsonlValidationFailed: Validation of jsonl data failed. ,
fileImportFailed: Import of file failed. ,
tooManyRequests: Too many requests. Please retry later. ,
unauthorized: The current user/api key is not authorized for the operation. ,
contentFilter: Image generation failed as a result of our safety system. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: The message of this error. ,
Required: True ,
}
string ,
target:
{
Description: The location where the error happened if available. ,
Required: False ,
}
string ,
details:
{
Description: The error details if available. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). ,
Required: False ,
}
{
code:
{
Description: Inner error codes as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). ,
Enum:
{
invalidPayload: The request data is invalid for this operation. ,
}
,
Required: False ,
}
enum ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
Files_Delete (new)
Description :  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.
Reference :  Link ¶

⚼ Request

DELETE:  /files/{file-id}
{
file-id:
{
Description: The identifier of the file. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
object:
{
Description: The file object. ,
Required: True ,
}
string ,
deleted:
{
Description: A value indicating whether the file was deleted. ,
Required: True ,
}
boolean ,
id:
{
Description: The file-id that was deleted. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error content as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). ,
Required: True ,
}
{
code:
{
Description: Error codes as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). ,
Enum:
{
conflict: The requested operation conflicts with the current resource state. ,
invalidPayload: The request data is invalid for this operation. ,
forbidden: The operation is forbidden for the current user/api key. ,
notFound: The resource is not found. ,
unexpectedEntityState: The operation cannot be executed in the current resource's state. ,
itemDoesAlreadyExist: The item does already exist. ,
serviceUnavailable: The service is currently not available. ,
internalFailure: Internal error. Please retry. ,
quotaExceeded: Quota exceeded. ,
jsonlValidationFailed: Validation of jsonl data failed. ,
fileImportFailed: Import of file failed. ,
tooManyRequests: Too many requests. Please retry later. ,
unauthorized: The current user/api key is not authorized for the operation. ,
contentFilter: Image generation failed as a result of our safety system. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: The message of this error. ,
Required: True ,
}
string ,
target:
{
Description: The location where the error happened if available. ,
Required: False ,
}
string ,
details:
{
Description: The error details if available. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). ,
Required: False ,
}
{
code:
{
Description: Inner error codes as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). ,
Enum:
{
invalidPayload: The request data is invalid for this operation. ,
}
,
Required: False ,
}
enum ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
Files_GetContent (new)
Description :  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.
Reference :  Link ¶

⚼ Request

GET:  /files/{file-id}/content
{
file-id:
{
Description: The identifier of the file. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: file ,
}

⚐ Response (default)

{
error:
{
Description: Error content as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). ,
Required: True ,
}
{
code:
{
Description: Error codes as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). ,
Enum:
{
conflict: The requested operation conflicts with the current resource state. ,
invalidPayload: The request data is invalid for this operation. ,
forbidden: The operation is forbidden for the current user/api key. ,
notFound: The resource is not found. ,
unexpectedEntityState: The operation cannot be executed in the current resource's state. ,
itemDoesAlreadyExist: The item does already exist. ,
serviceUnavailable: The service is currently not available. ,
internalFailure: Internal error. Please retry. ,
quotaExceeded: Quota exceeded. ,
jsonlValidationFailed: Validation of jsonl data failed. ,
fileImportFailed: Import of file failed. ,
tooManyRequests: Too many requests. Please retry later. ,
unauthorized: The current user/api key is not authorized for the operation. ,
contentFilter: Image generation failed as a result of our safety system. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: The message of this error. ,
Required: True ,
}
string ,
target:
{
Description: The location where the error happened if available. ,
Required: False ,
}
string ,
details:
{
Description: The error details if available. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). ,
Required: False ,
}
{
code:
{
Description: Inner error codes as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). ,
Enum:
{
invalidPayload: The request data is invalid for this operation. ,
}
,
Required: False ,
}
enum ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
FineTuning_List (new)
Description :  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.
Reference :  Link ¶

⚼ Request

GET:  /fine_tuning/jobs
{
after:
{
Description: Identifier for the last event from the previous pagination request. ,
Required: False ,
}
string ,
limit:
{
Description: Number of events to retrieve. Defaults to 20. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
object:
{
Description: Defines the type of an object. ,
Enum:
{
list: This object represents a list of other objects. ,
fine_tuning.job: This object represents a fine tune job. ,
file: This object represents a file. ,
fine_tuning.job.event: This object represents an event of a fine tuning job. ,
fine_tuning.job.checkpoint: This object represents a checkpoint of a fine tuning job. ,
model: This object represents a model (can be a base model or fine tune job result). ,
upload: This object represents a file upload. ,
upload.part: This object represents part of a file upload. ,
batch: This object represents a batch. ,
}
,
Required: False ,
}
enum ,
data:
{
Description: The list of items. ,
Required: False ,
}
[
{
object:
{
Description: Defines the type of an object. ,
Enum:
{
list: This object represents a list of other objects. ,
fine_tuning.job: This object represents a fine tune job. ,
file: This object represents a file. ,
fine_tuning.job.event: This object represents an event of a fine tuning job. ,
fine_tuning.job.checkpoint: This object represents a checkpoint of a fine tuning job. ,
model: This object represents a model (can be a base model or fine tune job result). ,
upload: This object represents a file upload. ,
upload.part: This object represents part of a file upload. ,
batch: This object represents a batch. ,
}
,
Required: False ,
}
enum ,
created_at:
{
Description: A timestamp when this job or item was created (in unix epochs). ,
Format: unixtime ,
Required: False ,
}
integer ,
id:
{
Description: The identity of this item. ,
Required: False ,
}
string ,
status:
{
Description: The state of a finetunes object or fine tuning job. ,
Enum:
{
created: The operation was created. This state is not returned by Azure OpenAI and exposed only for compatibility. It can be categorized as an inactive state. ,
pending: The operation is not yet queued to be processed in the future. It can be categorized as an inactive state. ,
running: The operation has started to be processed. It can be categorized as an active state. ,
succeeded: The operation has successfully be processed and is ready for consumption. It can be categorized as a terminal state. ,
cancelled: The operation has been cancelled and is incomplete. It can be categorized as a terminal state. ,
failed: The operation has completed processing with a failure and cannot be further consumed. It can be categorized as a terminal state. ,
}
,
Required: False ,
}
enum ,
model:
{
Description: The identifier (model-id) of the base model used for the fine-tune. ,
Required: True ,
}
string ,
fine_tuned_model:
{
Description: The identifier (model-id) of the resulting fine tuned model. This property is only populated for successfully completed fine-tune runs. Use this identifier to create a deployment for inferencing. ,
Required: False ,
}
string ,
training_file:
{
Description: The file which is used for training. ,
Required: True ,
}
string ,
validation_file:
{
Description: The file which is used to evaluate the fine tuned model during training. ,
Required: False ,
}
string ,
result_files:
{
Description: The result file identities (file-id) containing training and evaluation metrics in csv format. The file is only available for successfully completed fine-tune runs. ,
Required: False ,
}
[
string ,
]
,
finished_at:
{
Description: A timestamp when this job or item has finished successfully (in unix epochs). ,
Format: int32 ,
Required: False ,
}
integer ,
organisation_id:
{
Description: The organisation id of this fine tune job. Unused on Azure OpenAI; compatibility for OpenAI only. ,
Required: False ,
}
string ,
trained_tokens:
{
Description: The total number of billable tokens processed by this fine tuning job. ,
Format: int32 ,
Required: False ,
}
integer ,
error:
{
Description: For fine-tuning jobs that have failed, this will contain more information on the cause of the failure. ,
Required: False ,
}
{
code:
{
Description: The machine-readable error code.. ,
Required: False ,
}
string ,
message:
{
Description: The human-readable error message. ,
Required: False ,
}
string ,
param:
{
Description: The parameter that was invalid, usually training_file or validation_file. This field will be null if the failure was not parameter-specific. ,
Required: False ,
}
string ,
}
,
estimated_finish:
{
Description: The Unix timestamp (in seconds) for when the fine-tuning job is estimated to finish. The value will be null if the fine-tuning job is not running. ,
Format: int32 ,
Required: False ,
}
integer ,
hyperparameters:
{
Description: The hyper parameter settings used in a fine tune job. ,
Required: False ,
}
{
n_epochs:
{
Description: The number of epochs to train the model for. An epoch refers to one full cycle through the training dataset. ,
Format: int32 ,
Required: False ,
}
integer ,
batch_size:
{
Description: The batch size to use for training. The batch size is the number of training examples used to train a single forward and backward pass. In general, we've found that larger batch sizes tend to work better for larger datasets. The default value as well as the maximum value for this property are specific to a base model. ,
Format: int32 ,
Required: False ,
}
integer ,
learning_rate_multiplier:
{
Description: The learning rate multiplier to use for training. The fine-tuning learning rate is the original learning rate used for pre-training multiplied by this value. Larger learning rates tend to perform better with larger batch sizes. We recommend experimenting with values in the range 0.02 to 0.2 to see what produces the best results. ,
Format: double ,
Required: False ,
}
number ,
}
,
suffix:
{
Description: The suffix used to identify the fine-tuned model. The suffix can contain up to 40 characters (a-z, A-Z, 0-9,- and _) that will be added to your fine-tuned model name. ,
Required: False ,
}
string ,
seed:
{
Description: The seed used for the finetuning job. ,
Format: int32 ,
Required: False ,
}
integer ,
integrations:
{
Description: A list configurations for integrations supporting the fine-tuning job. There are many integrations planned, so make sure to check and act on the integration type. ,
Required: False ,
}
[
{
type:
{
Description: List of Fine Tune integrations available. ,
Enum:
{
wandb: No description available. ,
}
,
Required: True ,
}
enum ,
wandb:
{
Required: True ,
}
{
project:
{
Required: True ,
}
string ,
name:
{
Required: False ,
}
string ,
entity:
{
Required: False ,
}
string ,
tags:
{
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}
,
]
,
has_more:
{
Description: A value indicating whether the list contains more elements than returned. ,
Required: False ,
}
boolean ,
}

⚐ Response (default)

{
error:
{
Description: Error content as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). ,
Required: True ,
}
{
code:
{
Description: Error codes as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). ,
Enum:
{
conflict: The requested operation conflicts with the current resource state. ,
invalidPayload: The request data is invalid for this operation. ,
forbidden: The operation is forbidden for the current user/api key. ,
notFound: The resource is not found. ,
unexpectedEntityState: The operation cannot be executed in the current resource's state. ,
itemDoesAlreadyExist: The item does already exist. ,
serviceUnavailable: The service is currently not available. ,
internalFailure: Internal error. Please retry. ,
quotaExceeded: Quota exceeded. ,
jsonlValidationFailed: Validation of jsonl data failed. ,
fileImportFailed: Import of file failed. ,
tooManyRequests: Too many requests. Please retry later. ,
unauthorized: The current user/api key is not authorized for the operation. ,
contentFilter: Image generation failed as a result of our safety system. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: The message of this error. ,
Required: True ,
}
string ,
target:
{
Description: The location where the error happened if available. ,
Required: False ,
}
string ,
details:
{
Description: The error details if available. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). ,
Required: False ,
}
{
code:
{
Description: Inner error codes as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). ,
Enum:
{
invalidPayload: The request data is invalid for this operation. ,
}
,
Required: False ,
}
enum ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
FineTuning_Create (new)
Description :  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.
Reference :  Link ¶

⚼ Request

POST:  /fine_tuning/jobs
{
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
fineTuningJob:
{
Description: The specification of the fine-tuned model to create. Required parameters are the base model and the training file to use. Optionally a validation file can be specified to compute validation metrics during training. Hyper parameters will be set to default values or can be optionally specified. These include batch size, learning rate multiplier, number of epochs and others. ,
Required: True ,
}
{
model:
{
Description: The identifier (model-id) of the base model used for this fine-tune. ,
Required: True ,
}
string ,
training_file:
{
Description: The file identity (file-id) that is used for training this fine tuned model. ,
Required: True ,
}
string ,
validation_file:
{
Description: The file identity (file-id) that is used to evaluate the fine tuned model during training. ,
Required: False ,
}
string ,
hyperparameters:
{
Description: The hyper parameter settings used in a fine tune job. ,
Required: False ,
}
{
n_epochs:
{
Description: The number of epochs to train the model for. An epoch refers to one full cycle through the training dataset. ,
Format: int32 ,
Required: False ,
}
integer ,
batch_size:
{
Description: The batch size to use for training. The batch size is the number of training examples used to train a single forward and backward pass. In general, we've found that larger batch sizes tend to work better for larger datasets. The default value as well as the maximum value for this property are specific to a base model. ,
Format: int32 ,
Required: False ,
}
integer ,
learning_rate_multiplier:
{
Description: The learning rate multiplier to use for training. The fine-tuning learning rate is the original learning rate used for pre-training multiplied by this value. Larger learning rates tend to perform better with larger batch sizes. We recommend experimenting with values in the range 0.02 to 0.2 to see what produces the best results. ,
Format: double ,
Required: False ,
}
number ,
}
,
suffix:
{
Description: The suffix used to identify the fine-tuned model. The suffix can contain up to 40 characters (a-z, A-Z, 0-9,- and _) that will be added to your fine-tuned model name. ,
Required: False ,
}
string ,
seed:
{
Description: The seed used for the finetuning job. Passing in the same seed and job parameters should produce the same results, but may differ in rare cases. If a seed is not specified, one will be generated for you. ,
Format: int32 ,
Required: False ,
}
integer ,
integrations:
{
Description: A list configurations for integrations supporting the fine-tuning job. There are many integrations planned, so make sure to check and act on the integration type. ,
Required: False ,
}
[
{
type:
{
Description: List of Fine Tune integrations available. ,
Enum:
{
wandb: No description available. ,
}
,
Required: True ,
}
enum ,
wandb:
{
Required: True ,
}
{
project:
{
Required: True ,
}
string ,
name:
{
Required: False ,
}
string ,
entity:
{
Required: False ,
}
string ,
tags:
{
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}
,
}

⚐ Response (201)

{
$headers:
{
location:
{
Description: The location of the newly created item. ,
}
string ,
}
,
$schema:
{
Description: Defines the values of a fine tune job. ,
}
{
object:
{
Description: Defines the type of an object. ,
Enum:
{
list: This object represents a list of other objects. ,
fine_tuning.job: This object represents a fine tune job. ,
file: This object represents a file. ,
fine_tuning.job.event: This object represents an event of a fine tuning job. ,
fine_tuning.job.checkpoint: This object represents a checkpoint of a fine tuning job. ,
model: This object represents a model (can be a base model or fine tune job result). ,
upload: This object represents a file upload. ,
upload.part: This object represents part of a file upload. ,
batch: This object represents a batch. ,
}
,
Required: False ,
}
enum ,
created_at:
{
Description: A timestamp when this job or item was created (in unix epochs). ,
Format: unixtime ,
Required: False ,
}
integer ,
id:
{
Description: The identity of this item. ,
Required: False ,
}
string ,
status:
{
Description: The state of a finetunes object or fine tuning job. ,
Enum:
{
created: The operation was created. This state is not returned by Azure OpenAI and exposed only for compatibility. It can be categorized as an inactive state. ,
pending: The operation is not yet queued to be processed in the future. It can be categorized as an inactive state. ,
running: The operation has started to be processed. It can be categorized as an active state. ,
succeeded: The operation has successfully be processed and is ready for consumption. It can be categorized as a terminal state. ,
cancelled: The operation has been cancelled and is incomplete. It can be categorized as a terminal state. ,
failed: The operation has completed processing with a failure and cannot be further consumed. It can be categorized as a terminal state. ,
}
,
Required: False ,
}
enum ,
model:
{
Description: The identifier (model-id) of the base model used for the fine-tune. ,
Required: True ,
}
string ,
fine_tuned_model:
{
Description: The identifier (model-id) of the resulting fine tuned model. This property is only populated for successfully completed fine-tune runs. Use this identifier to create a deployment for inferencing. ,
Required: False ,
}
string ,
training_file:
{
Description: The file which is used for training. ,
Required: True ,
}
string ,
validation_file:
{
Description: The file which is used to evaluate the fine tuned model during training. ,
Required: False ,
}
string ,
result_files:
{
Description: The result file identities (file-id) containing training and evaluation metrics in csv format. The file is only available for successfully completed fine-tune runs. ,
Required: False ,
}
[
string ,
]
,
finished_at:
{
Description: A timestamp when this job or item has finished successfully (in unix epochs). ,
Format: int32 ,
Required: False ,
}
integer ,
organisation_id:
{
Description: The organisation id of this fine tune job. Unused on Azure OpenAI; compatibility for OpenAI only. ,
Required: False ,
}
string ,
trained_tokens:
{
Description: The total number of billable tokens processed by this fine tuning job. ,
Format: int32 ,
Required: False ,
}
integer ,
error:
{
Description: For fine-tuning jobs that have failed, this will contain more information on the cause of the failure. ,
Required: False ,
}
{
code:
{
Description: The machine-readable error code.. ,
Required: False ,
}
string ,
message:
{
Description: The human-readable error message. ,
Required: False ,
}
string ,
param:
{
Description: The parameter that was invalid, usually training_file or validation_file. This field will be null if the failure was not parameter-specific. ,
Required: False ,
}
string ,
}
,
estimated_finish:
{
Description: The Unix timestamp (in seconds) for when the fine-tuning job is estimated to finish. The value will be null if the fine-tuning job is not running. ,
Format: int32 ,
Required: False ,
}
integer ,
hyperparameters:
{
Description: The hyper parameter settings used in a fine tune job. ,
Required: False ,
}
{
n_epochs:
{
Description: The number of epochs to train the model for. An epoch refers to one full cycle through the training dataset. ,
Format: int32 ,
Required: False ,
}
integer ,
batch_size:
{
Description: The batch size to use for training. The batch size is the number of training examples used to train a single forward and backward pass. In general, we've found that larger batch sizes tend to work better for larger datasets. The default value as well as the maximum value for this property are specific to a base model. ,
Format: int32 ,
Required: False ,
}
integer ,
learning_rate_multiplier:
{
Description: The learning rate multiplier to use for training. The fine-tuning learning rate is the original learning rate used for pre-training multiplied by this value. Larger learning rates tend to perform better with larger batch sizes. We recommend experimenting with values in the range 0.02 to 0.2 to see what produces the best results. ,
Format: double ,
Required: False ,
}
number ,
}
,
suffix:
{
Description: The suffix used to identify the fine-tuned model. The suffix can contain up to 40 characters (a-z, A-Z, 0-9,- and _) that will be added to your fine-tuned model name. ,
Required: False ,
}
string ,
seed:
{
Description: The seed used for the finetuning job. ,
Format: int32 ,
Required: False ,
}
integer ,
integrations:
{
Description: A list configurations for integrations supporting the fine-tuning job. There are many integrations planned, so make sure to check and act on the integration type. ,
Required: False ,
}
[
{
type:
{
Description: List of Fine Tune integrations available. ,
Enum:
{
wandb: No description available. ,
}
,
Required: True ,
}
enum ,
wandb:
{
Required: True ,
}
{
project:
{
Required: True ,
}
string ,
name:
{
Required: False ,
}
string ,
entity:
{
Required: False ,
}
string ,
tags:
{
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error content as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). ,
Required: True ,
}
{
code:
{
Description: Error codes as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). ,
Enum:
{
conflict: The requested operation conflicts with the current resource state. ,
invalidPayload: The request data is invalid for this operation. ,
forbidden: The operation is forbidden for the current user/api key. ,
notFound: The resource is not found. ,
unexpectedEntityState: The operation cannot be executed in the current resource's state. ,
itemDoesAlreadyExist: The item does already exist. ,
serviceUnavailable: The service is currently not available. ,
internalFailure: Internal error. Please retry. ,
quotaExceeded: Quota exceeded. ,
jsonlValidationFailed: Validation of jsonl data failed. ,
fileImportFailed: Import of file failed. ,
tooManyRequests: Too many requests. Please retry later. ,
unauthorized: The current user/api key is not authorized for the operation. ,
contentFilter: Image generation failed as a result of our safety system. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: The message of this error. ,
Required: True ,
}
string ,
target:
{
Description: The location where the error happened if available. ,
Required: False ,
}
string ,
details:
{
Description: The error details if available. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). ,
Required: False ,
}
{
code:
{
Description: Inner error codes as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). ,
Enum:
{
invalidPayload: The request data is invalid for this operation. ,
}
,
Required: False ,
}
enum ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
FineTuning_Get (new)
Description :  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.
Reference :  Link ¶

⚼ Request

GET:  /fine_tuning/jobs/{fine-tuning-job-id}
{
fine-tuning-job-id:
{
Description: The identifier of the fine-tune job. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
object:
{
Description: Defines the type of an object. ,
Enum:
{
list: This object represents a list of other objects. ,
fine_tuning.job: This object represents a fine tune job. ,
file: This object represents a file. ,
fine_tuning.job.event: This object represents an event of a fine tuning job. ,
fine_tuning.job.checkpoint: This object represents a checkpoint of a fine tuning job. ,
model: This object represents a model (can be a base model or fine tune job result). ,
upload: This object represents a file upload. ,
upload.part: This object represents part of a file upload. ,
batch: This object represents a batch. ,
}
,
Required: False ,
}
enum ,
created_at:
{
Description: A timestamp when this job or item was created (in unix epochs). ,
Format: unixtime ,
Required: False ,
}
integer ,
id:
{
Description: The identity of this item. ,
Required: False ,
}
string ,
status:
{
Description: The state of a finetunes object or fine tuning job. ,
Enum:
{
created: The operation was created. This state is not returned by Azure OpenAI and exposed only for compatibility. It can be categorized as an inactive state. ,
pending: The operation is not yet queued to be processed in the future. It can be categorized as an inactive state. ,
running: The operation has started to be processed. It can be categorized as an active state. ,
succeeded: The operation has successfully be processed and is ready for consumption. It can be categorized as a terminal state. ,
cancelled: The operation has been cancelled and is incomplete. It can be categorized as a terminal state. ,
failed: The operation has completed processing with a failure and cannot be further consumed. It can be categorized as a terminal state. ,
}
,
Required: False ,
}
enum ,
model:
{
Description: The identifier (model-id) of the base model used for the fine-tune. ,
Required: True ,
}
string ,
fine_tuned_model:
{
Description: The identifier (model-id) of the resulting fine tuned model. This property is only populated for successfully completed fine-tune runs. Use this identifier to create a deployment for inferencing. ,
Required: False ,
}
string ,
training_file:
{
Description: The file which is used for training. ,
Required: True ,
}
string ,
validation_file:
{
Description: The file which is used to evaluate the fine tuned model during training. ,
Required: False ,
}
string ,
result_files:
{
Description: The result file identities (file-id) containing training and evaluation metrics in csv format. The file is only available for successfully completed fine-tune runs. ,
Required: False ,
}
[
string ,
]
,
finished_at:
{
Description: A timestamp when this job or item has finished successfully (in unix epochs). ,
Format: int32 ,
Required: False ,
}
integer ,
organisation_id:
{
Description: The organisation id of this fine tune job. Unused on Azure OpenAI; compatibility for OpenAI only. ,
Required: False ,
}
string ,
trained_tokens:
{
Description: The total number of billable tokens processed by this fine tuning job. ,
Format: int32 ,
Required: False ,
}
integer ,
error:
{
Description: For fine-tuning jobs that have failed, this will contain more information on the cause of the failure. ,
Required: False ,
}
{
code:
{
Description: The machine-readable error code.. ,
Required: False ,
}
string ,
message:
{
Description: The human-readable error message. ,
Required: False ,
}
string ,
param:
{
Description: The parameter that was invalid, usually training_file or validation_file. This field will be null if the failure was not parameter-specific. ,
Required: False ,
}
string ,
}
,
estimated_finish:
{
Description: The Unix timestamp (in seconds) for when the fine-tuning job is estimated to finish. The value will be null if the fine-tuning job is not running. ,
Format: int32 ,
Required: False ,
}
integer ,
hyperparameters:
{
Description: The hyper parameter settings used in a fine tune job. ,
Required: False ,
}
{
n_epochs:
{
Description: The number of epochs to train the model for. An epoch refers to one full cycle through the training dataset. ,
Format: int32 ,
Required: False ,
}
integer ,
batch_size:
{
Description: The batch size to use for training. The batch size is the number of training examples used to train a single forward and backward pass. In general, we've found that larger batch sizes tend to work better for larger datasets. The default value as well as the maximum value for this property are specific to a base model. ,
Format: int32 ,
Required: False ,
}
integer ,
learning_rate_multiplier:
{
Description: The learning rate multiplier to use for training. The fine-tuning learning rate is the original learning rate used for pre-training multiplied by this value. Larger learning rates tend to perform better with larger batch sizes. We recommend experimenting with values in the range 0.02 to 0.2 to see what produces the best results. ,
Format: double ,
Required: False ,
}
number ,
}
,
suffix:
{
Description: The suffix used to identify the fine-tuned model. The suffix can contain up to 40 characters (a-z, A-Z, 0-9,- and _) that will be added to your fine-tuned model name. ,
Required: False ,
}
string ,
seed:
{
Description: The seed used for the finetuning job. ,
Format: int32 ,
Required: False ,
}
integer ,
integrations:
{
Description: A list configurations for integrations supporting the fine-tuning job. There are many integrations planned, so make sure to check and act on the integration type. ,
Required: False ,
}
[
{
type:
{
Description: List of Fine Tune integrations available. ,
Enum:
{
wandb: No description available. ,
}
,
Required: True ,
}
enum ,
wandb:
{
Required: True ,
}
{
project:
{
Required: True ,
}
string ,
name:
{
Required: False ,
}
string ,
entity:
{
Required: False ,
}
string ,
tags:
{
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Error content as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). ,
Required: True ,
}
{
code:
{
Description: Error codes as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). ,
Enum:
{
conflict: The requested operation conflicts with the current resource state. ,
invalidPayload: The request data is invalid for this operation. ,
forbidden: The operation is forbidden for the current user/api key. ,
notFound: The resource is not found. ,
unexpectedEntityState: The operation cannot be executed in the current resource's state. ,
itemDoesAlreadyExist: The item does already exist. ,
serviceUnavailable: The service is currently not available. ,
internalFailure: Internal error. Please retry. ,
quotaExceeded: Quota exceeded. ,
jsonlValidationFailed: Validation of jsonl data failed. ,
fileImportFailed: Import of file failed. ,
tooManyRequests: Too many requests. Please retry later. ,
unauthorized: The current user/api key is not authorized for the operation. ,
contentFilter: Image generation failed as a result of our safety system. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: The message of this error. ,
Required: True ,
}
string ,
target:
{
Description: The location where the error happened if available. ,
Required: False ,
}
string ,
details:
{
Description: The error details if available. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). ,
Required: False ,
}
{
code:
{
Description: Inner error codes as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). ,
Enum:
{
invalidPayload: The request data is invalid for this operation. ,
}
,
Required: False ,
}
enum ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
FineTuning_Delete (new)
Description :  Deletes the fine-tune job specified by the given fine-tune-id.
Reference :  Link ¶

⚼ Request

DELETE:  /fine_tuning/jobs/{fine-tuning-job-id}
{
fine-tuning-job-id:
{
Description: The identifier of the fine-tune job. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Error content as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). ,
Required: True ,
}
{
code:
{
Description: Error codes as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). ,
Enum:
{
conflict: The requested operation conflicts with the current resource state. ,
invalidPayload: The request data is invalid for this operation. ,
forbidden: The operation is forbidden for the current user/api key. ,
notFound: The resource is not found. ,
unexpectedEntityState: The operation cannot be executed in the current resource's state. ,
itemDoesAlreadyExist: The item does already exist. ,
serviceUnavailable: The service is currently not available. ,
internalFailure: Internal error. Please retry. ,
quotaExceeded: Quota exceeded. ,
jsonlValidationFailed: Validation of jsonl data failed. ,
fileImportFailed: Import of file failed. ,
tooManyRequests: Too many requests. Please retry later. ,
unauthorized: The current user/api key is not authorized for the operation. ,
contentFilter: Image generation failed as a result of our safety system. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: The message of this error. ,
Required: True ,
}
string ,
target:
{
Description: The location where the error happened if available. ,
Required: False ,
}
string ,
details:
{
Description: The error details if available. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). ,
Required: False ,
}
{
code:
{
Description: Inner error codes as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). ,
Enum:
{
invalidPayload: The request data is invalid for this operation. ,
}
,
Required: False ,
}
enum ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
FineTuning_Cancel (new)
Description :  Cancels the processing of the fine-tune job specified by the given fine-tune-id.
Reference :  Link ¶

⚼ Request

POST:  /fine_tuning/jobs/{fine-tuning-job-id}/cancel
{
fine-tuning-job-id:
{
Description: The identifier of the fine-tune job. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
object:
{
Description: Defines the type of an object. ,
Enum:
{
list: This object represents a list of other objects. ,
fine_tuning.job: This object represents a fine tune job. ,
file: This object represents a file. ,
fine_tuning.job.event: This object represents an event of a fine tuning job. ,
fine_tuning.job.checkpoint: This object represents a checkpoint of a fine tuning job. ,
model: This object represents a model (can be a base model or fine tune job result). ,
upload: This object represents a file upload. ,
upload.part: This object represents part of a file upload. ,
batch: This object represents a batch. ,
}
,
Required: False ,
}
enum ,
created_at:
{
Description: A timestamp when this job or item was created (in unix epochs). ,
Format: unixtime ,
Required: False ,
}
integer ,
id:
{
Description: The identity of this item. ,
Required: False ,
}
string ,
status:
{
Description: The state of a finetunes object or fine tuning job. ,
Enum:
{
created: The operation was created. This state is not returned by Azure OpenAI and exposed only for compatibility. It can be categorized as an inactive state. ,
pending: The operation is not yet queued to be processed in the future. It can be categorized as an inactive state. ,
running: The operation has started to be processed. It can be categorized as an active state. ,
succeeded: The operation has successfully be processed and is ready for consumption. It can be categorized as a terminal state. ,
cancelled: The operation has been cancelled and is incomplete. It can be categorized as a terminal state. ,
failed: The operation has completed processing with a failure and cannot be further consumed. It can be categorized as a terminal state. ,
}
,
Required: False ,
}
enum ,
model:
{
Description: The identifier (model-id) of the base model used for the fine-tune. ,
Required: True ,
}
string ,
fine_tuned_model:
{
Description: The identifier (model-id) of the resulting fine tuned model. This property is only populated for successfully completed fine-tune runs. Use this identifier to create a deployment for inferencing. ,
Required: False ,
}
string ,
training_file:
{
Description: The file which is used for training. ,
Required: True ,
}
string ,
validation_file:
{
Description: The file which is used to evaluate the fine tuned model during training. ,
Required: False ,
}
string ,
result_files:
{
Description: The result file identities (file-id) containing training and evaluation metrics in csv format. The file is only available for successfully completed fine-tune runs. ,
Required: False ,
}
[
string ,
]
,
finished_at:
{
Description: A timestamp when this job or item has finished successfully (in unix epochs). ,
Format: int32 ,
Required: False ,
}
integer ,
organisation_id:
{
Description: The organisation id of this fine tune job. Unused on Azure OpenAI; compatibility for OpenAI only. ,
Required: False ,
}
string ,
trained_tokens:
{
Description: The total number of billable tokens processed by this fine tuning job. ,
Format: int32 ,
Required: False ,
}
integer ,
error:
{
Description: For fine-tuning jobs that have failed, this will contain more information on the cause of the failure. ,
Required: False ,
}
{
code:
{
Description: The machine-readable error code.. ,
Required: False ,
}
string ,
message:
{
Description: The human-readable error message. ,
Required: False ,
}
string ,
param:
{
Description: The parameter that was invalid, usually training_file or validation_file. This field will be null if the failure was not parameter-specific. ,
Required: False ,
}
string ,
}
,
estimated_finish:
{
Description: The Unix timestamp (in seconds) for when the fine-tuning job is estimated to finish. The value will be null if the fine-tuning job is not running. ,
Format: int32 ,
Required: False ,
}
integer ,
hyperparameters:
{
Description: The hyper parameter settings used in a fine tune job. ,
Required: False ,
}
{
n_epochs:
{
Description: The number of epochs to train the model for. An epoch refers to one full cycle through the training dataset. ,
Format: int32 ,
Required: False ,
}
integer ,
batch_size:
{
Description: The batch size to use for training. The batch size is the number of training examples used to train a single forward and backward pass. In general, we've found that larger batch sizes tend to work better for larger datasets. The default value as well as the maximum value for this property are specific to a base model. ,
Format: int32 ,
Required: False ,
}
integer ,
learning_rate_multiplier:
{
Description: The learning rate multiplier to use for training. The fine-tuning learning rate is the original learning rate used for pre-training multiplied by this value. Larger learning rates tend to perform better with larger batch sizes. We recommend experimenting with values in the range 0.02 to 0.2 to see what produces the best results. ,
Format: double ,
Required: False ,
}
number ,
}
,
suffix:
{
Description: The suffix used to identify the fine-tuned model. The suffix can contain up to 40 characters (a-z, A-Z, 0-9,- and _) that will be added to your fine-tuned model name. ,
Required: False ,
}
string ,
seed:
{
Description: The seed used for the finetuning job. ,
Format: int32 ,
Required: False ,
}
integer ,
integrations:
{
Description: A list configurations for integrations supporting the fine-tuning job. There are many integrations planned, so make sure to check and act on the integration type. ,
Required: False ,
}
[
{
type:
{
Description: List of Fine Tune integrations available. ,
Enum:
{
wandb: No description available. ,
}
,
Required: True ,
}
enum ,
wandb:
{
Required: True ,
}
{
project:
{
Required: True ,
}
string ,
name:
{
Required: False ,
}
string ,
entity:
{
Required: False ,
}
string ,
tags:
{
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Error content as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). ,
Required: True ,
}
{
code:
{
Description: Error codes as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). ,
Enum:
{
conflict: The requested operation conflicts with the current resource state. ,
invalidPayload: The request data is invalid for this operation. ,
forbidden: The operation is forbidden for the current user/api key. ,
notFound: The resource is not found. ,
unexpectedEntityState: The operation cannot be executed in the current resource's state. ,
itemDoesAlreadyExist: The item does already exist. ,
serviceUnavailable: The service is currently not available. ,
internalFailure: Internal error. Please retry. ,
quotaExceeded: Quota exceeded. ,
jsonlValidationFailed: Validation of jsonl data failed. ,
fileImportFailed: Import of file failed. ,
tooManyRequests: Too many requests. Please retry later. ,
unauthorized: The current user/api key is not authorized for the operation. ,
contentFilter: Image generation failed as a result of our safety system. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: The message of this error. ,
Required: True ,
}
string ,
target:
{
Description: The location where the error happened if available. ,
Required: False ,
}
string ,
details:
{
Description: The error details if available. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). ,
Required: False ,
}
{
code:
{
Description: Inner error codes as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). ,
Enum:
{
invalidPayload: The request data is invalid for this operation. ,
}
,
Required: False ,
}
enum ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
FineTuning_GetCheckpoints (new)
Description :  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.
Reference :  Link ¶

⚼ Request

GET:  /fine_tuning/jobs/{fine-tuning-job-id}/checkpoints
{
fine-tuning-job-id:
{
Description: The identifier of the fine-tune job. ,
Required: True ,
}
string ,
after:
{
Description: Identifier for the last checkpoint ID from the previous pagination request. ,
Required: False ,
}
string ,
limit:
{
Description: Number of checkpoints to retrieve. Defaults to 10. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
object:
{
Description: Defines the type of an object. ,
Enum:
{
list: This object represents a list of other objects. ,
fine_tuning.job: This object represents a fine tune job. ,
file: This object represents a file. ,
fine_tuning.job.event: This object represents an event of a fine tuning job. ,
fine_tuning.job.checkpoint: This object represents a checkpoint of a fine tuning job. ,
model: This object represents a model (can be a base model or fine tune job result). ,
upload: This object represents a file upload. ,
upload.part: This object represents part of a file upload. ,
batch: This object represents a batch. ,
}
,
Required: False ,
}
enum ,
data:
{
Description: The list of items. ,
Required: False ,
}
[
{
object:
{
Description: Defines the type of an object. ,
Enum:
{
list: This object represents a list of other objects. ,
fine_tuning.job: This object represents a fine tune job. ,
file: This object represents a file. ,
fine_tuning.job.event: This object represents an event of a fine tuning job. ,
fine_tuning.job.checkpoint: This object represents a checkpoint of a fine tuning job. ,
model: This object represents a model (can be a base model or fine tune job result). ,
upload: This object represents a file upload. ,
upload.part: This object represents part of a file upload. ,
batch: This object represents a batch. ,
}
,
Required: False ,
}
enum ,
id:
{
Description: The identity of this checkpoint. ,
Required: False ,
}
string ,
created_at:
{
Description: The Unix timestamp (in seconds) for when the checkpoint was created. ,
Format: unixtime ,
Required: True ,
}
integer ,
fine_tuned_model_checkpoint:
{
Description: The name of the fine-tuned checkpoint model that is created. ,
Required: True ,
}
string ,
step_number:
{
Description: The step number that the checkpoint was created at. ,
Format: int32 ,
Required: True ,
}
integer ,
metrics:
{
Description: The metrics at the step number during the fine-tuning job. ,
Required: True ,
}
object ,
fine_tuning_job_id:
{
Description: The name of the fine-tuning job that this checkpoint was created from.. ,
Required: True ,
}
string ,
}
,
]
,
has_more:
{
Description: A value indicating whether the list contains more elements than returned. ,
Required: False ,
}
boolean ,
}

⚐ Response (default)

{
error:
{
Description: Error content as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). ,
Required: True ,
}
{
code:
{
Description: Error codes as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). ,
Enum:
{
conflict: The requested operation conflicts with the current resource state. ,
invalidPayload: The request data is invalid for this operation. ,
forbidden: The operation is forbidden for the current user/api key. ,
notFound: The resource is not found. ,
unexpectedEntityState: The operation cannot be executed in the current resource's state. ,
itemDoesAlreadyExist: The item does already exist. ,
serviceUnavailable: The service is currently not available. ,
internalFailure: Internal error. Please retry. ,
quotaExceeded: Quota exceeded. ,
jsonlValidationFailed: Validation of jsonl data failed. ,
fileImportFailed: Import of file failed. ,
tooManyRequests: Too many requests. Please retry later. ,
unauthorized: The current user/api key is not authorized for the operation. ,
contentFilter: Image generation failed as a result of our safety system. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: The message of this error. ,
Required: True ,
}
string ,
target:
{
Description: The location where the error happened if available. ,
Required: False ,
}
string ,
details:
{
Description: The error details if available. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). ,
Required: False ,
}
{
code:
{
Description: Inner error codes as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). ,
Enum:
{
invalidPayload: The request data is invalid for this operation. ,
}
,
Required: False ,
}
enum ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
FineTuning_GetEvents (new)
Description :  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.
Reference :  Link ¶

⚼ Request

GET:  /fine_tuning/jobs/{fine-tuning-job-id}/events
{
fine-tuning-job-id:
{
Description: The identifier of the fine-tune job. ,
Required: True ,
}
string ,
after:
{
Description: Identifier for the last event from the previous pagination request. ,
Required: False ,
}
string ,
limit:
{
Description: Number of events to retrieve. Defaults to 20. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
object:
{
Description: Defines the type of an object. ,
Enum:
{
list: This object represents a list of other objects. ,
fine_tuning.job: This object represents a fine tune job. ,
file: This object represents a file. ,
fine_tuning.job.event: This object represents an event of a fine tuning job. ,
fine_tuning.job.checkpoint: This object represents a checkpoint of a fine tuning job. ,
model: This object represents a model (can be a base model or fine tune job result). ,
upload: This object represents a file upload. ,
upload.part: This object represents part of a file upload. ,
batch: This object represents a batch. ,
}
,
Required: False ,
}
enum ,
data:
{
Description: The list of items. ,
Required: False ,
}
[
{
object:
{
Description: Defines the type of an object. ,
Enum:
{
list: This object represents a list of other objects. ,
fine_tuning.job: This object represents a fine tune job. ,
file: This object represents a file. ,
fine_tuning.job.event: This object represents an event of a fine tuning job. ,
fine_tuning.job.checkpoint: This object represents a checkpoint of a fine tuning job. ,
model: This object represents a model (can be a base model or fine tune job result). ,
upload: This object represents a file upload. ,
upload.part: This object represents part of a file upload. ,
batch: This object represents a batch. ,
}
,
Required: False ,
}
enum ,
id:
{
Description: The identity of this event. ,
Required: False ,
}
string ,
created_at:
{
Description: A timestamp when this event was created (in unix epochs). ,
Format: unixtime ,
Required: True ,
}
integer ,
level:
{
Description: The verbosity level of an event. ,
Enum:
{
info: This event is for information only. ,
warning: This event represents a mitigated issue. ,
error: This message represents a non recoverable issue. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: The message describing the event. This can be a change of state, e.g., enqueued, started, failed or completed, or other events like uploaded results. ,
Required: True ,
}
string ,
type:
{
Description: Defines the severity of a content filter result. ,
Enum:
{
message: Event only contains human readable messages. ,
metrics: Event contains metrics. ,
}
,
Required: True ,
}
enum ,
data:
{
Description: Machine readable data of this event. ,
Required: False ,
}
string ,
}
,
]
,
has_more:
{
Description: A value indicating whether the list contains more elements than returned. ,
Required: False ,
}
boolean ,
}

⚐ Response (default)

{
error:
{
Description: Error content as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). ,
Required: True ,
}
{
code:
{
Description: Error codes as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). ,
Enum:
{
conflict: The requested operation conflicts with the current resource state. ,
invalidPayload: The request data is invalid for this operation. ,
forbidden: The operation is forbidden for the current user/api key. ,
notFound: The resource is not found. ,
unexpectedEntityState: The operation cannot be executed in the current resource's state. ,
itemDoesAlreadyExist: The item does already exist. ,
serviceUnavailable: The service is currently not available. ,
internalFailure: Internal error. Please retry. ,
quotaExceeded: Quota exceeded. ,
jsonlValidationFailed: Validation of jsonl data failed. ,
fileImportFailed: Import of file failed. ,
tooManyRequests: Too many requests. Please retry later. ,
unauthorized: The current user/api key is not authorized for the operation. ,
contentFilter: Image generation failed as a result of our safety system. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: The message of this error. ,
Required: True ,
}
string ,
target:
{
Description: The location where the error happened if available. ,
Required: False ,
}
string ,
details:
{
Description: The error details if available. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). ,
Required: False ,
}
{
code:
{
Description: Inner error codes as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). ,
Enum:
{
invalidPayload: The request data is invalid for this operation. ,
}
,
Required: False ,
}
enum ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
IngestionJobs_List (new)
Description :  Lists the ingestion jobs.
Reference :  Link ¶

⚼ Request

GET:  /ingestion/jobs
{
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
mgmt-user-token:
{
Description: The token used to access the workspace (needed only for user compute jobs). ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link to the next page. ,
Required: False ,
}
string ,
value:
{
Description: The list of items. ,
Required: False ,
}
[
{
kind:
{
Description: The job type. ,
Enum:
{
SystemCompute: Jobs that run on service owned resources. ,
UserCompute: Jobs that run on user owned workspace. ,
}
,
Required: True ,
}
enum ,
jobId:
{
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Error content as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). ,
Required: True ,
}
{
code:
{
Description: Error codes as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). ,
Enum:
{
conflict: The requested operation conflicts with the current resource state. ,
invalidPayload: The request data is invalid for this operation. ,
forbidden: The operation is forbidden for the current user/api key. ,
notFound: The resource is not found. ,
unexpectedEntityState: The operation cannot be executed in the current resource's state. ,
itemDoesAlreadyExist: The item does already exist. ,
serviceUnavailable: The service is currently not available. ,
internalFailure: Internal error. Please retry. ,
quotaExceeded: Quota exceeded. ,
jsonlValidationFailed: Validation of jsonl data failed. ,
fileImportFailed: Import of file failed. ,
tooManyRequests: Too many requests. Please retry later. ,
unauthorized: The current user/api key is not authorized for the operation. ,
contentFilter: Image generation failed as a result of our safety system. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: The message of this error. ,
Required: True ,
}
string ,
target:
{
Description: The location where the error happened if available. ,
Required: False ,
}
string ,
details:
{
Description: The error details if available. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). ,
Required: False ,
}
{
code:
{
Description: Inner error codes as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). ,
Enum:
{
invalidPayload: The request data is invalid for this operation. ,
}
,
Required: False ,
}
enum ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
IngestionJobs_Create (new)
Description :  Creates an ingestion job with the specified job id.
Reference :  Link ¶

⚼ Request

PUT:  /ingestion/jobs/{job-id}
{
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
job-id:
{
Description: The id of the job that will be created. ,
Required: True ,
}
string ,
mgmt-user-token:
{
Description: The token used to access the workspace (needed only for user compute jobs). ,
Required: False ,
}
string ,
aml-user-token:
{
Description: The token used to access the resources within the job in the workspace (needed only for user compute jobs). ,
Required: False ,
}
string ,
ingestionJob:
{
Required: False ,
}
{
kind:
{
Description: The job type. ,
Enum:
{
SystemCompute: Jobs that run on service owned resources. ,
UserCompute: Jobs that run on user owned workspace. ,
}
,
Required: True ,
}
enum ,
jobId:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
kind:
{
Description: The job type. ,
Enum:
{
SystemCompute: Jobs that run on service owned resources. ,
UserCompute: Jobs that run on user owned workspace. ,
}
,
Required: True ,
}
enum ,
jobId:
{
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error content as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). ,
Required: True ,
}
{
code:
{
Description: Error codes as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). ,
Enum:
{
conflict: The requested operation conflicts with the current resource state. ,
invalidPayload: The request data is invalid for this operation. ,
forbidden: The operation is forbidden for the current user/api key. ,
notFound: The resource is not found. ,
unexpectedEntityState: The operation cannot be executed in the current resource's state. ,
itemDoesAlreadyExist: The item does already exist. ,
serviceUnavailable: The service is currently not available. ,
internalFailure: Internal error. Please retry. ,
quotaExceeded: Quota exceeded. ,
jsonlValidationFailed: Validation of jsonl data failed. ,
fileImportFailed: Import of file failed. ,
tooManyRequests: Too many requests. Please retry later. ,
unauthorized: The current user/api key is not authorized for the operation. ,
contentFilter: Image generation failed as a result of our safety system. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: The message of this error. ,
Required: True ,
}
string ,
target:
{
Description: The location where the error happened if available. ,
Required: False ,
}
string ,
details:
{
Description: The error details if available. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). ,
Required: False ,
}
{
code:
{
Description: Inner error codes as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). ,
Enum:
{
invalidPayload: The request data is invalid for this operation. ,
}
,
Required: False ,
}
enum ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
IngestionJobs_Get (new)
Description :  Gets the details of the specified job id.
Reference :  Link ¶

⚼ Request

GET:  /ingestion/jobs/{job-id}
{
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
job-id:
{
Description: The id of the job. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
kind:
{
Description: The job type. ,
Enum:
{
SystemCompute: Jobs that run on service owned resources. ,
UserCompute: Jobs that run on user owned workspace. ,
}
,
Required: True ,
}
enum ,
jobId:
{
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error content as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). ,
Required: True ,
}
{
code:
{
Description: Error codes as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). ,
Enum:
{
conflict: The requested operation conflicts with the current resource state. ,
invalidPayload: The request data is invalid for this operation. ,
forbidden: The operation is forbidden for the current user/api key. ,
notFound: The resource is not found. ,
unexpectedEntityState: The operation cannot be executed in the current resource's state. ,
itemDoesAlreadyExist: The item does already exist. ,
serviceUnavailable: The service is currently not available. ,
internalFailure: Internal error. Please retry. ,
quotaExceeded: Quota exceeded. ,
jsonlValidationFailed: Validation of jsonl data failed. ,
fileImportFailed: Import of file failed. ,
tooManyRequests: Too many requests. Please retry later. ,
unauthorized: The current user/api key is not authorized for the operation. ,
contentFilter: Image generation failed as a result of our safety system. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: The message of this error. ,
Required: True ,
}
string ,
target:
{
Description: The location where the error happened if available. ,
Required: False ,
}
string ,
details:
{
Description: The error details if available. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). ,
Required: False ,
}
{
code:
{
Description: Inner error codes as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). ,
Enum:
{
invalidPayload: The request data is invalid for this operation. ,
}
,
Required: False ,
}
enum ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
IngestionJobRuns_List (new)
Description :  Lists the runs of the specified job id.
Reference :  Link ¶

⚼ Request

GET:  /ingestion/jobs/{job-id}/runs
{
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
job-id:
{
Description: The id of the job. ,
Required: True ,
}
string ,
mgmt-user-token:
{
Description: The token used to access the workspace (needed only for user compute jobs). ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link to the next page. ,
Required: False ,
}
string ,
value:
{
Description: The list of items. ,
Required: False ,
}
[
{
jobId:
{
Required: False ,
}
string ,
runId:
{
Required: False ,
}
string ,
status:
{
Description: The state of a job or item. ,
Enum:
{
notRunning: The operation is not yet queued to be processed in the future. ,
running: The operation has started to be processed. ,
succeeded: The operation has successfully be processed and is ready for consumption. ,
failed: The operation has completed processing with a failure and cannot be further consumed. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: The details of the ingestion error ,
Required: False ,
}
{
message:
{
Required: False ,
}
string ,
innerErrors:
{
Required: False ,
}
[
string ,
]
,
}
,
warnings:
{
Required: False ,
}
[
string ,
]
,
progress:
{
Required: False ,
}
{
stageProgress:
{
Required: True ,
}
[
{
name:
{
Required: False ,
}
string ,
totalItems:
{
Format: int32 ,
Required: False ,
}
integer ,
processedItems:
{
Format: int32 ,
Required: False ,
}
integer ,
state:
{
Description: The state of a job or item. ,
Enum:
{
notRunning: The operation is not yet queued to be processed in the future. ,
running: The operation has started to be processed. ,
succeeded: The operation has successfully be processed and is ready for consumption. ,
failed: The operation has completed processing with a failure and cannot be further consumed. ,
}
,
Required: False ,
}
enum ,
subStageProgress:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Error content as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). ,
Required: True ,
}
{
code:
{
Description: Error codes as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). ,
Enum:
{
conflict: The requested operation conflicts with the current resource state. ,
invalidPayload: The request data is invalid for this operation. ,
forbidden: The operation is forbidden for the current user/api key. ,
notFound: The resource is not found. ,
unexpectedEntityState: The operation cannot be executed in the current resource's state. ,
itemDoesAlreadyExist: The item does already exist. ,
serviceUnavailable: The service is currently not available. ,
internalFailure: Internal error. Please retry. ,
quotaExceeded: Quota exceeded. ,
jsonlValidationFailed: Validation of jsonl data failed. ,
fileImportFailed: Import of file failed. ,
tooManyRequests: Too many requests. Please retry later. ,
unauthorized: The current user/api key is not authorized for the operation. ,
contentFilter: Image generation failed as a result of our safety system. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: The message of this error. ,
Required: True ,
}
string ,
target:
{
Description: The location where the error happened if available. ,
Required: False ,
}
string ,
details:
{
Description: The error details if available. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). ,
Required: False ,
}
{
code:
{
Description: Inner error codes as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). ,
Enum:
{
invalidPayload: The request data is invalid for this operation. ,
}
,
Required: False ,
}
enum ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
IngestionJobRuns_Get (new)
Description :  Gets the details of the specified run id as part of the specified job id.
Reference :  Link ¶

⚼ Request

GET:  /ingestion/jobs/{job-id}/runs/{run-id}
{
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
job-id:
{
Description: The id of the job. ,
Required: True ,
}
string ,
run-id:
{
Description: The id of the run. ,
Required: True ,
}
string ,
mgmt-user-token:
{
Description: The token used to access the workspace (needed only for user compute jobs). ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
jobId:
{
Required: False ,
}
string ,
runId:
{
Required: False ,
}
string ,
status:
{
Description: The state of a job or item. ,
Enum:
{
notRunning: The operation is not yet queued to be processed in the future. ,
running: The operation has started to be processed. ,
succeeded: The operation has successfully be processed and is ready for consumption. ,
failed: The operation has completed processing with a failure and cannot be further consumed. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: The details of the ingestion error ,
Required: False ,
}
{
message:
{
Required: False ,
}
string ,
innerErrors:
{
Required: False ,
}
[
string ,
]
,
}
,
warnings:
{
Required: False ,
}
[
string ,
]
,
progress:
{
Required: False ,
}
{
stageProgress:
{
Required: True ,
}
[
{
name:
{
Required: False ,
}
string ,
totalItems:
{
Format: int32 ,
Required: False ,
}
integer ,
processedItems:
{
Format: int32 ,
Required: False ,
}
integer ,
state:
{
Description: The state of a job or item. ,
Enum:
{
notRunning: The operation is not yet queued to be processed in the future. ,
running: The operation has started to be processed. ,
succeeded: The operation has successfully be processed and is ready for consumption. ,
failed: The operation has completed processing with a failure and cannot be further consumed. ,
}
,
Required: False ,
}
enum ,
subStageProgress:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error content as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). ,
Required: True ,
}
{
code:
{
Description: Error codes as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). ,
Enum:
{
conflict: The requested operation conflicts with the current resource state. ,
invalidPayload: The request data is invalid for this operation. ,
forbidden: The operation is forbidden for the current user/api key. ,
notFound: The resource is not found. ,
unexpectedEntityState: The operation cannot be executed in the current resource's state. ,
itemDoesAlreadyExist: The item does already exist. ,
serviceUnavailable: The service is currently not available. ,
internalFailure: Internal error. Please retry. ,
quotaExceeded: Quota exceeded. ,
jsonlValidationFailed: Validation of jsonl data failed. ,
fileImportFailed: Import of file failed. ,
tooManyRequests: Too many requests. Please retry later. ,
unauthorized: The current user/api key is not authorized for the operation. ,
contentFilter: Image generation failed as a result of our safety system. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: The message of this error. ,
Required: True ,
}
string ,
target:
{
Description: The location where the error happened if available. ,
Required: False ,
}
string ,
details:
{
Description: The error details if available. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). ,
Required: False ,
}
{
code:
{
Description: Inner error codes as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). ,
Enum:
{
invalidPayload: The request data is invalid for this operation. ,
}
,
Required: False ,
}
enum ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
Models_List (new)
Description :  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.
Reference :  Link ¶

⚼ Request

GET:  /models
{
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
object:
{
Description: Defines the type of an object. ,
Enum:
{
list: This object represents a list of other objects. ,
fine_tuning.job: This object represents a fine tune job. ,
file: This object represents a file. ,
fine_tuning.job.event: This object represents an event of a fine tuning job. ,
fine_tuning.job.checkpoint: This object represents a checkpoint of a fine tuning job. ,
model: This object represents a model (can be a base model or fine tune job result). ,
upload: This object represents a file upload. ,
upload.part: This object represents part of a file upload. ,
batch: This object represents a batch. ,
}
,
Required: False ,
}
enum ,
data:
{
Description: The list of items. ,
Required: False ,
}
[
{
object:
{
Description: Defines the type of an object. ,
Enum:
{
list: This object represents a list of other objects. ,
fine_tuning.job: This object represents a fine tune job. ,
file: This object represents a file. ,
fine_tuning.job.event: This object represents an event of a fine tuning job. ,
fine_tuning.job.checkpoint: This object represents a checkpoint of a fine tuning job. ,
model: This object represents a model (can be a base model or fine tune job result). ,
upload: This object represents a file upload. ,
upload.part: This object represents part of a file upload. ,
batch: This object represents a batch. ,
}
,
Required: False ,
}
enum ,
created_at:
{
Description: A timestamp when this job or item was created (in unix epochs). ,
Format: unixtime ,
Required: False ,
}
integer ,
id:
{
Description: The identity of this item. ,
Required: False ,
}
string ,
status:
{
Description: The state of a finetunes object or fine tuning job. ,
Enum:
{
created: The operation was created. This state is not returned by Azure OpenAI and exposed only for compatibility. It can be categorized as an inactive state. ,
pending: The operation is not yet queued to be processed in the future. It can be categorized as an inactive state. ,
running: The operation has started to be processed. It can be categorized as an active state. ,
succeeded: The operation has successfully be processed and is ready for consumption. It can be categorized as a terminal state. ,
cancelled: The operation has been cancelled and is incomplete. It can be categorized as a terminal state. ,
failed: The operation has completed processing with a failure and cannot be further consumed. It can be categorized as a terminal state. ,
}
,
Required: False ,
}
enum ,
model:
{
Description: The base model identity (model-id) if this is a fine tune model; otherwise `null`. ,
Required: False ,
}
string ,
fine_tune:
{
Description: The fine tune job identity (fine-tune-id) if this is a fine tune model; otherwise `null`. ,
Required: False ,
}
string ,
capabilities:
{
Description: The capabilities of a base or fine tune model. ,
Required: True ,
}
{
fine_tune:
{
Description: A value indicating whether a model can be used for fine tuning. ,
Required: True ,
}
boolean ,
inference:
{
Description: A value indicating whether a model can be deployed. ,
Required: True ,
}
boolean ,
completion:
{
Description: A value indicating whether a model supports completion. ,
Required: True ,
}
boolean ,
chat_completion:
{
Description: A value indicating whether a model supports chat completion. ,
Required: True ,
}
boolean ,
embeddings:
{
Description: A value indicating whether a model supports embeddings. ,
Required: True ,
}
boolean ,
}
,
lifecycle_status:
{
Description: The life cycle status of a model. Note: A model can be promoted from "preview" to "generally-available", but never from "generally-available" to "preview". ,
Enum:
{
preview: Model is in preview and covered by the service preview terms. ,
generally-available: Model is generally available. ,
}
,
Required: True ,
}
enum ,
deprecation:
{
Description: Defines the dates of deprecation for the different use cases of a model. Usually base models support 1 year of fine tuning after creation. Inference is typically supported 2 years after creation of base or fine tuned models. The exact dates are specified in the properties. ,
Required: True ,
}
{
fine_tune:
{
Description: The end date of fine tune support of this model. Will be `null` for fine tune models. ,
Format: unixtime ,
Required: False ,
}
integer ,
inference:
{
Description: The end date of inference support of this model. ,
Format: unixtime ,
Required: True ,
}
integer ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Error content as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). ,
Required: True ,
}
{
code:
{
Description: Error codes as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). ,
Enum:
{
conflict: The requested operation conflicts with the current resource state. ,
invalidPayload: The request data is invalid for this operation. ,
forbidden: The operation is forbidden for the current user/api key. ,
notFound: The resource is not found. ,
unexpectedEntityState: The operation cannot be executed in the current resource's state. ,
itemDoesAlreadyExist: The item does already exist. ,
serviceUnavailable: The service is currently not available. ,
internalFailure: Internal error. Please retry. ,
quotaExceeded: Quota exceeded. ,
jsonlValidationFailed: Validation of jsonl data failed. ,
fileImportFailed: Import of file failed. ,
tooManyRequests: Too many requests. Please retry later. ,
unauthorized: The current user/api key is not authorized for the operation. ,
contentFilter: Image generation failed as a result of our safety system. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: The message of this error. ,
Required: True ,
}
string ,
target:
{
Description: The location where the error happened if available. ,
Required: False ,
}
string ,
details:
{
Description: The error details if available. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). ,
Required: False ,
}
{
code:
{
Description: Inner error codes as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). ,
Enum:
{
invalidPayload: The request data is invalid for this operation. ,
}
,
Required: False ,
}
enum ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
Models_Get (new)
Description :  Gets details for the model specified by the given modelId.
Reference :  Link ¶

⚼ Request

GET:  /models/{model-id}
{
model-id:
{
Description: The identifier of the model. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
object:
{
Description: Defines the type of an object. ,
Enum:
{
list: This object represents a list of other objects. ,
fine_tuning.job: This object represents a fine tune job. ,
file: This object represents a file. ,
fine_tuning.job.event: This object represents an event of a fine tuning job. ,
fine_tuning.job.checkpoint: This object represents a checkpoint of a fine tuning job. ,
model: This object represents a model (can be a base model or fine tune job result). ,
upload: This object represents a file upload. ,
upload.part: This object represents part of a file upload. ,
batch: This object represents a batch. ,
}
,
Required: False ,
}
enum ,
created_at:
{
Description: A timestamp when this job or item was created (in unix epochs). ,
Format: unixtime ,
Required: False ,
}
integer ,
id:
{
Description: The identity of this item. ,
Required: False ,
}
string ,
status:
{
Description: The state of a finetunes object or fine tuning job. ,
Enum:
{
created: The operation was created. This state is not returned by Azure OpenAI and exposed only for compatibility. It can be categorized as an inactive state. ,
pending: The operation is not yet queued to be processed in the future. It can be categorized as an inactive state. ,
running: The operation has started to be processed. It can be categorized as an active state. ,
succeeded: The operation has successfully be processed and is ready for consumption. It can be categorized as a terminal state. ,
cancelled: The operation has been cancelled and is incomplete. It can be categorized as a terminal state. ,
failed: The operation has completed processing with a failure and cannot be further consumed. It can be categorized as a terminal state. ,
}
,
Required: False ,
}
enum ,
model:
{
Description: The base model identity (model-id) if this is a fine tune model; otherwise `null`. ,
Required: False ,
}
string ,
fine_tune:
{
Description: The fine tune job identity (fine-tune-id) if this is a fine tune model; otherwise `null`. ,
Required: False ,
}
string ,
capabilities:
{
Description: The capabilities of a base or fine tune model. ,
Required: True ,
}
{
fine_tune:
{
Description: A value indicating whether a model can be used for fine tuning. ,
Required: True ,
}
boolean ,
inference:
{
Description: A value indicating whether a model can be deployed. ,
Required: True ,
}
boolean ,
completion:
{
Description: A value indicating whether a model supports completion. ,
Required: True ,
}
boolean ,
chat_completion:
{
Description: A value indicating whether a model supports chat completion. ,
Required: True ,
}
boolean ,
embeddings:
{
Description: A value indicating whether a model supports embeddings. ,
Required: True ,
}
boolean ,
}
,
lifecycle_status:
{
Description: The life cycle status of a model. Note: A model can be promoted from "preview" to "generally-available", but never from "generally-available" to "preview". ,
Enum:
{
preview: Model is in preview and covered by the service preview terms. ,
generally-available: Model is generally available. ,
}
,
Required: True ,
}
enum ,
deprecation:
{
Description: Defines the dates of deprecation for the different use cases of a model. Usually base models support 1 year of fine tuning after creation. Inference is typically supported 2 years after creation of base or fine tuned models. The exact dates are specified in the properties. ,
Required: True ,
}
{
fine_tune:
{
Description: The end date of fine tune support of this model. Will be `null` for fine tune models. ,
Format: unixtime ,
Required: False ,
}
integer ,
inference:
{
Description: The end date of inference support of this model. ,
Format: unixtime ,
Required: True ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error content as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). ,
Required: True ,
}
{
code:
{
Description: Error codes as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). ,
Enum:
{
conflict: The requested operation conflicts with the current resource state. ,
invalidPayload: The request data is invalid for this operation. ,
forbidden: The operation is forbidden for the current user/api key. ,
notFound: The resource is not found. ,
unexpectedEntityState: The operation cannot be executed in the current resource's state. ,
itemDoesAlreadyExist: The item does already exist. ,
serviceUnavailable: The service is currently not available. ,
internalFailure: Internal error. Please retry. ,
quotaExceeded: Quota exceeded. ,
jsonlValidationFailed: Validation of jsonl data failed. ,
fileImportFailed: Import of file failed. ,
tooManyRequests: Too many requests. Please retry later. ,
unauthorized: The current user/api key is not authorized for the operation. ,
contentFilter: Image generation failed as a result of our safety system. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: The message of this error. ,
Required: True ,
}
string ,
target:
{
Description: The location where the error happened if available. ,
Required: False ,
}
string ,
details:
{
Description: The error details if available. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). ,
Required: False ,
}
{
code:
{
Description: Inner error codes as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). ,
Enum:
{
invalidPayload: The request data is invalid for this operation. ,
}
,
Required: False ,
}
enum ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
UploadFile_Start (new)
Description :  An intermediate Upload object is created, allowing you to add Parts to it. Currently, an Upload size can be a maximum of 9 GB in total and will expire two hours after being created. After the Upload is completed a File object will be generated, containing all the uploaded parts. This File object can then be used across our platform just like any other file.
Reference :  Link ¶

⚼ Request

POST:  /uploads
{
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
requestBody:
{
Description: The definition of the file to create including its purpose and the location on the local machine. ,
Required: True ,
}
{
purpose:
{
Description: The intended purpose of the uploaded documents. Use "fine-tune" for fine-tuning. This allows us to validate the format of the uploaded file. ,
Enum:
{
fine-tune: This file contains training data for a fine tune job. ,
fine-tune-results: This file contains the results of a fine tune job. ,
assistants: This file contains data to be used in assistants. ,
assistants_output: This file contains the results of an assistant. ,
batch: This file contains the input data for a batch. ,
batch_output: This file contains the results of a batch. ,
}
,
Required: True ,
}
enum ,
filename:
{
Required: True ,
}
string ,
bytes:
{
Format: int64 ,
Required: True ,
}
integer ,
mime_type:
{
Required: True ,
}
string ,
}
,
}

⚐ Response (200)

{
$headers:
{
location:
{
Description: The location of the newly created item. ,
}
string ,
}
,
$schema:
{
object:
{
Description: Defines the type of an object. ,
Enum:
{
list: This object represents a list of other objects. ,
fine_tuning.job: This object represents a fine tune job. ,
file: This object represents a file. ,
fine_tuning.job.event: This object represents an event of a fine tuning job. ,
fine_tuning.job.checkpoint: This object represents a checkpoint of a fine tuning job. ,
model: This object represents a model (can be a base model or fine tune job result). ,
upload: This object represents a file upload. ,
upload.part: This object represents part of a file upload. ,
batch: This object represents a batch. ,
}
,
Required: False ,
}
enum ,
created_at:
{
Description: A timestamp when this job or item was created (in unix epochs). ,
Format: unixtime ,
Required: False ,
}
integer ,
id:
{
Description: The identity of this item. ,
Required: False ,
}
string ,
bytes:
{
Format: int64 ,
Required: False ,
}
integer ,
filename:
{
Required: False ,
}
string ,
purpose:
{
Description: The intended purpose of the uploaded documents. Use "fine-tune" for fine-tuning. This allows us to validate the format of the uploaded file. ,
Enum:
{
fine-tune: This file contains training data for a fine tune job. ,
fine-tune-results: This file contains the results of a fine tune job. ,
assistants: This file contains data to be used in assistants. ,
assistants_output: This file contains the results of an assistant. ,
batch: This file contains the input data for a batch. ,
batch_output: This file contains the results of a batch. ,
}
,
Required: False ,
}
enum ,
status:
{
Enum:
{
pending: No description available. ,
expired: No description available. ,
completed: No description available. ,
cancelled: No description available. ,
}
,
Required: False ,
}
enum ,
expires_at:
{
Format: unixtime ,
Required: False ,
}
integer ,
file:
{
Description: A file is a document usable for training and validation. It can also be a service generated document with result details. ,
Required: False ,
}
{
object:
{
Description: Defines the type of an object. ,
Enum:
{
list: This object represents a list of other objects. ,
fine_tuning.job: This object represents a fine tune job. ,
file: This object represents a file. ,
fine_tuning.job.event: This object represents an event of a fine tuning job. ,
fine_tuning.job.checkpoint: This object represents a checkpoint of a fine tuning job. ,
model: This object represents a model (can be a base model or fine tune job result). ,
upload: This object represents a file upload. ,
upload.part: This object represents part of a file upload. ,
batch: This object represents a batch. ,
}
,
Required: False ,
}
enum ,
created_at:
{
Description: A timestamp when this job or item was created (in unix epochs). ,
Format: unixtime ,
Required: False ,
}
integer ,
id:
{
Description: The identity of this item. ,
Required: False ,
}
string ,
status:
{
Description: The state of a file. ,
Enum:
{
uploaded: The file has been uploaded but it's not yet processed. This state is not returned by Azure OpenAI and exposed only for compatibility. It can be categorized as an inactive state. ,
pending: The operation was created and is not queued to be processed in the future. It can be categorized as an inactive state. ,
running: The operation has started to be processed. It can be categorized as an active state. ,
processed: The operation has successfully be processed and is ready for consumption. It can be categorized as a terminal state. ,
error: The operation has completed processing with a failure and cannot be further consumed. It can be categorized as a terminal state. ,
deleting: The entity is ni the process to be deleted. This state is not returned by Azure OpenAI and exposed only for compatibility. It can be categorized as an active state. ,
deleted: The entity has been deleted but may still be referenced by other entities predating the deletion. It can be categorized as a terminal state. ,
}
,
Required: False ,
}
enum ,
bytes:
{
Description: The size of this file when available (can be null). File sizes larger than 2^53-1 are not supported to ensure compatibility with JavaScript integers. ,
Format: int64 ,
Required: False ,
}
integer ,
purpose:
{
Description: The intended purpose of the uploaded documents. Use "fine-tune" for fine-tuning. This allows us to validate the format of the uploaded file. ,
Enum:
{
fine-tune: This file contains training data for a fine tune job. ,
fine-tune-results: This file contains the results of a fine tune job. ,
assistants: This file contains data to be used in assistants. ,
assistants_output: This file contains the results of an assistant. ,
batch: This file contains the input data for a batch. ,
batch_output: This file contains the results of a batch. ,
}
,
Required: True ,
}
enum ,
filename:
{
Description: The name of the file. ,
Required: True ,
}
string ,
status_details:
{
Description: The error message with details in case processing of this file failed. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error content as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). ,
Required: True ,
}
{
code:
{
Description: Error codes as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). ,
Enum:
{
conflict: The requested operation conflicts with the current resource state. ,
invalidPayload: The request data is invalid for this operation. ,
forbidden: The operation is forbidden for the current user/api key. ,
notFound: The resource is not found. ,
unexpectedEntityState: The operation cannot be executed in the current resource's state. ,
itemDoesAlreadyExist: The item does already exist. ,
serviceUnavailable: The service is currently not available. ,
internalFailure: Internal error. Please retry. ,
quotaExceeded: Quota exceeded. ,
jsonlValidationFailed: Validation of jsonl data failed. ,
fileImportFailed: Import of file failed. ,
tooManyRequests: Too many requests. Please retry later. ,
unauthorized: The current user/api key is not authorized for the operation. ,
contentFilter: Image generation failed as a result of our safety system. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: The message of this error. ,
Required: True ,
}
string ,
target:
{
Description: The location where the error happened if available. ,
Required: False ,
}
string ,
details:
{
Description: The error details if available. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). ,
Required: False ,
}
{
code:
{
Description: Inner error codes as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). ,
Enum:
{
invalidPayload: The request data is invalid for this operation. ,
}
,
Required: False ,
}
enum ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
UploadFile_Cancel (new)
Description :  Cancels the Upload, and will lead to all uploaded parts to be deleted asynchronously. No Parts may be added after an Upload is cancelled.
Reference :  Link ¶

⚼ Request

POST:  /uploads/{upload-id}/cancel
{
upload-id:
{
Description: The identifier of the upload. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
object:
{
Description: Defines the type of an object. ,
Enum:
{
list: This object represents a list of other objects. ,
fine_tuning.job: This object represents a fine tune job. ,
file: This object represents a file. ,
fine_tuning.job.event: This object represents an event of a fine tuning job. ,
fine_tuning.job.checkpoint: This object represents a checkpoint of a fine tuning job. ,
model: This object represents a model (can be a base model or fine tune job result). ,
upload: This object represents a file upload. ,
upload.part: This object represents part of a file upload. ,
batch: This object represents a batch. ,
}
,
Required: False ,
}
enum ,
created_at:
{
Description: A timestamp when this job or item was created (in unix epochs). ,
Format: unixtime ,
Required: False ,
}
integer ,
id:
{
Description: The identity of this item. ,
Required: False ,
}
string ,
bytes:
{
Format: int64 ,
Required: False ,
}
integer ,
filename:
{
Required: False ,
}
string ,
purpose:
{
Description: The intended purpose of the uploaded documents. Use "fine-tune" for fine-tuning. This allows us to validate the format of the uploaded file. ,
Enum:
{
fine-tune: This file contains training data for a fine tune job. ,
fine-tune-results: This file contains the results of a fine tune job. ,
assistants: This file contains data to be used in assistants. ,
assistants_output: This file contains the results of an assistant. ,
batch: This file contains the input data for a batch. ,
batch_output: This file contains the results of a batch. ,
}
,
Required: False ,
}
enum ,
status:
{
Enum:
{
pending: No description available. ,
expired: No description available. ,
completed: No description available. ,
cancelled: No description available. ,
}
,
Required: False ,
}
enum ,
expires_at:
{
Format: unixtime ,
Required: False ,
}
integer ,
file:
{
Description: A file is a document usable for training and validation. It can also be a service generated document with result details. ,
Required: False ,
}
{
object:
{
Description: Defines the type of an object. ,
Enum:
{
list: This object represents a list of other objects. ,
fine_tuning.job: This object represents a fine tune job. ,
file: This object represents a file. ,
fine_tuning.job.event: This object represents an event of a fine tuning job. ,
fine_tuning.job.checkpoint: This object represents a checkpoint of a fine tuning job. ,
model: This object represents a model (can be a base model or fine tune job result). ,
upload: This object represents a file upload. ,
upload.part: This object represents part of a file upload. ,
batch: This object represents a batch. ,
}
,
Required: False ,
}
enum ,
created_at:
{
Description: A timestamp when this job or item was created (in unix epochs). ,
Format: unixtime ,
Required: False ,
}
integer ,
id:
{
Description: The identity of this item. ,
Required: False ,
}
string ,
status:
{
Description: The state of a file. ,
Enum:
{
uploaded: The file has been uploaded but it's not yet processed. This state is not returned by Azure OpenAI and exposed only for compatibility. It can be categorized as an inactive state. ,
pending: The operation was created and is not queued to be processed in the future. It can be categorized as an inactive state. ,
running: The operation has started to be processed. It can be categorized as an active state. ,
processed: The operation has successfully be processed and is ready for consumption. It can be categorized as a terminal state. ,
error: The operation has completed processing with a failure and cannot be further consumed. It can be categorized as a terminal state. ,
deleting: The entity is ni the process to be deleted. This state is not returned by Azure OpenAI and exposed only for compatibility. It can be categorized as an active state. ,
deleted: The entity has been deleted but may still be referenced by other entities predating the deletion. It can be categorized as a terminal state. ,
}
,
Required: False ,
}
enum ,
bytes:
{
Description: The size of this file when available (can be null). File sizes larger than 2^53-1 are not supported to ensure compatibility with JavaScript integers. ,
Format: int64 ,
Required: False ,
}
integer ,
purpose:
{
Description: The intended purpose of the uploaded documents. Use "fine-tune" for fine-tuning. This allows us to validate the format of the uploaded file. ,
Enum:
{
fine-tune: This file contains training data for a fine tune job. ,
fine-tune-results: This file contains the results of a fine tune job. ,
assistants: This file contains data to be used in assistants. ,
assistants_output: This file contains the results of an assistant. ,
batch: This file contains the input data for a batch. ,
batch_output: This file contains the results of a batch. ,
}
,
Required: True ,
}
enum ,
filename:
{
Description: The name of the file. ,
Required: True ,
}
string ,
status_details:
{
Description: The error message with details in case processing of this file failed. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error content as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). ,
Required: True ,
}
{
code:
{
Description: Error codes as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). ,
Enum:
{
conflict: The requested operation conflicts with the current resource state. ,
invalidPayload: The request data is invalid for this operation. ,
forbidden: The operation is forbidden for the current user/api key. ,
notFound: The resource is not found. ,
unexpectedEntityState: The operation cannot be executed in the current resource's state. ,
itemDoesAlreadyExist: The item does already exist. ,
serviceUnavailable: The service is currently not available. ,
internalFailure: Internal error. Please retry. ,
quotaExceeded: Quota exceeded. ,
jsonlValidationFailed: Validation of jsonl data failed. ,
fileImportFailed: Import of file failed. ,
tooManyRequests: Too many requests. Please retry later. ,
unauthorized: The current user/api key is not authorized for the operation. ,
contentFilter: Image generation failed as a result of our safety system. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: The message of this error. ,
Required: True ,
}
string ,
target:
{
Description: The location where the error happened if available. ,
Required: False ,
}
string ,
details:
{
Description: The error details if available. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). ,
Required: False ,
}
{
code:
{
Description: Inner error codes as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). ,
Enum:
{
invalidPayload: The request data is invalid for this operation. ,
}
,
Required: False ,
}
enum ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
UploadFile_Complete (new)
Description :  This completes the Upload, and the returned Upload object contains a nested File object that is ready for use across the platform. You can define the order of the Parts by providing an ordered list of Part IDs. The total number of bytes uploaded must match the size originally specified when creating the Upload object. After this operation no additional Parts can be added once the Upload is completed.
Reference :  Link ¶

⚼ Request

POST:  /uploads/{upload-id}/complete
{
upload-id:
{
Description: The identifier of the upload. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
requestBody:
{
Description: The definition of the file to create including its purpose and the location on the local machine. ,
Required: True ,
}
{
part_ids:
{
Required: True ,
}
[
string ,
]
,
md5:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
object:
{
Description: Defines the type of an object. ,
Enum:
{
list: This object represents a list of other objects. ,
fine_tuning.job: This object represents a fine tune job. ,
file: This object represents a file. ,
fine_tuning.job.event: This object represents an event of a fine tuning job. ,
fine_tuning.job.checkpoint: This object represents a checkpoint of a fine tuning job. ,
model: This object represents a model (can be a base model or fine tune job result). ,
upload: This object represents a file upload. ,
upload.part: This object represents part of a file upload. ,
batch: This object represents a batch. ,
}
,
Required: False ,
}
enum ,
created_at:
{
Description: A timestamp when this job or item was created (in unix epochs). ,
Format: unixtime ,
Required: False ,
}
integer ,
id:
{
Description: The identity of this item. ,
Required: False ,
}
string ,
bytes:
{
Format: int64 ,
Required: False ,
}
integer ,
filename:
{
Required: False ,
}
string ,
purpose:
{
Description: The intended purpose of the uploaded documents. Use "fine-tune" for fine-tuning. This allows us to validate the format of the uploaded file. ,
Enum:
{
fine-tune: This file contains training data for a fine tune job. ,
fine-tune-results: This file contains the results of a fine tune job. ,
assistants: This file contains data to be used in assistants. ,
assistants_output: This file contains the results of an assistant. ,
batch: This file contains the input data for a batch. ,
batch_output: This file contains the results of a batch. ,
}
,
Required: False ,
}
enum ,
status:
{
Enum:
{
pending: No description available. ,
expired: No description available. ,
completed: No description available. ,
cancelled: No description available. ,
}
,
Required: False ,
}
enum ,
expires_at:
{
Format: unixtime ,
Required: False ,
}
integer ,
file:
{
Description: A file is a document usable for training and validation. It can also be a service generated document with result details. ,
Required: False ,
}
{
object:
{
Description: Defines the type of an object. ,
Enum:
{
list: This object represents a list of other objects. ,
fine_tuning.job: This object represents a fine tune job. ,
file: This object represents a file. ,
fine_tuning.job.event: This object represents an event of a fine tuning job. ,
fine_tuning.job.checkpoint: This object represents a checkpoint of a fine tuning job. ,
model: This object represents a model (can be a base model or fine tune job result). ,
upload: This object represents a file upload. ,
upload.part: This object represents part of a file upload. ,
batch: This object represents a batch. ,
}
,
Required: False ,
}
enum ,
created_at:
{
Description: A timestamp when this job or item was created (in unix epochs). ,
Format: unixtime ,
Required: False ,
}
integer ,
id:
{
Description: The identity of this item. ,
Required: False ,
}
string ,
status:
{
Description: The state of a file. ,
Enum:
{
uploaded: The file has been uploaded but it's not yet processed. This state is not returned by Azure OpenAI and exposed only for compatibility. It can be categorized as an inactive state. ,
pending: The operation was created and is not queued to be processed in the future. It can be categorized as an inactive state. ,
running: The operation has started to be processed. It can be categorized as an active state. ,
processed: The operation has successfully be processed and is ready for consumption. It can be categorized as a terminal state. ,
error: The operation has completed processing with a failure and cannot be further consumed. It can be categorized as a terminal state. ,
deleting: The entity is ni the process to be deleted. This state is not returned by Azure OpenAI and exposed only for compatibility. It can be categorized as an active state. ,
deleted: The entity has been deleted but may still be referenced by other entities predating the deletion. It can be categorized as a terminal state. ,
}
,
Required: False ,
}
enum ,
bytes:
{
Description: The size of this file when available (can be null). File sizes larger than 2^53-1 are not supported to ensure compatibility with JavaScript integers. ,
Format: int64 ,
Required: False ,
}
integer ,
purpose:
{
Description: The intended purpose of the uploaded documents. Use "fine-tune" for fine-tuning. This allows us to validate the format of the uploaded file. ,
Enum:
{
fine-tune: This file contains training data for a fine tune job. ,
fine-tune-results: This file contains the results of a fine tune job. ,
assistants: This file contains data to be used in assistants. ,
assistants_output: This file contains the results of an assistant. ,
batch: This file contains the input data for a batch. ,
batch_output: This file contains the results of a batch. ,
}
,
Required: True ,
}
enum ,
filename:
{
Description: The name of the file. ,
Required: True ,
}
string ,
status_details:
{
Description: The error message with details in case processing of this file failed. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error content as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). ,
Required: True ,
}
{
code:
{
Description: Error codes as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). ,
Enum:
{
conflict: The requested operation conflicts with the current resource state. ,
invalidPayload: The request data is invalid for this operation. ,
forbidden: The operation is forbidden for the current user/api key. ,
notFound: The resource is not found. ,
unexpectedEntityState: The operation cannot be executed in the current resource's state. ,
itemDoesAlreadyExist: The item does already exist. ,
serviceUnavailable: The service is currently not available. ,
internalFailure: Internal error. Please retry. ,
quotaExceeded: Quota exceeded. ,
jsonlValidationFailed: Validation of jsonl data failed. ,
fileImportFailed: Import of file failed. ,
tooManyRequests: Too many requests. Please retry later. ,
unauthorized: The current user/api key is not authorized for the operation. ,
contentFilter: Image generation failed as a result of our safety system. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: The message of this error. ,
Required: True ,
}
string ,
target:
{
Description: The location where the error happened if available. ,
Required: False ,
}
string ,
details:
{
Description: The error details if available. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). ,
Required: False ,
}
{
code:
{
Description: Inner error codes as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). ,
Enum:
{
invalidPayload: The request data is invalid for this operation. ,
}
,
Required: False ,
}
enum ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
UploadFile_Part (new)
Description :  Adds a Part to an Upload object, where each Part represents a segment of the file you are uploading. Each Part can be up to the standard size limit for file upload, based on the File Purpose. You can continue adding Parts until reaching the Upload size limit of 9 GB.
Reference :  Link ¶

⚼ Request

POST:  /uploads/{upload-id}/parts
{
upload-id:
{
Description: The identifier of the upload. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
data:
{
Required: True ,
}
file ,
}

⚐ Response (200)

{
object:
{
Description: Defines the type of an object. ,
Enum:
{
list: This object represents a list of other objects. ,
fine_tuning.job: This object represents a fine tune job. ,
file: This object represents a file. ,
fine_tuning.job.event: This object represents an event of a fine tuning job. ,
fine_tuning.job.checkpoint: This object represents a checkpoint of a fine tuning job. ,
model: This object represents a model (can be a base model or fine tune job result). ,
upload: This object represents a file upload. ,
upload.part: This object represents part of a file upload. ,
batch: This object represents a batch. ,
}
,
Required: False ,
}
enum ,
created_at:
{
Description: A timestamp when this job or item was created (in unix epochs). ,
Format: unixtime ,
Required: False ,
}
integer ,
id:
{
Description: The identity of this item. ,
Required: False ,
}
string ,
upload_id:
{
Required: False ,
}
string ,
azure_block_id:
{
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error content as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). ,
Required: True ,
}
{
code:
{
Description: Error codes as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). ,
Enum:
{
conflict: The requested operation conflicts with the current resource state. ,
invalidPayload: The request data is invalid for this operation. ,
forbidden: The operation is forbidden for the current user/api key. ,
notFound: The resource is not found. ,
unexpectedEntityState: The operation cannot be executed in the current resource's state. ,
itemDoesAlreadyExist: The item does already exist. ,
serviceUnavailable: The service is currently not available. ,
internalFailure: Internal error. Please retry. ,
quotaExceeded: Quota exceeded. ,
jsonlValidationFailed: Validation of jsonl data failed. ,
fileImportFailed: Import of file failed. ,
tooManyRequests: Too many requests. Please retry later. ,
unauthorized: The current user/api key is not authorized for the operation. ,
contentFilter: Image generation failed as a result of our safety system. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: The message of this error. ,
Required: True ,
}
string ,
target:
{
Description: The location where the error happened if available. ,
Required: False ,
}
string ,
details:
{
Description: The error details if available. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). ,
Required: False ,
}
{
code:
{
Description: Inner error codes as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). ,
Enum:
{
invalidPayload: The request data is invalid for this operation. ,
}
,
Required: False ,
}
enum ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}