Fine Tuning - Create

參考

Service:: Azure AI Services

API Version:: 2023-12-01-preview

建立作業，從指定的定型檔案微調指定的模型。回應包含加入佇列工作的詳細數據，包括作業狀態和超參數。微調模型的名稱會在完成之後新增至回應。

POST {endpoint}/openai/fine_tuning/jobs?api-version=2023-12-01-preview

URI 參數

名稱	位於	必要	類型	Description
endpoint	path	True	string url	支援的認知服務端點 (通訊協定和主機名，例如： https://aoairesource.openai.azure.com。將「aoairesource」取代為您的 Azure OpenAI 帳戶名稱) 。
api-version	query	True	string	要求的 API 版本。

要求標頭

名稱	必要	類型	Description
api-key	True	string	在這裡提供認知服務 Azure OpenAI 帳戶密鑰。

要求本文

名稱	必要	類型	Description
model	True	string	此微調所使用的基底模型) 標識碼 (標識碼。
training_file	True	string	檔案身分識別 (用於定型這個微調模型的檔案標識碼) 。
hyperparameters		FineTuningHyperParameters	FineTuningHyperParameters 微調作業中使用的超參數設定。
suffix		string	用來識別微調模型的後綴。後綴最多可以包含 40 個字元 (a-z、A-Z、0-9 和 _) ，這些字元將會新增至微調的模型名稱。
validation_file		string	檔案身分識別 (用來評估定型期間微調模型的檔案標識碼) 。

回應

名稱	類型	Description
201 Created	FineTuningJob	已成功建立微調。 Headers Location: string
Other Status Codes	ErrorResponse	發生錯誤。

名稱

類型

Description

201 Created

FineTuningJob

已成功建立微調。

Headers

Location: string

Other Status Codes

ErrorResponse

發生錯誤。

安全性

api-key

在這裡提供認知服務 Azure OpenAI 帳戶密鑰。

Type: apiKey
In: header

範例

Creating a fine tune job.

Sample Request

HTTP

POST https://aoairesource.openai.azure.com/openai/fine_tuning/jobs?api-version=2023-12-01-preview


{
  "model": "curie",
  "training_file": "file-181a1cbdcdcf4677ada87f63a0928099"
}

Sample Response

Status code:: 201

location: https://aoairesource.openai.azure.com/openai/fine_tuning/jobs/ft-72a2792ef7d24ba7b82c7fe4a37e379f

Response Body

{
  "hyperparameters": {
    "n_epochs": 2
  },
  "model": "curie",
  "training_file": "file-181a1cbdcdcf4677ada87f63a0928099",
  "id": "ft-72a2792ef7d24ba7b82c7fe4a37e379f",
  "status": "notRunning",
  "created_at": 1646126127,
  "updated_at": 1646127311,
  "object": "fine_tuning.job"
}

定義

名稱	Description
Error	錯誤
ErrorCode	ErrorCode
ErrorResponse	ErrorResponse
FineTuningHyperParameters	FineTuningHyperParameters
FineTuningJob	FineTuningJob
FineTuningJobCreation	FineTuningJobCreation
FineTuningState	FineTuningState
InnerError	InnerError
InnerErrorCode	InnerErrorCode
TypeDiscriminator	TypeDiscriminator

Error

錯誤

名稱	類型	Description
code	ErrorCode	ErrorCode Microsoft REST 指導方針中所定義的錯誤碼 (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses) 。
details	Error[]	如果有的話，錯誤詳細數據。
innererror	InnerError	InnerError Microsoft REST 指導方針中所定義的內部錯誤 () https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses 。
message	string	此錯誤的訊息。
target	string	如果有的話，發生錯誤的位置。

ErrorCode

名稱	類型	Description
conflict	string	要求的作業與目前的資源狀態衝突。
contentFilter	string	映射產生失敗，因為我們的安全系統。
fileImportFailed	string	檔案匯入失敗。
forbidden	string	目前使用者/api 金鑰禁止此作業。
internalFailure	string	內部錯誤。請再試一次。
invalidPayload	string	此作業的要求數據無效。
itemDoesAlreadyExist	string	專案已經存在。
jsonlValidationFailed	string	jsonl 數據的驗證失敗。
notFound	string	找不到資源。
quotaExceeded	string	超過配額。
serviceUnavailable	string	服務目前無法使用。
tooManyRequests	string	太多要求。請稍後重試。
unauthorized	string	目前的使用者/API 金鑰未獲授權進行作業。
unexpectedEntityState	string	作業無法以目前資源的狀態執行。

ErrorResponse

名稱	類型	Description
error	Error	錯誤 Microsoft REST 指導方針中所定義的錯誤內容 () https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses 。

FineTuningHyperParameters

名稱	類型	Description
batch_size	integer	用於定型的批次大小。批次大小是用來訓練單一向前和向後傳遞的訓練範例數目。一般而言，我們發現較大的批次大小通常較適合較大的資料集。這個屬性的預設值和最大值都是基底模型特有的。
learning_rate_multiplier	number	用於定型的學習速率乘數。微調學習速率是預先定型所用原始學習速率乘以此值。較大的學習速率通常會在較大的批次大小下執行較佳。建議您試驗 0.02 到 0.2 這個範圍內的值，看看哪些值會產生最佳結果。
n_epochs	integer	定型模型的 Epoch 數目。 Epoch 是指透過定型資料集的完整循環。

FineTuningJob

名稱	類型	Description
created_at	integer	在 unix epochs) 中建立此作業或項目的時間戳 (。
fine_tuned_model	string	產生的微調模型) 標識碼 (標識符。此屬性只會填入成功完成的微調執行。使用此標識碼來建立用於推斷的部署。
finished_at	integer	此作業或專案在 unix epochs) 中成功完成 (時的時間戳。
hyperparameters	FineTuningHyperParameters	FineTuningHyperParameters 微調作業中使用的超參數設定。
id	string	這個專案的身分識別。
model	string	用於微調之基底模型的標識碼 (模型標識碼) 。
object	TypeDiscriminator	TypeDiscriminator 定義物件的類型。
organisation_id	string	這個微調工作的組織標識碼。 Azure OpenAI 上未使用;僅限 OpenAI 的相容性。
result_files	string[]	結果檔案身分識別 (檔案標識碼) ，其中包含 csv 格式的定型和評估計量。此檔案僅適用於成功完成的微調執行。
status	FineTuningState	FineTuningState 微調物件或微調作業的狀態。
suffix	string	用來識別微調模型的後綴。後綴最多可以包含 40 個字元 (a-z、A-Z、0-9 和 _) ，這些字元將會新增至微調的模型名稱。
trained_tokens	integer	這個微調作業所處理的可計費令牌總數。
training_file	string	用於定型的檔案。
updated_at	integer	在 unix epochs () 中，修改此作業或項目的時間戳。
validation_file	string	用來在定型期間評估微調模型的檔案。

FineTuningJobCreation

名稱	類型	Description
hyperparameters	FineTuningHyperParameters	FineTuningHyperParameters 微調作業中使用的超參數設定。
model	string	此微調所使用的基底模型) 標識碼 (標識碼。
suffix	string	用來識別微調模型的後綴。後綴最多可以包含 40 個字元 (a-z、A-Z、0-9 和 _) ，這些字元將會新增至微調的模型名稱。
training_file	string	檔案身分識別 (用於定型這個微調模型的檔案標識碼) 。
validation_file	string	檔案身分識別 (用來評估定型期間微調模型的檔案標識碼) 。

FineTuningState

名稱	類型	Description
cancelled	string	作業已取消且不完整。它可以分類為終端機狀態。
created	string	作業已建立。 Azure OpenAI 不會傳回此狀態，而且只會針對相容性公開。它可以分類為非使用中狀態。
failed	string	作業已完成失敗的處理，無法進一步取用。它可以分類為終端機狀態。
pending	string	作業尚未排入佇列，未來要處理。它可以分類為非使用中狀態。
running	string	作業已開始處理。它可以分類為作用中狀態。
succeeded	string	作業已成功處理，並已準備好取用。它可以分類為終端機狀態。

InnerError

名稱	類型	Description
code	InnerErrorCode	InnerErrorCode Microsoft REST 指導方針中所定義的內部錯誤碼 (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses) 。
innererror	InnerError	InnerError Microsoft REST 指導方針中所定義的內部錯誤 () https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses 。

InnerErrorCode

名稱	類型	Description
invalidPayload	string	此作業的要求數據無效。

TypeDiscriminator

名稱	類型	Description
file	string	這個物件代表檔案。
fine-tune	string	這個物件代表微調作業。
fine-tune-event	string	這個物件代表微調作業的事件。
fine_tuning.job	string	這個物件代表微調作業。
fine_tuning.job.event	string	這個物件代表微調作業的事件。
list	string	這個物件代表其他物件的清單。
model	string	這個物件代表模型 (可以是基底模型或微調作業結果) 。

Share via

Fine Tuning - Create

URI 參數

要求標頭

要求本文

回應

安全性

api-key

範例

Creating a fine tune job.

Sample Request

Sample Response

定義

Error

ErrorCode

ErrorResponse

FineTuningHyperParameters

FineTuningJob

FineTuningJobCreation

FineTuningState

InnerError

InnerErrorCode

TypeDiscriminator

其他資源