Files - Upload

服務:

Azure AI Services

API 版本:

2024-10-21

從本機計算機上傳數據，以建立新的檔案實體。 例如，上傳的檔案可用於定型或評估微調的模型。

POST {endpoint}/openai/files?api-version=2024-10-21

URI 參數

名稱	位於	必要	類型	Description
file	formData	True	file	取得或設定要上傳至 Azure OpenAI 的檔案。
purpose	formData	True	Purpose	上傳檔的目的。 使用 「fine-tune」 進行微調。 這可讓我們驗證已上傳檔案的格式。
endpoint	path	True	string url	支援的認知服務端點（通訊協定和主機名，例如：https://aoairesource.openai.azure.com。以您的 Azure OpenAI 帳戶名稱取代 「aoairesource」。。
api-version	query	True	string	要求的 API 版本。

要求標頭

Media Types: "multipart/form-data"

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

回應

名稱	類型	Description
201 Created	File	已成功建立檔案。 標題 Location: string
Other Status Codes	ErrorResponse	發生錯誤。

安全性

api-key

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

類型: apiKey
位於: header

範例

Upload a file.

範例要求

HTTP

POST https://aoairesource.openai.azure.com/openai/files?api-version=2024-10-21

範例回覆

狀態碼:

201

location: https://aoairesource.openai.azure.com/openai/files/file-181a1cbdcdcf4677ada87f63a0928099

{
  "status": "pending",
  "purpose": "fine-tune",
  "filename": "puppy.jsonl",
  "id": "file-181a1cbdcdcf4677ada87f63a0928099",
  "created_at": 1646126127,
  "object": "file"
}

定義

名稱	Description
Error	錯誤
ErrorCode	ErrorCode
ErrorResponse	ErrorResponse
File	檔
FileState	FileState
InnerError	InnerError
InnerErrorCode	InnerErrorCode
Purpose	目的
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

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

ErrorResponse

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

File

檔

名稱	類型	Description
bytes	integer	可用時此檔案的大小（可以是 Null）。 不支援大於 2^53-1 的檔案大小，以確保與 JavaScript 整數相容。
created_at	integer	建立此作業或項目時的時間戳（在 unix epochs 中）。
filename	string	檔名。
id	string	這個專案的身分識別。
object	TypeDiscriminator	TypeDiscriminator 定義物件的型別。
purpose	Purpose	目的 上傳檔的目的。 使用 「fine-tune」 進行微調。 這可讓我們驗證已上傳檔案的格式。
status	FileState	FileState 檔案的狀態。
status_details	string	當處理此檔案失敗時，有詳細數據的錯誤訊息。

FileState

FileState

名稱	類型	Description
deleted	string	實體已刪除，但可能仍會由其他實體參考，以先刪除。 它可以分類為終端機狀態。
deleting	string	實體是要刪除的進程。 Azure OpenAI 不會傳回此狀態，而且只會為了相容性而公開。 它可以分類為作用中狀態。
error	string	作業已完成失敗的處理，無法進一步取用。 它可以分類為終端機狀態。
pending	string	作業已建立，且不會排入佇列以在未來進行處理。 它可以分類為非使用中狀態。
processed	string	作業已成功處理，且已準備好取用。 它可以分類為終端機狀態。
running	string	作業已開始處理。 它可以分類為作用中狀態。
uploaded	string	檔案已上傳，但尚未處理。 Azure OpenAI 不會傳回此狀態，而且只會為了相容性而公開。 它可以分類為非使用中狀態。

InnerError

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

InnerErrorCode

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

Purpose

目的

名稱	類型	Description
assistants	string	此檔案包含要用於助理的數據。
assistants_output	string	此檔案包含助理的結果。
batch	string	此檔案包含批次的輸入數據。
batch_output	string	此檔案包含批次的結果。
fine-tune	string	此檔案包含微調作業的定型數據。
fine-tune-results	string	此檔案包含微調作業的結果。

TypeDiscriminator

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	這個物件代表檔案上傳的一部分。