Fine Tuning - Get Events

Reference

Service:: Azure AI Services

API Version:: 2024-08-01-preview

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-08-01-preview

With optional parameters:

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

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.

Responses

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

Security

api-key

API key authentication

Type: apiKey
In: header

OAuth2Auth

OAuth2 authentication

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Scopes

Name	Description
https://cognitiveservices.azure.com/.default

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-08-01-preview

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

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	The message of this error.
target	string	The location where the error happened if available.

ErrorCode

Name	Type	Description
conflict	string	The requested operation conflicts with the current resource state.
contentFilter	string	Image generation failed as a result of our safety system.
fileImportFailed	string	Import of file failed.
forbidden	string	The operation is forbidden for the current user/api key.
internalFailure	string	Internal error. Please retry.
invalidPayload	string	The request data is invalid for this operation.
itemDoesAlreadyExist	string	The item does already exist.
jsonlValidationFailed	string	Validation of jsonl data failed.
notFound	string	The resource is not found.
quotaExceeded	string	Quota exceeded.
serviceUnavailable	string	The service is currently not available.
tooManyRequests	string	Too many requests. Please retry later.
unauthorized	string	The current user/api key is not authorized for the operation.
unexpectedEntityState	string	The operation cannot be executed in the current resource's state.

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

Name	Type	Description
message	string	Event only contains human readable messages.
metrics	string	Event contains metrics.

FineTuningJobEvent

Name	Type	Description
created_at	integer	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	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

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

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

Name	Type	Description
invalidPayload	string	The request data is invalid for this operation.

LogLevel

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

TypeDiscriminator

Name	Type	Description
file	string	This object represents a file.
fine_tuning.job	string	This object represents a fine tune job.
fine_tuning.job.checkpoint	string	This object represents a checkpoint of a fine tuning job.
fine_tuning.job.event	string	This object represents an event of a fine tuning job.
list	string	This object represents a list of other objects.
model	string	This object represents a model (can be a base model or fine tune job result).
upload	string	This object represents a file upload.
upload.part	string	This object represents part of a file upload.

Share via