次の方法で共有

Files - Delete

  • リファレンス
サービス:
Azure AI Services
API バージョン:
2024-10-21

指定されたファイル ID を持つファイルを削除します。ファイルが微調整ジョブのトレーニング ファイルとして使用された場合など、削除も許可されます。

DELETE {endpoint}/openai/files/{file-id}?api-version=2024-10-21

URI パラメーター

名前 / 必須 型 説明
endpoint
 path True

string (url)

サポートされている Cognitive Services エンドポイント (プロトコルとホスト名など: https://aoairesource.openai.azure.com。"aoairesource" を Azure OpenAI アカウント名に置き換えます)。
file-id
 path True

string

ファイルの識別子。
api-version
 query True

string

要求された API バージョン。

要求ヘッダー

名前 必須 型 説明
api-key True

string

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

応答

名前 型 説明
200 OK

FileDelete

ファイルが正常に削除されました。
Other Status Codes

ErrorResponse

エラーが発生しました。

セキュリティ

api-key

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

型: apiKey
/: header

例

Deleting a file.

要求のサンプル

DELETE https://aoairesource.openai.azure.com/openai/files/file-181a1cbdcdcf4677ada87f63a0928099?api-version=2024-10-21

応答のサンプル

状態コード:
200 
{
  "object": "file",
  "deleted": true,
  "id": "file-181a1cbdcdcf4677ada87f63a0928099"
}

定義

名前 説明
Error

エラー
ErrorCode

ErrorCode
ErrorResponse

ErrorResponse
FileDelete

FileDelete
InnerError

InnerError
InnerErrorCode

InnerErrorCode
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) で定義されているエラー コンテンツ。

FileDelete

Object

FileDelete

名前 型 説明
deleted

boolean

ファイルが削除されたかどうかを取得するかどうかを示す値。
id

string

minLength: 1

削除されたファイル ID。
object

TypeDiscriminator

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

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

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

TypeDiscriminator

列挙

TypeDiscriminator

値 説明
batch

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

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

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

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

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

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

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

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

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