Files - Upload File
他の操作で使用するファイルをアップロードします。
POST {endpoint}/files?api-version=v1URI パラメーター
| 名前 | / | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
file
|
formData | True |
file |
ファイル データ (バイト単位)。 |
|
purpose
|
formData | True |
アップロードされたファイルの意図された目的。 エージェントとメッセージファイルには |
|
|
filename
|
formData |
string |
ファイルの名前。 |
|
|
endpoint
|
path | True |
string (uri) |
次の形式のプロジェクトエンドポイント: https://.services.ai.azure.com/api/projects/ |
|
api-version
|
query | True |
string minLength: 1 |
この操作に使用する API バージョン。 |
応答
| 名前 | 型 | 説明 |
|---|---|---|
| 200 OK |
アップロードされたファイルの表現。 |
|
| Other Status Codes |
予期しないエラー応答。 |
セキュリティ
OAuth2Auth
型:
oauth2
フロー:
implicit
Authorization URL (承認 URL):
https://login.microsoftonline.com/common/oauth2/v2.0/authorize
スコープ
| 名前 | 説明 |
|---|---|
| https://ai.azure.com/.default |
定義
| 名前 | 説明 |
|---|---|
|
Agent |
エージェント API によって返されるエラー情報について説明します。 |
| AgentV1Error |
エージェント API によって返されたエラー ペイロード。 |
|
File |
モデルを呼び出してツールを使用できるエージェントを表します。 |
|
File |
ファイルの使用目的を示す指定可能な値。 |
|
File |
ファイルの状態。 |
AgentErrorDetail
エージェント API によって返されるエラー情報について説明します。
| 名前 | 型 | 説明 |
|---|---|---|
| code |
string |
機械可読のエラーコード。 |
| message |
string |
エラーの人間が判読できる説明。 |
| param |
string |
エラーの原因となったパラメータの名前 (該当する場合)。 |
| type |
string |
エラータイプ識別子(例: |
AgentV1Error
エージェント API によって返されたエラー ペイロード。
| 名前 | 型 | 説明 |
|---|---|---|
| error |
エラーを表します。 |
FileInfo
モデルを呼び出してツールを使用できるエージェントを表します。
| 名前 | 型 | 説明 |
|---|---|---|
| bytes |
integer (int32) |
ファイル サイズ (バイト単位)。 |
| created_at |
integer (unixtime) |
このオブジェクトが作成された時刻を表す Unix タイムスタンプ (秒単位)。 |
| filename |
string |
ファイルの名前。 |
| id |
string |
API エンドポイントで参照できる識別子。 |
| object |
enum:
file |
オブジェクトの種類。これは常に 'file' です。 |
| purpose |
ファイルの目的。 |
|
| status |
ファイルの状態。 このフィールドは、Azure OpenAI でのみ使用できます。 |
|
| status_details |
string |
このファイルの処理に失敗した場合の詳細を含むエラー メッセージ。 このフィールドは、Azure OpenAI でのみ使用できます。 |
FilePurpose
ファイルの使用目的を示す指定可能な値。
| 値 | 説明 |
|---|---|
| assistants |
ファイルがエージェントへの入力として使用されることを示します。 |
| assistants_output |
ファイルがエージェントによって出力として使用されることを示します。 |
| vision |
ファイルがビジョン操作への入力として使用されることを示します。 |
FileState
ファイルの状態。
| 値 | 説明 |
|---|---|
| deleted |
エンティティは削除されましたが、削除前の他のエンティティによって引き続き参照される可能性があります。 これは、終了状態として分類できます。 |
| deleting |
エンティティは削除処理中です。 この状態は Azure OpenAI によって返されず、互換性のためにのみ公開されます。 アクティブな状態として分類できます。 |
| error |
操作はエラーで処理を完了しており、それ以上使用することはできません。 これは、終了状態として分類できます。 |
| pending |
操作が作成され、今後処理されるキューにありません。 非アクティブな状態として分類できます。 |
| processed |
操作が正常に処理され、消費する準備が整いました。 これは、終了状態として分類できます。 |
| running |
操作の処理が開始されました。 アクティブな状態として分類できます。 |
| uploaded |
ファイルはアップロードされましたが、まだ処理されていません。 この状態は Azure OpenAI によって返されず、互換性のためにのみ公開されます。 非アクティブな状態として分類できます。 |