Files - Import
指定された URL からデータをインポートして、新しいファイル エンティティを作成します。 アップロードされたファイルは、たとえば、微調整されたモデルのトレーニングや評価に使用できます。
POST {endpoint}/openai/files/import?api-version=2024-02-01
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
endpoint
|
path | True |
string url |
サポートされている Cognitive Services エンドポイント (プロトコルとホスト名など): https://aoairesource.openai.azure.com"aoairesource" を Azure OpenAI アカウント名に置き換えます)。 |
api-version
|
query | True |
string |
要求された API バージョン。 |
要求ヘッダー
名前 | 必須 | 型 | 説明 |
---|---|---|---|
api-key | True |
string |
Cognitive Services Azure OpenAI アカウント キーをここで指定します。 |
要求本文
名前 | 必須 | 型 | 説明 |
---|---|---|---|
content_url | True |
string |
ドキュメントをダウンロードする URL (BLOB の SAS URL、または GET 要求でアクセスできるその他の外部 URL を指定できます)。 |
filename | True |
string |
アップロードする JSON Lines ファイルの名前。
|
purpose | True |
目的 |
応答
名前 | 型 | 説明 |
---|---|---|
201 Created |
ファイルが正常に作成されました。 Headers Location: string |
|
Other Status Codes |
Error |
エラーが発生しました。 |
セキュリティ
api-key
Cognitive Services Azure OpenAI アカウント キーをここで指定します。
Type:
apiKey
In:
header
例
Importing a file with a blob url as source.
Sample Request
POST https://aoairesource.openai.azure.com/openai/files/import?api-version=2024-02-01
{
"purpose": "fine-tune",
"filename": "puppy.jsonl",
"content_url": "https://www.contoso.com/trainingdata/puppy.jsonl"
}
Sample Response
location: https://aoairesource.openai.azure.com/openai/files/file-181a1cbdcdcf4677ada87f63a0928099
{
"purpose": "fine-tune",
"filename": "puppy.jsonl",
"id": "file-181a1cbdcdcf4677ada87f63a0928099",
"status": "notRunning",
"created_at": 1646126127,
"object": "file"
}
定義
名前 | 説明 |
---|---|
Error |
エラー |
Error |
ErrorCode |
Error |
ErrorResponse |
File |
ファイル |
File |
FileImport |
File |
FileState |
Inner |
InnerError |
Inner |
InnerErrorCode |
Purpose |
目的 |
Type |
TypeDiscriminator |
Error
エラー
名前 | 型 | 説明 |
---|---|---|
code |
Error |
ErrorCode |
details |
Error[] |
エラーの詳細 (使用可能な場合)。 |
innererror |
Inner |
InnerError |
message |
string |
このエラーのメッセージ。 |
target |
string |
エラーが発生した場所 (使用可能な場合)。 |
ErrorCode
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
ErrorResponse
名前 | 型 | 説明 |
---|---|---|
error |
エラー |
File
ファイル
名前 | 型 | 説明 |
---|---|---|
bytes |
integer |
使用可能な場合のこのファイルのサイズ (null を指定できます)。 JavaScript 整数との互換性を確保するために、2^53-1 より大きいファイル サイズはサポートされていません。 |
created_at |
integer |
このジョブまたは項目が (unix エポックで) 作成されたときのタイムスタンプ。 |
filename |
string |
ファイルの名前です。 |
id |
string |
このアイテムの ID。 |
object |
Type |
TypeDiscriminator |
purpose |
目的 |
|
status |
File |
FileState |
status_details |
string |
このファイルの処理に失敗した場合の詳細を含むエラー メッセージ。 |
FileImport
FileImport
名前 | 型 | 説明 |
---|---|---|
content_url |
string |
ドキュメントをダウンロードする URL (BLOB の SAS URL、または GET 要求でアクセスできるその他の外部 URL を指定できます)。 |
filename |
string |
アップロードする JSON Lines ファイルの名前。
|
purpose |
目的 |
FileState
FileState
名前 | 型 | 説明 |
---|---|---|
deleted |
string |
エンティティは削除されましたが、削除前の他のエンティティによって引き続き参照される可能性があります。 これは、終了状態として分類できます。 |
deleting |
string |
エンティティは削除するプロセスです。 この状態は Azure OpenAI によって返されず、互換性のためにのみ公開されます。 アクティブな状態として分類できます。 |
error |
string |
操作はエラーで処理を完了し、それ以上使用することはできません。 これは、終了状態として分類できます。 |
pending |
string |
操作が作成され、今後処理されるキューに登録されません。 非アクティブ状態として分類できます。 |
processed |
string |
操作は正常に処理され、使用する準備ができています。 これは、終了状態として分類できます。 |
running |
string |
操作の処理が開始されました。 アクティブな状態として分類できます。 |
uploaded |
string |
ファイルはアップロードされましたが、まだ処理されていません。 この状態は Azure OpenAI によって返されず、互換性のためにのみ公開されます。 非アクティブ状態として分類できます。 |
InnerError
InnerError
名前 | 型 | 説明 |
---|---|---|
code |
Inner |
InnerErrorCode |
innererror |
Inner |
InnerError |
InnerErrorCode
InnerErrorCode
名前 | 型 | 説明 |
---|---|---|
invalidPayload |
string |
この操作の要求データが無効です。 |
Purpose
目的
名前 | 型 | 説明 |
---|---|---|
fine-tune |
string |
このファイルには、微調整ジョブのトレーニング データが含まれています。 |
fine-tune-results |
string |
このファイルには、微調整ジョブの結果が含まれています。 |
TypeDiscriminator
TypeDiscriminator
名前 | 型 | 説明 |
---|---|---|
file |
string |
このオブジェクトはファイルを表します。 |
fine-tune |
string |
このオブジェクトは、微調整ジョブを表します。 |
fine-tune-event |
string |
このオブジェクトは、微調整ジョブのイベントを表します。 |
fine_tuning.job |
string |
このオブジェクトは、微調整ジョブを表します。 |
fine_tuning.job.event |
string |
このオブジェクトは、微調整ジョブのイベントを表します。 |
list |
string |
このオブジェクトは、他のオブジェクトの一覧を表します。 |
model |
string |
このオブジェクトは、モデルを表します (基本モデルまたは微調整ジョブの結果を指定できます)。 |