次の方法で共有

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

エラーが発生しました。

セキュリティ

api-key

コグニティブ サービスの Azure OpenAI アカウント キーをここで指定します。

型: apiKey
/: header

例

Upload a file.

要求のサンプル

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

Object

エラー

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

minLength: 1

このエラーのメッセージ。
target

string

エラーが発生した場所 (使用可能な場合)。

ErrorCode

列挙

ErrorCode

値 説明
conflict

要求された操作が現在のリソースの状態と競合しています。
contentFilter

安全システムの結果、画像の生成に失敗しました。
fileImportFailed

ファイルのインポートに失敗しました。
forbidden

この操作は、現在のユーザー/API キーでは禁止されています。
internalFailure

内部エラー。 再試行してください。
invalidPayload

要求データがこの操作に対して無効です。
itemDoesAlreadyExist

項目は既に存在します。
jsonlValidationFailed

jsonl データの検証に失敗しました。
notFound

リソースが見つかりません。
quotaExceeded

クォータを超えました。
serviceUnavailable

このサービスは現在使用できません。
tooManyRequests

要求が多すぎます。 後で再試行してください。
unauthorized

現在のユーザー/API キーは、操作に対して承認されていません。
unexpectedEntityState

この操作は、現在のリソースの状態では実行できません。

ErrorResponse

Object

ErrorResponse

名前 型 説明
error

Error

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

File

Object

ファイル

名前 型 説明
bytes

integer (int64)

使用可能な場合は、このファイルのサイズ (null を指定できます)。 JavaScript 整数との互換性を確保するために、2^53-1 より大きいファイル サイズはサポートされていません。
created_at

integer (unixtime)

このジョブまたは項目が作成されたときのタイムスタンプ (unix エポック)。
filename

string

minLength: 1

ファイルの名前。
id

string

この項目の ID。
object

TypeDiscriminator

TypeDiscriminator
オブジェクトの型を定義します。
purpose

Purpose

目的
アップロードされたドキュメントの目的。 微調整には "微調整" を使用します。 これにより、アップロードされたファイルの形式を検証できます。
status

FileState

FileState
ファイルの状態。
status_details

string

このファイルの処理に失敗した場合の詳細を含むエラー メッセージ。

FileState

列挙

FileState

値 説明
deleted

エンティティは削除されましたが、削除前の他のエンティティによって引き続き参照される可能性があります。 これは、終了状態として分類できます。
deleting

エンティティは削除するプロセスです。 この状態は Azure OpenAI によって返されず、互換性のためにのみ公開されます。 アクティブな状態として分類できます。
error

操作はエラーで処理を完了しており、それ以上使用することはできません。 これは、終了状態として分類できます。
pending

操作が作成され、今後処理されるキューにありません。 非アクティブな状態として分類できます。
processed

操作が正常に処理され、使用する準備が整いました。 これは、終了状態として分類できます。
running

操作の処理が開始されました。 アクティブな状態として分類できます。
uploaded

ファイルはアップロードされましたが、まだ処理されていません。 この状態は Azure OpenAI によって返されず、互換性のためにのみ公開されます。 非アクティブな状態として分類できます。

InnerError

Object

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

列挙

InnerErrorCode

値 説明
invalidPayload

要求データがこの操作に対して無効です。

Purpose

列挙

目的

値 説明
assistants

このファイルには、アシスタントで使用するデータが含まれています。
assistants_output

このファイルには、アシスタントの結果が含まれています。
batch

このファイルには、バッチの入力データが含まれています。
batch_output

このファイルには、バッチの結果が含まれています。
fine-tune

このファイルには、微調整ジョブのトレーニング データが含まれています。
fine-tune-results

このファイルには、微調整ジョブの結果が含まれています。

TypeDiscriminator

列挙

TypeDiscriminator

値 説明
batch

このオブジェクトはバッチを表します。
file

このオブジェクトはファイルを表します。
fine_tuning.job

このオブジェクトは、微調整ジョブを表します。
fine_tuning.job.checkpoint

このオブジェクトは、微調整ジョブのチェックポイントを表します。
fine_tuning.job.event

このオブジェクトは、微調整ジョブのイベントを表します。
list

このオブジェクトは、他のオブジェクトの一覧を表します。
model

このオブジェクトは、モデルを表します (基本モデルまたは微調整ジョブの結果を指定できます)。
upload

このオブジェクトは、ファイルのアップロードを表します。
upload.part

このオブジェクトは、ファイルのアップロードの一部を表します。