Files - Delete

Service:

Azure AI Services

API Version:

2024-02-01

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

DELETE {endpoint}/openai/files/{file-id}?api-version=2024-02-01

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	Cognitive Services Azure OpenAI アカウント キーをここで指定します。

応答

名前	型	説明
204 No Content		ファイルが正常に削除されました。
Other Status Codes	ErrorResponse	エラーが発生しました。

セキュリティ

api-key

Cognitive Services Azure OpenAI アカウント キーをここで指定します。

Type: apiKey
In: header

例

Deleting a file.

Sample Request

HTTP

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

Sample Response

Status code:

204

定義

名前	説明
Error	エラー
ErrorCode	ErrorCode
ErrorResponse	ErrorResponse
InnerError	InnerError
InnerErrorCode	InnerErrorCode

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

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

InnerError

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	string	この操作の要求データが無効です。