Fine Tuning - Get Events

Service:

Azure AI Services

API Version:

2024-10-21

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.

GET {endpoint}/openai/fine_tuning/jobs/{fine-tuning-job-id}/events?api-version=2024-10-21

With optional parameters:

GET {endpoint}/openai/fine_tuning/jobs/{fine-tuning-job-id}/events?after={after}&limit={limit}&api-version=2024-10-21

URI Parameters

Name	In	Required	Type	Description
endpoint	path	True	string (url)	Supported Cognitive Services endpoints (protocol and hostname, for example: https://aoairesource.openai.azure.com. Replace "aoairesource" with your Azure OpenAI account name).
fine-tuning-job-id	path	True	string	The identifier of the fine-tune job.
api-version	query	True	string	The requested API version.
after	query		string	Identifier for the last event from the previous pagination request.
limit	query		integer (int32)	Number of events to retrieve. Defaults to 20.

Request Header

Name	Required	Type	Description
api-key	True	string	Provide your Cognitive Services Azure OpenAI account key here.

Responses

Name	Type	Description
200 OK	FineTuningJobEventList	Success
Other Status Codes	ErrorResponse	An error occurred.

Security

api-key

Provide your Cognitive Services Azure OpenAI account key here.

Type: apiKey
In: header

Examples

Getting events of a fine tuning job.

Sample request

HTTP

GET https://aoairesource.openai.azure.com/openai/fine_tuning/jobs/ft-72a2792ef7d24ba7b82c7fe4a37e379f/events?api-version=2024-10-21

Sample response

Status code:

200

{
  "has_more": false,
  "data": [
    {
      "id": "ftevent-363dcd7cb4c74539bc53293c1dceef05",
      "created_at": 1646126127,
      "level": "info",
      "message": "Job enqueued. Waiting for jobs ahead to complete.",
      "type": "message",
      "object": "fine_tuning.job.event"
    },
    {
      "id": "ftevent-8c2a44999790437cb3230e543fa2cf0f",
      "created_at": 1646126169,
      "level": "info",
      "message": "Job started.",
      "type": "message",
      "object": "fine_tuning.job.event"
    },
    {
      "id": "ftevent-2d47d651d2f3484c8187c88c00078147",
      "created_at": 1646126192,
      "level": "info",
      "message": "Job succeeded.",
      "type": "message",
      "object": "fine_tuning.job.event"
    }
  ],
  "object": "list"
}

Definitions

Name	Description
Error	Error
ErrorCode	ErrorCode
ErrorResponse	ErrorResponse
EventType	EventType
FineTuningJobEvent	FineTuningJobEvent
FineTuningJobEventList	FineTuningJobEventList
InnerError	InnerError
InnerErrorCode	InnerErrorCode
LogLevel	LogLevel
TypeDiscriminator	TypeDiscriminator

Error

Object

Error

Name	Type	Description
code	ErrorCode	ErrorCode Error codes as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
details	Error[]	The error details if available.
innererror	InnerError	InnerError Inner error as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
message	string minLength: 1	The message of this error.
target	string	The location where the error happened if available.

ErrorCode

Enumeration

ErrorCode

Value	Description
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.

ErrorResponse

Object

ErrorResponse

Name	Type	Description
error	Error	Error Error content as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

EventType

Enumeration

EventType

Value	Description
message	Event only contains human readable messages.
metrics	Event contains metrics.

FineTuningJobEvent

Object

FineTuningJobEvent

Name	Type	Description
created_at	integer (unixtime)	A timestamp when this event was created (in unix epochs).
data		Machine readable data of this event.
id	string	The identity of this event.
level	LogLevel	LogLevel The verbosity level of an event.
message	string minLength: 1	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.
object	TypeDiscriminator	TypeDiscriminator Defines the type of an object.
type	EventType	EventType Defines the severity of a content filter result.

FineTuningJobEventList

Object

FineTuningJobEventList

Name	Type	Description
data	FineTuningJobEvent[]	The list of items.
has_more	boolean	A value indicating whether the list contains more elements than returned.
object	TypeDiscriminator	TypeDiscriminator Defines the type of an object.

InnerError

Object

InnerError

Name	Type	Description
code	InnerErrorCode	InnerErrorCode Inner error codes as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
innererror	InnerError	InnerError Inner error as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

InnerErrorCode

Enumeration

InnerErrorCode

Value	Description
invalidPayload	The request data is invalid for this operation.

LogLevel

Enumeration

LogLevel

Value	Description
info	This event is for information only.
warning	This event represents a mitigated issue.
error	This message represents a non recoverable issue.

TypeDiscriminator

Enumeration

TypeDiscriminator

Value	Description
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).
batch	This object represents a batch.
upload	This object represents a file upload.
upload.part	This object represents part of a file upload.