Fine Tuning - List

參考

服務:: Azure AI Services

API 版本:: 2024-10-21

取得 Azure OpenAI 資源所擁有的所有微調作業清單。針對每個微調作業所傳回的詳細數據，除了其標識符之外，還有基底模型、定型和驗證檔案、超參數、時間戳、狀態和事件。當作業狀態變更，例如執行或完成，以及上傳結果時，就會建立事件。

GET {endpoint}/openai/fine_tuning/jobs?api-version=2024-10-21

含選擇性參數:

GET {endpoint}/openai/fine_tuning/jobs?after={after}&limit={limit}&api-version=2024-10-21

URI 參數

名稱	位於	必要	類型	Description
endpoint	path	True	string url	支援的認知服務端點（通訊協定和主機名，例如：https://aoairesource.openai.azure.com。以您的 Azure OpenAI 帳戶名稱取代「aoairesource」。。
api-version	query	True	string	要求的 API 版本。
after	query		string	上一個分頁要求中最後一個事件的標識碼。
limit	query		integer int32	要擷取的事件數目。預設值為 20。

要求標頭

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

回應

名稱	類型	Description
200 OK	FineTuningJobList	成功
Other Status Codes	ErrorResponse	發生錯誤。

安全性

api-key

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

類型: apiKey
位於: header

範例

Getting all fine tuning jobs owned by this account.

範例要求

HTTP

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

範例回覆

狀態碼:: 200

{
  "has_more": false,
  "data": [
    {
      "hyperparameters": {
        "n_epochs": -1
      },
      "status": "succeeded",
      "model": "curie",
      "fine_tuned_model": "curie.ft-72a2792ef7d24ba7b82c7fe4a37e379f",
      "training_file": "file-181a1cbdcdcf4677ada87f63a0928099",
      "result_files": [
        "file-181a1cbdcdcf4677ada87f63a0928099"
      ],
      "finished_at": 1646127311,
      "trained_tokens": 2342,
      "id": "ft-72a2792ef7d24ba7b82c7fe4a37e379f",
      "created_at": 1646126127,
      "object": "fine_tuning.job"
    }
  ],
  "object": "list"
}

定義

名稱	Description
Error	錯誤
ErrorCode	ErrorCode
ErrorResponse	ErrorResponse
FineTuningHyperParameters	FineTuningHyperParameters
FineTuningJob	FineTuningJob
FineTuningJobError	FineTuningJobError
FineTuningJobList	FineTuningJobList
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 中）。
error	FineTuningJobError	FineTuningJobError 針對失敗的微調作業，這將會包含失敗原因的詳細資訊。
estimated_finish	integer	微調作業估計完成時的 Unix 時間戳（以秒為單位）。如果微調作業未執行，此值將會是 Null。
fine_tuned_model	string	所產生微調模型的標識碼（model-id）。此屬性只會填入成功完成微調執行。使用此標識碼來建立用於推斷的部署。
finished_at	integer	此作業或專案成功完成時的時間戳（在 unix epochs 中）。
hyperparameters	FineTuningHyperParameters	FineTuningHyperParameters 微調作業中使用的超參數設定。
id	string	這個專案的身分識別。
model	string	用於微調之基底模型的標識碼（model-id）。
object	TypeDiscriminator	TypeDiscriminator 定義物件的型別。
organisation_id	string	這個微調工作的組織標識碼。未在 Azure OpenAI 上使用;僅限 OpenAI 的相容性。
result_files	string[]	結果檔案身分識別（file-id）包含 csv 格式的定型和評估計量。檔案僅適用於成功完成的微調執行。
seed	integer	用於微調工作的種子。
status	FineTuningState	FineTuningState 微調物件或微調作業的狀態。
suffix	string	用來識別微調模型的後綴。後綴最多可以包含 40 個字元（a-z、A-Z、0-9 和 _），這些字元會新增至微調的模型名稱。
trained_tokens	integer	這個微調作業所處理的可計費令牌總數。
training_file	string	用於定型的檔案。
validation_file	string	用來評估定型期間微調模型的檔案。

FineTuningJobError

名稱	類型	Description
code	string	計算機可讀取的錯誤碼。
message	string	人類可讀取的錯誤訊息。
param	string	無效的參數，通常training_file或validation_file。如果失敗不是參數特定，則此字段會是 Null。

FineTuningJobList

名稱	類型	Description
data	FineTuningJob[]	項目清單。
has_more	boolean	值，指出清單是否包含超過傳回的元素。
object	TypeDiscriminator	TypeDiscriminator 定義物件的型別。

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
batch	string	這個物件代表批次。
file	string	這個物件代表檔案。
fine_tuning.job	string	這個物件代表微調作業。
fine_tuning.job.checkpoint	string	這個物件代表微調作業的檢查點。
fine_tuning.job.event	string	這個物件代表微調作業的事件。
list	string	這個物件代表其他物件的清單。
model	string	這個物件代表模型（可以是基底模型或微調作業結果）。
upload	string	這個物件代表檔案上傳。
upload.part	string	這個物件代表檔案上傳的一部分。

共用方式為

Fine Tuning - List

URI 參數

要求標頭

回應

安全性

api-key

範例

Getting all fine tuning jobs owned by this account.

範例要求

範例回覆

定義

Error

ErrorCode

ErrorResponse

FineTuningHyperParameters

FineTuningJob

FineTuningJobError

FineTuningJobList

FineTuningState

InnerError

InnerErrorCode

TypeDiscriminator

其他資源