Files - Upload

リファレンス

サービス:: Azure AI Services

API バージョン:: 2024-10-21

ローカルコンピューターからデータをアップロードして、新しいファイルエンティティを作成します。アップロードされたファイルは、たとえば、微調整されたモデルのトレーニングや評価に使用できます。

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

URI パラメーター

名前	/	必須	型	説明
file	formData	True	file	Azure OpenAI にアップロードするファイルを取得または設定します。
purpose	formData	True	Purpose	アップロードされたドキュメントの目的。微調整には "微調整" を使用します。これにより、アップロードされたファイルの形式を検証できます。
endpoint	path	True	string url	サポートされている Cognitive Services エンドポイント (プロトコルとホスト名など: https://aoairesource.openai.azure.com。"aoairesource" を Azure OpenAI アカウント名に置き換えます)。
api-version	query	True	string	要求された API バージョン。

要求ヘッダー

Media Types: "multipart/form-data"

名前	必須	型	説明
api-key	True	string	コグニティブサービスの Azure OpenAI アカウントキーをここで指定します。

応答

名前	型	説明
201 Created	File	ファイルが正常に作成されました。ヘッダー Location: string
Other Status Codes	ErrorResponse	エラーが発生しました。

名前

型

説明

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"
}

定義

名前	説明
Error	エラー
ErrorCode	ErrorCode
ErrorResponse	ErrorResponse
File	ファイル
FileState	FileState
InnerError	InnerError
InnerErrorCode	InnerErrorCode
Purpose	目的
TypeDiscriminator	TypeDiscriminator

Error

エラー

名前	型	説明
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

名前	型	説明
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

名前	型	説明
error	Error	エラー Microsoft REST ガイドライン (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses) で定義されているエラーコンテンツ。

File

ファイル

名前	型	説明
bytes	integer	使用可能な場合は、このファイルのサイズ (null を指定できます)。 JavaScript 整数との互換性を確保するために、2^53-1 より大きいファイルサイズはサポートされていません。
created_at	integer	このジョブまたは項目が作成されたときのタイムスタンプ (unix エポック)。
filename	string	ファイルの名前。
id	string	この項目の ID。
object	TypeDiscriminator	TypeDiscriminator オブジェクトの型を定義します。
purpose	Purpose	目的アップロードされたドキュメントの目的。微調整には "微調整" を使用します。これにより、アップロードされたファイルの形式を検証できます。
status	FileState	FileState ファイルの状態。
status_details	string	このファイルの処理に失敗した場合の詳細を含むエラーメッセージ。

FileState

名前	型	説明
deleted	string	エンティティは削除されましたが、削除前の他のエンティティによって引き続き参照される可能性があります。これは、終了状態として分類できます。
deleting	string	エンティティは削除するプロセスです。この状態は Azure OpenAI によって返されず、互換性のためにのみ公開されます。アクティブな状態として分類できます。
error	string	操作はエラーで処理を完了しており、それ以上使用することはできません。これは、終了状態として分類できます。
pending	string	操作が作成され、今後処理されるキューにありません。非アクティブな状態として分類できます。
processed	string	操作が正常に処理され、使用する準備が整いました。これは、終了状態として分類できます。
running	string	操作の処理が開始されました。アクティブな状態として分類できます。
uploaded	string	ファイルはアップロードされましたが、まだ処理されていません。この状態は Azure OpenAI によって返されず、互換性のためにのみ公開されます。非アクティブな状態として分類できます。

InnerError

名前	型	説明
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

名前	型	説明
invalidPayload	string	要求データがこの操作に対して無効です。

Purpose

目的

名前	型	説明
assistants	string	このファイルには、アシスタントで使用するデータが含まれています。
assistants_output	string	このファイルには、アシスタントの結果が含まれています。
batch	string	このファイルには、バッチの入力データが含まれています。
batch_output	string	このファイルには、バッチの結果が含まれています。
fine-tune	string	このファイルには、微調整ジョブのトレーニングデータが含まれています。
fine-tune-results	string	このファイルには、微調整ジョブの結果が含まれています。

TypeDiscriminator

名前	型	説明
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	このオブジェクトは、ファイルのアップロードの一部を表します。

次の方法で共有

Files - Upload

URI パラメーター

要求ヘッダー

応答

セキュリティ

api-key

例

Upload a file.

要求のサンプル

応答のサンプル

定義

Error

ErrorCode

ErrorResponse

File

FileState

InnerError

InnerErrorCode

Purpose

TypeDiscriminator

その他のリソース