Microsoft Foundry Models での OpenAI のAzure REST API プレビュー リファレンスの作成

この記事では、Azure OpenAI の推論 REST API エンドポイントについて詳しく説明します。

API specs

Azure OpenAI モデルとリソースの管理と操作は、3 つの主要な API サーフェスに分かれています。

• Control plane
• データ プレーン - 作成
• データ プレーン - 推論

各 API surface/仕様は、Azure OpenAI 機能の異なるセットをカプセル化します。 各 API には、プレビューと安定または一般提供 (GA) API リリースの独自のセットがあります。 現在、プレビュー リリースは毎月のペースで行われる傾向があります。

Authentication

Azure OpenAI には、認証に 2 つの方法があります。 API キーまたはMicrosoft Entra IDを使用できます。

• API キー認証: この種類の認証の場合、すべての API 要求で、api-key HTTP ヘッダーに API キーを含める必要があります。 クイック スタートに、この種類の認証を使用して呼び出しを行う方法に関するガイダンスが用意されています。

• Microsoft Entra ID 認証: Microsoft Entra トークンを使用して API 呼び出しを認証できます。 認証トークンは、Authorization ヘッダーとして要求に含まれます。 指定するトークンの前に Bearer を付ける必要があります (例: Bearer YOUR_AUTH_TOKEN)。 Microsoft Entra IDに関するハウツー ガイドを読>。

REST API のバージョン管理

サービス API は、api-version クエリ パラメーターを使用してバージョン管理されます。 すべてのバージョンは、YYYY-MM-DD 日付構造に従います。 For example:

POST https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/chat/completions?api-version=2024-06-01

データ プレーンの作成

この記事の残りの部分では、Azure OpenAI データ プレーン推論仕様 (2025-04-01-preview) のプレビュー リリースについて説明します。

最新の GA API リリースに関するドキュメントをお探しの場合は、最新の GA データ プレーン推論 API に関する記事を参照してください

バッチ - リスト

GET {endpoint}/openai/batches?api-version=2025-04-01-preview

Azure OpenAI リソースによって所有されているすべてのバッチの一覧を取得します。

URI Parameters

Request Header

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

Responses

状態コード: 200

Description: Success

状態コード: 既定値

説明: エラーが発生しました。

Examples

GET {endpoint}/openai/batches?api-version=2025-04-01-preview

応答: 状態コード: 200

{
  "headers": {},
  "body": {
    "has_more": false,
    "data": [
      {
        "object": "batch",
        "id": "batch_72a2792ef7d24ba7b82c7fe4a37e379f",
        "endpoint": "/chat/completions",
        "errors": null,
        "input_file_id": "file-b4fa7277f3eb4722ac18b90f46102c3f",
        "completion_window": "24h",
        "status": "completed",
        "output_file_id": "file-f2ddaf43-b48b-46dd-b264-90da10c7a85b",
        "error_file_id": "file-c3b563b0-ebc7-47da-93e3-a2fa694aef0c",
        "created_at": 1646126127,
        "in_progress_at": 1646126130,
        "expires_at": 1646126170,
        "finalizing_at": 1646126134,
        "completed_at": 1646126136,
        "failed_at": null,
        "expired_at": null,
        "cancelling_at": null,
        "cancelled_at": null,
        "request_counts": {
          "total": 500,
          "completed": 400,
          "failed": 100
        },
        "first_id": "batch_abc123",
        "last_id": "batch_abc456",
        "metadata": {
          "batch_description": "Evaluation job"
        }
      }
    ],
    "object": "list"
  }
}

バッチの作成

POST {endpoint}/openai/batches?api-version=2025-04-01-preview

アップロードされた要求ファイルからバッチを作成して実行します。

応答には、ジョブの状態を含むエンキューされたジョブの詳細が含まれます。

完了すると、結果ファイルの ID が応答に追加されます。

URI Parameters

Request Header

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

Request Body

Content-Type: application/json

Responses

状態コード: 201

説明: バッチが正常に作成されました。

状態コード: 既定値

説明: エラーが発生しました。

Examples

POST {endpoint}/openai/batches?api-version=2025-04-01-preview

応答: 状態コード: 201

{
  "headers": {
    "deployment-enqueued-tokens": 1000,
    "deployment-maximum-enqueued-tokens": 5000
  },
  "body": {
    "object": "batch",
    "id": "batch_72a2792ef7d24ba7b82c7fe4a37e379f",
    "endpoint": "/chat/completions",
    "errors": null,
    "input_file_id": "file-b4fa7277f3eb4722ac18b90f46102c3f",
    "completion_window": "24h",
    "status": "validating",
    "output_file_id": null,
    "error_file_id": null,
    "created_at": 1646126127,
    "in_progress_at": null,
    "expires_at": null,
    "finalizing_at": null,
    "completed_at": null,
    "failed_at": null,
    "expired_at": null,
    "cancelling_at": null,
    "cancelled_at": null,
    "request_counts": {
      "total": 0,
      "completed": 0,
      "failed": 0
    },
    "metadata": {
      "batch_description": "Evaluation job"
    }
  }
}

バッチ - 取得

GET {endpoint}/openai/batches/{batch-id}?api-version=2025-04-01-preview

指定されたバッチ ID で指定された 1 つのバッチの詳細を取得します。

URI Parameters

Request Header

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

Responses

状態コード: 200

Description: Success

状態コード: 既定値

説明: エラーが発生しました。

Examples

GET {endpoint}/openai/batches/{batch-id}?api-version=2025-04-01-preview

応答: 状態コード: 200

{
  "headers": {},
  "body": {
    "object": "batch",
    "id": "batch_72a2792ef7d24ba7b82c7fe4a37e379f",
    "endpoint": "/chat/completions",
    "errors": null,
    "input_file_id": "file-b4fa7277f3eb4722ac18b90f46102c3f",
    "completion_window": "24h",
    "status": "completed",
    "output_file_id": "file-f2ddaf43-b48b-46dd-b264-90da10c7a85b",
    "error_file_id": "file-c3b563b0-ebc7-47da-93e3-a2fa694aef0c",
    "created_at": 1646126127,
    "in_progress_at": 1646126130,
    "expires_at": 1646126170,
    "finalizing_at": 1646126134,
    "completed_at": 1646126136,
    "failed_at": null,
    "expired_at": null,
    "cancelling_at": null,
    "cancelled_at": null,
    "request_counts": {
      "total": 500,
      "completed": 400,
      "failed": 100
    },
    "metadata": {
      "batch_description": "Evaluation job"
    }
  }
}

バッチ - キャンセル

POST {endpoint}/openai/batches/{batch-id}/cancel?api-version=2025-04-01-preview

指定されたバッチ ID で指定されたバッチの処理を取り消します。

URI Parameters

Request Header

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

Responses

状態コード: 200

説明: バッチが正常に取り消されました。

状態コード: 既定値

説明: エラーが発生しました。

Examples

POST {endpoint}/openai/batches/{batch-id}/cancel?api-version=2025-04-01-preview

応答: 状態コード: 200

{
  "headers": {},
  "body": {
    "object": "batch",
    "id": "batch_72a2792ef7d24ba7b82c7fe4a37e379f",
    "endpoint": "/chat/completions",
    "errors": null,
    "input_file_id": "file-b4fa7277f3eb4722ac18b90f46102c3f",
    "completion_window": "24h",
    "status": "cancelling",
    "output_file_id": null,
    "error_file_id": null,
    "created_at": 1646126127,
    "in_progress_at": 1646126130,
    "expires_at": 1646126170,
    "finalizing_at": null,
    "completed_at": null,
    "failed_at": null,
    "expired_at": null,
    "cancelling_at": 1646126138,
    "cancelled_at": null,
    "request_counts": {
      "total": 500,
      "completed": 100,
      "failed": 5
    },
    "metadata": {
      "batch_description": "Evaluation job"
    }
  }
}

格納済み入力候補 - 一覧表示

GET {endpoint}/openai/chat/completions?api-version=2025-04-01-preview

格納されている入力候補の一覧を取得します。

URI Parameters

Request Header

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

Responses

状態コード: 200

Description: Success

状態コード: 既定値

説明: エラーが発生しました。

Examples

GET {endpoint}/openai/chat/completions?api-version=2025-04-01-preview

応答: 状態コード: 200

{
  "headers": {},
  "body": {
    "object": "list",
    "data": [
      {
        "id": "chatcmpl-AvBCKqg2xqxVHCCEnUB4Bgj1Bjl7Y",
        "model": "gpt-4o-mini-2024-07-18",
        "created": 1738193475,
        "request_id": "e539c139-a97d-4ee1-bde9-3be3d5c6edb5",
        "usage": {
          "total_tokens": 25,
          "completion_tokens": 7,
          "prompt_tokens": 18
        },
        "seed": 123,
        "top_p": 1,
        "temperature": 1,
        "presence_penalty": 0,
        "frequency_penalty": 0,
        "system_fingerprint": "fp_f3927aa00d",
        "metadata": {
          "key_1": "val_1",
          "key_2": "val_2"
        },
        "choices": [
          {
            "index": 0,
            "message": {
              "content": "Hello, how are you?",
              "role": "assistant"
            },
            "finish_reason": "stop"
          }
        ]
      }
    ],
    "total": 1,
    "first_id": "chatcmpl-AvBCKqg2xqxVHCCEnUB4Bgj1Bjl7Y",
    "last_id": "chatcmpl-AvBCKqg2xqxVHCCEnUB4Bgj1Bjl7Y",
    "has_more": false
  }
}

格納済み入力候補 - 取得

GET {endpoint}/openai/chat/completions/{stored-completion-id}?api-version=2025-04-01-preview

格納されている完了 ID を指定して、格納されている完了を取得します。

URI Parameters

Request Header

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

Responses

状態コード: 200

Description: Success

状態コード: 既定値

説明: エラーが発生しました。

Examples

GET {endpoint}/openai/chat/completions/{stored-completion-id}?api-version=2025-04-01-preview

応答: 状態コード: 200

{
  "headers": {},
  "body": {
    "object": "chat.completion",
    "id": "chatcmpl-AvBCKqg2xqxVHCCEnUB4Bgj1Bjl7Y",
    "model": "gpt-4o-mini-2024-07-18",
    "created": 1738193475,
    "request_id": "e539c139-a97d-4ee1-bde9-3be3d5c6edb5",
    "usage": {
      "total_tokens": 25,
      "completion_tokens": 7,
      "prompt_tokens": 18
    },
    "seed": 123,
    "top_p": 1,
    "temperature": 1,
    "presence_penalty": 0,
    "frequency_penalty": 0,
    "system_fingerprint": "fp_f3927aa00d",
    "metadata": {
      "key_1": "val_1",
      "key_2": "val_2"
    },
    "choices": [
      {
        "index": 0,
        "message": {
          "content": "Hello, how are you?",
          "role": "assistant"
        },
        "finish_reason": "stop"
      }
    ]
  }
}

格納済み入力候補 - 更新

POST {endpoint}/openai/chat/completions/{stored-completion-id}?api-version=2025-04-01-preview

格納されている完了を、指定された格納済み完了 ID で更新します。

URI Parameters

Request Header

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

Request Body

Content-Type: application/json

Responses

状態コード: 200

Description: Success

状態コード: 既定値

説明: エラーが発生しました。

Examples

POST {endpoint}/openai/chat/completions/{stored-completion-id}?api-version=2025-04-01-preview

応答: 状態コード: 200

{
  "headers": {},
  "body": {
    "object": "chat.completion",
    "id": "chatcmpl-AvBCKqg2xqxVHCCEnUB4Bgj1Bjl7Y",
    "model": "gpt-4o-mini-2024-07-18",
    "created": 1738193475,
    "request_id": "e539c139-a97d-4ee1-bde9-3be3d5c6edb5",
    "usage": {
      "total_tokens": 25,
      "completion_tokens": 7,
      "prompt_tokens": 18
    },
    "seed": 123,
    "top_p": 1,
    "temperature": 1,
    "presence_penalty": 0,
    "frequency_penalty": 0,
    "system_fingerprint": "fp_f3927aa00d",
    "metadata": {
      "key_1": "val_1",
      "key_2": "val_2"
    },
    "choices": [
      {
        "index": 0,
        "message": {
          "content": "Hello, how are you?",
          "role": "assistant"
        },
        "finish_reason": "stop"
      }
    ]
  }
}

格納済み入力候補 - 削除

DELETE {endpoint}/openai/chat/completions/{stored-completion-id}?api-version=2025-04-01-preview

指定された格納済み完了 ID によって、格納されている完了を削除します。

URI Parameters

Request Header

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

Responses

状態コード: 200

説明: 格納された完了が正常に削除されました。

状態コード: 既定値

説明: エラーが発生しました。

Examples

DELETE {endpoint}/openai/chat/completions/{stored-completion-id}?api-version=2025-04-01-preview

応答: 状態コード: 200

{
  "headers": {},
  "body": {
    "object": "chat.completion.deleted",
    "id": "chatcmpl-AvBCKqg2xqxVHCCEnUB4Bgj1Bjl7Y",
    "deleted": true
  }
}

格納済み入力候補 - Getmessages

GET {endpoint}/openai/chat/completions/{stored-completion-id}/messages?api-version=2025-04-01-preview

格納されている完了メッセージを、指定された格納済み完了 ID で取得します。

URI Parameters

Request Header

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

Responses

状態コード: 200

Description: Success

状態コード: 既定値

説明: エラーが発生しました。

Examples

GET {endpoint}/openai/chat/completions/{stored-completion-id}/messages?api-version=2025-04-01-preview

応答: 状態コード: 200

{
  "headers": {},
  "body": {
    "object": "list",
    "data": [
      {
        "role": "user",
        "content": "Hello"
      }
    ],
    "total": 1,
    "first_id": "chatcmpl-AvBCKqg2xqxVHCCEnUB4Bgj1Bjl7Y",
    "last_id": "chatcmpl-AvBCKqg2xqxVHCCEnUB4Bgj1Bjl7Y",
    "has_more": false
  }
}

評価 - リストを取得

GET {endpoint}/openai/evals?api-version=2025-04-01-preview

projectの評価を一覧表示します。

URI Parameters

Request Header

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

Responses

状態コード: 200

説明: 評価の一覧

Examples

GET {endpoint}/openai/evals?api-version=2025-04-01-preview

応答: 状態コード: 200

{
  "headers": {},
  "body": {
    "object": "list",
    "data": [
      {
        "object": "eval",
        "id": "eval_6801694950848190b10968bb628b651d",
        "data_source_config": {
          "type": "custom",
          "schema": {
            "type": "object",
            "properties": {
              "item": {
                "type": "object",
                "properties": {
                  "question": {
                    "type": "string"
                  },
                  "A": {
                    "type": "string"
                  },
                  "B": {
                    "type": "string"
                  },
                  "C": {
                    "type": "string"
                  },
                  "D": {
                    "type": "string"
                  },
                  "answer": {
                    "type": "string"
                  }
                }
              }
            },
            "required": [
              "item"
            ]
          }
        },
        "testing_criteria": [
          {
            "name": "string check",
            "type": "string_check",
            "input": "{{sample.output_text}}",
            "reference": "{{item.answer}}",
            "operation": "eq"
          }
        ],
        "name": "Math Quiz",
        "created_at": 1744922953,
        "metadata": {}
      }
    ],
    "first_id": "eval_6801694950848190b10968bb628b651d",
    "last_id": "eval_6801694950848190b10968bb628b651d",
    "has_more": false
  }
}

評価 - 作成

POST {endpoint}/openai/evals?api-version=2025-04-01-preview

モデルのパフォーマンスをテストするために使用できる評価の構造を作成します。 評価は、一連のテスト基準とデータソースです。 評価を作成したら、さまざまなモデルとモデル パラメーターで実行できます。 複数の種類の採点者とデータソースをサポートしています。

URI Parameters

Request Header

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

Responses

状態コード: 201

Description: OK

Examples

POST {endpoint}/openai/evals?api-version=2025-04-01-preview

{
 "name": "Math Quiz",
 "data_source_config": {
  "type": "custom",
  "include_sample_schema": true,
  "item_schema": {
   "type": "object",
   "properties": {
    "question": {
     "type": "string"
    },
    "A": {
     "type": "string"
    },
    "B": {
     "type": "string"
    },
    "C": {
     "type": "string"
    },
    "D": {
     "type": "string"
    },
    "answer": {
     "type": "string"
    }
   }
  }
 },
 "testing_criteria": [
  {
   "type": "string_check",
   "reference": "{{item.answer}}",
   "input": "{{sample.output_text}}",
   "operation": "eq",
   "name": "string check"
  }
 ]
}

応答: 状態コード: 201

{
  "headers": {},
  "body": {
    "object": "eval",
    "id": "eval_6801694950848190b10968bb628b651d",
    "data_source_config": {
      "type": "custom",
      "schema": {
        "type": "object",
        "properties": {
          "item": {
            "type": "object",
            "properties": {
              "question": {
                "type": "string"
              },
              "A": {
                "type": "string"
              },
              "B": {
                "type": "string"
              },
              "C": {
                "type": "string"
              },
              "D": {
                "type": "string"
              },
              "answer": {
                "type": "string"
              }
            }
          }
        },
        "required": [
          "item"
        ]
      }
    },
    "testing_criteria": [
      {
        "name": "string check",
        "type": "string_check",
        "input": "{{sample.output_text}}",
        "reference": "{{item.answer}}",
        "operation": "eq"
      }
    ],
    "name": "Math Quiz",
    "created_at": 1744922953,
    "metadata": {}
  }
}

評価 - 削除

DELETE {endpoint}/openai/evals/{eval-id}?api-version=2025-04-01-preview

評価を削除します。

URI Parameters

Request Header

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

Responses

状態コード: 200

説明: 評価を正常に削除しました。

状態コード: 404

説明: 評価が見つかりません。

Examples

DELETE {endpoint}/openai/evals/{eval-id}?api-version=2025-04-01-preview

応答: 状態コード: 200

{
  "headers": {},
  "body": {
    "object": "eval.deleted",
    "deleted": true,
    "eval_id": "eval_6801694950848190b10968bb628b651d"
  }
}

状態コード: 404

{
  "headers": {},
  "body": {
    "code": "notFound",
    "message": "Evaluation with ID eval_6801694950848190b10968bb628b651d not found."
  }
}

評価 - 取得

GET {endpoint}/openai/evals/{eval-id}?api-version=2025-04-01-preview

ID による評価を取得します。

URI Parameters

Request Header

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

Responses

状態コード: 200

説明: 評価

Examples

GET {endpoint}/openai/evals/{eval-id}?api-version=2025-04-01-preview

応答: 状態コード: 200

{
  "headers": {},
  "body": {
    "object": "eval",
    "id": "eval_6801694950848190b10968bb628b651d",
    "data_source_config": {
      "type": "custom",
      "schema": {
        "type": "object",
        "properties": {
          "item": {
            "type": "object",
            "properties": {
              "question": {
                "type": "string"
              },
              "A": {
                "type": "string"
              },
              "B": {
                "type": "string"
              },
              "C": {
                "type": "string"
              },
              "D": {
                "type": "string"
              },
              "answer": {
                "type": "string"
              }
            }
          }
        },
        "required": [
          "item"
        ]
      }
    },
    "testing_criteria": [
      {
        "name": "string check",
        "type": "string_check",
        "input": "{{sample.output_text}}",
        "reference": "{{item.answer}}",
        "operation": "eq"
      }
    ],
    "name": "Math Quiz",
    "created_at": 1744922953,
    "metadata": {}
  }
}

評価 - 更新

POST {endpoint}/openai/evals/{eval-id}?api-version=2025-04-01-preview

評価の特定のプロパティを更新します。

URI Parameters

Request Header

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

Responses

状態コード: 200

説明: 更新された評価

Examples

POST {endpoint}/openai/evals/{eval-id}?api-version=2025-04-01-preview

{
 "name": "Updated Math Quiz",
 "metadata": {
  "description": "Updated description"
 }
}

応答: 状態コード: 200

{
  "headers": {},
  "body": {
    "object": "eval",
    "id": "eval_6801694950848190b10968bb628b651d",
    "data_source_config": {
      "type": "custom",
      "schema": {
        "type": "object",
        "properties": {
          "item": {
            "type": "object",
            "properties": {
              "question": {
                "type": "string"
              },
              "A": {
                "type": "string"
              },
              "B": {
                "type": "string"
              },
              "C": {
                "type": "string"
              },
              "D": {
                "type": "string"
              },
              "answer": {
                "type": "string"
              }
            }
          }
        },
        "required": [
          "item"
        ]
      }
    },
    "testing_criteria": [
      {
        "name": "string check",
        "type": "string_check",
        "input": "{{sample.output_text}}",
        "reference": "{{item.answer}}",
        "operation": "eq"
      }
    ],
    "name": "Updated Math Quiz",
    "created_at": 1744922953,
    "metadata": {
      "description": "Updated description"
    }
  }
}

評価 - Getrunlist

GET {endpoint}/openai/evals/{eval-id}/runs?api-version=2025-04-01-preview

評価の実行結果の一覧を取得します。

URI Parameters

Request Header

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

Responses

状態コード: 200

説明: 評価の実行の一覧

Examples

GET {endpoint}/openai/evals/{eval-id}/runs?api-version=2025-04-01-preview

応答: 状態コード: 200

{
  "headers": {},
  "body": {
    "object": "list",
    "data": [
      {
        "object": "eval.run",
        "id": "evalrun_68016a056f0481909b9774447bdd1aa3",
        "eval_id": "eval_6801694950848190b10968bb628b651d",
        "report_url": "https://ai.azure.com/resource/evaluation",
        "status": "queued",
        "model": "gpt-4o-mini",
        "name": "Math quiz",
        "created_at": 1744923141,
        "result_counts": {
          "total": 0,
          "errored": 0,
          "failed": 0,
          "passed": 0
        },
        "per_model_usage": null,
        "per_testing_criteria_results": null,
        "data_source": {
          "type": "completions",
          "source": {
            "type": "file_content",
            "content": [
              {
                "item": {
                  "question": "Find the degree for the given field extension Q(sqrt(2), sqrt(3), sqrt(18)) over Q.",
                  "A": "0",
                  "B": "4",
                  "C": "2",
                  "D": "6",
                  "answer": "B"
                }
              },
              {
                "item": {
                  "question": "Let p = (1, 2, 5, 4)(2, 3) in S_5 . Find the index of <p> in S_5.",
                  "A": "8",
                  "B": "2",
                  "C": "24",
                  "D": "120",
                  "answer": "C"
                }
              }
            ]
          },
          "input_messages": {
            "template": [
              {
                "type": "message",
                "role": "system",
                "content": {
                  "text": "Answer the question's with A, B, C, or D."
                }
              },
              {
                "type": "message",
                "role": "user",
                "content": {
                  "text": "Question: {{item.question}} A: {{item.A}} B: {{item.B}} C: {{item.C}} D: {{item.D}}."
                }
              }
            ]
          },
          "model": "gpt-4o-mini",
          "sampling_params": {
            "seed": 42,
            "temperature": 1,
            "top_p": 1
          }
        },
        "error": null,
        "metadata": {}
      }
    ],
    "first_id": "evalrun_68016a056f0481909b9774447bdd1aa3",
    "last_id": "evalrun_68016a056f0481909b9774447bdd1aa3",
    "has_more": false
  }
}

評価 - 実行の作成

POST {endpoint}/openai/evals/{eval-id}/runs?api-version=2025-04-01-preview

新しい評価実行を作成します。 これは、採点を開始するエンドポイントです。

URI Parameters

Request Header

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

Responses

状態コード: 201

説明: 評価の実行が正常に作成されました

状態コード: 400

説明: 要求が正しくありません (たとえば、eval オブジェクトが見つかりません)

Examples

POST {endpoint}/openai/evals/{eval-id}/runs?api-version=2025-04-01-preview

{
 "name": "Math quiz",
 "data_source": {
  "type": "completions",
  "source": {
   "type": "file_content",
   "content": [
    {
     "item": {
      "question": "Find the degree for the given field extension Q(sqrt(2), sqrt(3), sqrt(18)) over Q.",
      "A": "0",
      "B": "4",
      "C": "2",
      "D": "6",
      "answer": "B"
     }
    },
    {
     "item": {
      "question": "Let p = (1, 2, 5, 4)(2, 3) in S_5 . Find the index of <p> in S_5.",
      "A": "8",
      "B": "2",
      "C": "24",
      "D": "120",
      "answer": "C"
     }
    }
   ]
  },
  "input_messages": {
   "type": "template",
   "template": [
    {
     "type": "message",
     "role": "system",
     "content": {
      "text": "Answer the question's with A, B, C, or D."
     }
    },
    {
     "type": "message",
     "role": "user",
     "content": {
      "text": "Question: {{item.question}} A: {{item.A}} B: {{item.B}} C: {{item.C}} D: {{item.D}}."
     }
    }
   ]
  },
  "model": "gpt-4o-mini",
  "sampling_params": {
   "temperature": 1,
   "top_p": 1,
   "seed": 42
  }
 }
}

応答: 状態コード: 201

{
  "headers": {},
  "body": {
    "object": "eval.run",
    "id": "evalrun_68016a056f0481909b9774447bdd1aa3",
    "eval_id": "eval_6801694950848190b10968bb628b651d",
    "report_url": "https://ai.azure.com/resource/evaluation",
    "status": "queued",
    "model": "gpt-4o-mini",
    "name": "Math quiz",
    "created_at": 1744923141,
    "result_counts": {
      "total": 0,
      "errored": 0,
      "failed": 0,
      "passed": 0
    },
    "per_model_usage": null,
    "per_testing_criteria_results": null,
    "data_source": {
      "type": "completions",
      "source": {
        "type": "file_content",
        "content": [
          {
            "item": {
              "question": "Find the degree for the given field extension Q(sqrt(2), sqrt(3), sqrt(18)) over Q.",
              "A": "0",
              "B": "4",
              "C": "2",
              "D": "6",
              "answer": "B"
            }
          },
          {
            "item": {
              "question": "Let p = (1, 2, 5, 4)(2, 3) in S_5 . Find the index of <p> in S_5.",
              "A": "8",
              "B": "2",
              "C": "24",
              "D": "120",
              "answer": "C"
            }
          }
        ]
      },
      "input_messages": {
        "type": "template",
        "template": [
          {
            "type": "message",
            "role": "system",
            "content": {
              "text": "Answer the question's with A, B, C, or D."
            }
          },
          {
            "type": "message",
            "role": "user",
            "content": {
              "text": "Question: {{item.question}} A: {{item.A}} B: {{item.B}} C: {{item.C}} D: {{item.D}}."
            }
          }
        ]
      },
      "model": "gpt-4o-mini",
      "sampling_params": {
        "seed": 42,
        "temperature": 1,
        "top_p": 1
      }
    },
    "error": null,
    "metadata": {}
  }
}

評価 - 実行の削除

DELETE {endpoint}/openai/evals/{eval-id}/runs/{run-id}?api-version=2025-04-01-preview

評価実行を削除します。

URI Parameters

Request Header

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

Responses

状態コード: 200

説明: 評価実行が正常に削除されました

状態コード: 404

説明: 実行が見つかりません

Examples

DELETE {endpoint}/openai/evals/{eval-id}/runs/{run-id}?api-version=2025-04-01-preview

応答: 状態コード: 200

{
  "headers": {},
  "body": {
    "object": "eval.deleted",
    "deleted": true,
    "run_id": "evalrun_68016a056f0481909b9774447bdd1aa3"
  }
}

状態コード: 404

{
  "headers": {},
  "body": {
    "code": "notFound",
    "message": "Evaluation Run with ID evalrun_68016a056f0481909b9774447bdd1aa3 not found."
  }
}

評価 - 実行の取得

GET {endpoint}/openai/evals/{eval-id}/runs/{run-id}?api-version=2025-04-01-preview

ID で評価実行を取得します。

URI Parameters

Request Header

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

Responses

状態コード: 200

説明: 評価の実行

Examples

GET {endpoint}/openai/evals/{eval-id}/runs/{run-id}?api-version=2025-04-01-preview

応答: 状態コード: 200

{
  "headers": {},
  "body": {
    "object": "eval.run",
    "id": "evalrun_68016a056f0481909b9774447bdd1aa3",
    "eval_id": "eval_6801694950848190b10968bb628b651d",
    "report_url": "https://ai.azure.com/resource/evaluation",
    "status": "queued",
    "model": "gpt-4o-mini",
    "name": "Math quiz",
    "created_at": 1744923141,
    "result_counts": {
      "total": 0,
      "errored": 0,
      "failed": 0,
      "passed": 0
    },
    "per_model_usage": null,
    "per_testing_criteria_results": null,
    "data_source": {
      "type": "completions",
      "source": {
        "type": "file_content",
        "content": [
          {
            "item": {
              "question": "Find the degree for the given field extension Q(sqrt(2), sqrt(3), sqrt(18)) over Q.",
              "A": "0",
              "B": "4",
              "C": "2",
              "D": "6",
              "answer": "B"
            }
          },
          {
            "item": {
              "question": "Let p = (1, 2, 5, 4)(2, 3) in S_5 . Find the index of <p> in S_5.",
              "A": "8",
              "B": "2",
              "C": "24",
              "D": "120",
              "answer": "C"
            }
          }
        ]
      },
      "input_messages": {
        "type": "template",
        "template": [
          {
            "type": "message",
            "role": "system",
            "content": {
              "text": "Answer the question's with A, B, C, or D."
            }
          },
          {
            "type": "message",
            "role": "user",
            "content": {
              "text": "Question: {{item.question}} A: {{item.A}} B: {{item.B}} C: {{item.C}} D: {{item.D}}."
            }
          }
        ]
      },
      "model": "gpt-4o-mini",
      "sampling_params": {
        "seed": 42,
        "temperature": 1,
        "top_p": 1
      }
    },
    "error": null,
    "metadata": {}
  }
}

評価 - 実行の取り消し

POST {endpoint}/openai/evals/{eval-id}/runs/{run-id}?api-version=2025-04-01-preview

継続的な評価実行を取り消します。

URI Parameters

Request Header

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

Responses

状態コード: 200

説明: 取り消された eval run オブジェクト

Examples

POST {endpoint}/openai/evals/{eval-id}/runs/{run-id}?api-version=2025-04-01-preview

応答: 状態コード: 200

{
  "headers": {},
  "body": {
    "object": "eval.run",
    "id": "evalrun_68016a056f0481909b9774447bdd1aa3",
    "eval_id": "eval_6801694950848190b10968bb628b651d",
    "report_url": "https://ai.azure.com/resource/evaluation",
    "status": "canceled",
    "model": "gpt-4o-mini",
    "name": "Math quiz",
    "created_at": 1744923141,
    "result_counts": {
      "total": 0,
      "errored": 0,
      "failed": 0,
      "passed": 0
    },
    "per_model_usage": null,
    "per_testing_criteria_results": null,
    "data_source": {
      "type": "completions",
      "source": {
        "type": "file_content",
        "content": [
          {
            "item": {
              "question": "Find the degree for the given field extension Q(sqrt(2), sqrt(3), sqrt(18)) over Q.",
              "A": "0",
              "B": "4",
              "C": "2",
              "D": "6",
              "answer": "B"
            }
          },
          {
            "item": {
              "question": "Let p = (1, 2, 5, 4)(2, 3) in S_5 . Find the index of <p> in S_5.",
              "A": "8",
              "B": "2",
              "C": "24",
              "D": "120",
              "answer": "C"
            }
          }
        ]
      },
      "input_messages": {
        "type": "template",
        "template": [
          {
            "type": "message",
            "role": "system",
            "content": {
              "text": "Answer the question's with A, B, C, or D."
            }
          },
          {
            "type": "message",
            "role": "user",
            "content": {
              "text": "Question: {{item.question}} A: {{item.A}} B: {{item.B}} C: {{item.C}} D: {{item.D}}."
            }
          }
        ]
      },
      "model": "gpt-4o-mini",
      "sampling_params": {
        "seed": 42,
        "temperature": 1,
        "top_p": 1
      }
    },
    "error": null,
    "metadata": {}
  }
}

評価 - Getrunoutputitems

GET {endpoint}/openai/evals/{eval-id}/runs/{run-id}/output_items?api-version=2025-04-01-preview

評価実行の出力項目の一覧を取得します。

URI Parameters

Request Header

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

Responses

状態コード: 200

説明: 評価実行の出力項目の一覧

Examples

GET {endpoint}/openai/evals/{eval-id}/runs/{run-id}/output_items?api-version=2025-04-01-preview

応答: 状態コード: 200

{
  "headers": {},
  "body": {
    "object": "list",
    "data": [
      {
        "object": "eval.run.output_item",
        "id": "outputitem_68017251ff3881908bf5096bf4cd91c6",
        "created_at": 1744925265,
        "run_id": "evalrun_68016a056f0481909b9774447bdd1aa3",
        "eval_id": "eval_6801694950848190b10968bb628b651d",
        "status": "fail",
        "datasource_item_id": 1,
        "datasource_item": {
          "question": "Let p = (1, 2, 5, 4)(2, 3) in S_5 . Find the index of <p> in S_5.",
          "A": "8",
          "B": "2",
          "C": "24",
          "D": "120",
          "answer": "C"
        },
        "results": [
          {
            "name": "string check-63b1fffa-bee6-4c37-ae77-ed46e3dce2b7",
            "sample": null,
            "passed": false,
            "score": 0
          }
        ],
        "sample": {
          "input": [
            {
              "role": "system",
              "content": "Answer the question's with A, B, C, or D.",
              "function_call": null
            },
            {
              "role": "user",
              "content": "Question: Let p = (1, 2, 5, 4)(2, 3) in S_5 . Find the index of <p> in S_5. A: 8 B: 2 C: 24 D: 120.",
              "function_call": null
            }
          ],
          "output": [
            {
              "role": "assistant",
              "content": "To find the index of the subgroup generated by the permutation \\( p = (1, 2, 5, 4)(2, 3) \\) in \\( S_5 \\), we first need to determine the order of \\( p \\).\n\n1. The cycle \\( (1, 2, 5, 4) \\) has length 4.\n2. The cycle \\( (2, 3) \\) has length 2.\n3. The least common multiple (LCM) of these lengths gives the order of the permutation \\( p \\).\n\nCalculating the LCM:\n\\[\n\\text{lcm}(4, 2) = 4\n\\]\nThus, the order of \\( p \\) is 4.\n\nNext, we find the size of the subgroup \\( \\langle p \\rangle \\):\n- The size of \\( \\langle p \\rangle \\) is equal to the order of \\( p \\), which is 4.\n\nNow, we know the size of \\( S_5 \\):\n\\[\n|S_5| = 5! = 120\n\\]\n\nFinally, to find the index of \\( \\langle p \\rangle \\) in \\( S_5 \\), we use the formula:\n\\[\n\\text{index} = \\frac{|S_5|}{|\\langle p \\rangle|} = \\frac{120}{4} = 30\n\\]\n\nHowever, the available answer choices do not include 30. There may be a mistake because the question expects an answer among A, B, C, and D.\n\nLet\u00e2\u20ac\u2122s assume we misunderstood \\( \\langle p \\rangle \\), and instead, we can deduce based solely on given answers looking for a relation to \\( S_5 \\) without delving into detailed subgroup tracks. \n\nSince \\( S_5 \\) has 30 different elements in a subgroup configuration, the closest answer physically relating as long as \\( p \\) covers two elements effectively would logically fit an answer of 120 / 60 which has no direct relationship.\n\nGiven the option choices and specific rank formulations as often made regarding elements in specific construct the subgroup at best reflects around a viable ratio of parts allowed through available indices. \n\nThus, after reasoning through which aligns most structurally geometrically yielding across all configurations possible integrated yet arrives leading \\( p \\) through neighborhood distributions leaving reflections outstanding:\n\n\n\nThe correct answer is:\n**C: 24**\n\nHowever per the discussion migrating \\( p \\) may leave various pathways leading ultimately toward that framing in modeling. Always a good suggestion confirming the elements group generating any possible in outputs rationales. ",
              "function_call": null
            }
          ],
          "finish_reason": "stop",
          "model": "gpt-4o-mini-2024-07-18",
          "usage": {
            "total_tokens": 627,
            "completion_tokens": 546,
            "prompt_tokens": 81,
            "cached_tokens": 0
          },
          "error": null,
          "temperature": 1,
          "top_p": 1,
          "seed": 42
        }
      },
      {
        "object": "eval.run.output_item",
        "id": "outputitem_6801724f54888190942ec66a197309dd",
        "created_at": 1744925263,
        "run_id": "evalrun_68016a056f0481909b9774447bdd1aa3",
        "eval_id": "eval_6801694950848190b10968bb628b651d",
        "status": "fail",
        "datasource_item_id": 0,
        "datasource_item": {
          "question": "Find the degree for the given field extension Q(sqrt(2), sqrt(3), sqrt(18)) over Q.",
          "A": "0",
          "B": "4",
          "C": "2",
          "D": "6",
          "answer": "B"
        },
        "results": [
          {
            "name": "string check-63b1fffa-bee6-4c37-ae77-ed46e3dce2b7",
            "sample": null,
            "passed": false,
            "score": 0
          }
        ],
        "sample": {
          "input": [
            {
              "role": "system",
              "content": "Answer the question's with A, B, C, or D.",
              "function_call": null
            },
            {
              "role": "user",
              "content": "Question: Find the degree for the given field extension Q(sqrt(2), sqrt(3), sqrt(18)) over Q. A: 0 B: 4 C: 2 D: 6.",
              "function_call": null
            }
          ],
          "output": [
            {
              "role": "assistant",
              "content": "To find the degree of the field extension \\(\\mathbb{Q}(\\sqrt{2}, \\sqrt{3}, \\sqrt{18})\\) over \\(\\mathbb{Q}\\), we can simplify \\(\\sqrt{18}\\) since \\(\\sqrt{18} = \\sqrt{9 \\cdot 2} = 3\\sqrt{2}\\). \n\nThus, the field can be rewritten as \\(\\mathbb{Q}(\\sqrt{2}, \\sqrt{3})\\).\n\nNext, we calculate the degree of the extensions step by step:\n\n1. The extension \\(\\mathbb{Q}(\\sqrt{2})\\) over \\(\\mathbb{Q}\\) has degree 2, since \\(\\sqrt{2}\\) is not in \\(\\mathbb{Q}\\) and satisfies the polynomial \\(x^2 - 2\\).\n\n2. Next, we consider the extension \\(\\mathbb{Q}(\\sqrt{2}, \\sqrt{3})\\) over \\(\\mathbb{Q}(\\sqrt{2})\\). The element \\(\\sqrt{3}\\) is also not in \\(\\mathbb{Q}(\\sqrt{2})\\) and satisfies the polynomial \\(x^2 - 3\\), which is irreducible over \\(\\mathbb{Q}(\\sqrt{2})\\). Hence, the degree of the extension \\(\\mathbb{Q}(\\sqrt{2}, \\sqrt{3})\\) over \\(\\mathbb{Q}(\\sqrt{2})\\) is also 2.\n\nNow we can combine these degrees:\n\n\\[\n[\\mathbb{Q}(\\sqrt{2}, \\sqrt{3}) : \\mathbb{Q}] = [\\mathbb{Q}(\\sqrt{2}, \\sqrt{3}) : \\mathbb{Q}(\\sqrt{2})] \\times [\\mathbb{Q}(\\sqrt{2}) : \\mathbb{Q}] = 2 \\times 2 = 4.\n\\]\n\nThus, the degree of the field extension \\(\\mathbb{Q}(\\sqrt{2}, \\sqrt{3}, \\sqrt{18})\\) over \\(\\mathbb{Q}\\) is 4.\n\nTherefore, the answer is:\n\n**B: 4**.",
              "function_call": null
            }
          ],
          "finish_reason": "stop",
          "model": "gpt-4o-mini-2024-07-18",
          "usage": {
            "total_tokens": 556,
            "completion_tokens": 487,
            "prompt_tokens": 69,
            "cached_tokens": 0
          },
          "error": null,
          "temperature": 1,
          "top_p": 1,
          "seed": 42
        }
      }
    ],
    "first_id": "outputitem_68017251ff3881908bf5096bf4cd91c6",
    "last_id": "outputitem_6801724f54888190942ec66a197309dd",
    "has_more": false
  }
}

評価 - Getrunoutputitem

GET {endpoint}/openai/evals/{eval-id}/runs/{run-id}/output_items/{output-item-id}?api-version=2025-04-01-preview

評価実行出力項目を ID で取得します。

URI Parameters

Request Header

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

Responses

状態コード: 200

説明: 評価実行の出力項目

Examples

GET {endpoint}/openai/evals/{eval-id}/runs/{run-id}/output_items/{output-item-id}?api-version=2025-04-01-preview

応答: 状態コード: 200

{
  "headers": {},
  "body": {
    "object": "eval.run.output_item",
    "id": "outputitem_68017251ff3881908bf5096bf4cd91c6",
    "created_at": 1744925265,
    "run_id": "evalrun_68016a056f0481909b9774447bdd1aa3",
    "eval_id": "eval_6801694950848190b10968bb628b651d",
    "status": "fail",
    "datasource_item_id": 1,
    "datasource_item": {
      "question": "Let p = (1, 2, 5, 4)(2, 3) in S_5 . Find the index of <p> in S_5.",
      "A": "8",
      "B": "2",
      "C": "24",
      "D": "120",
      "answer": "C"
    },
    "results": [
      {
        "name": "string check-63b1fffa-bee6-4c37-ae77-ed46e3dce2b7",
        "sample": null,
        "passed": false,
        "score": 0
      }
    ],
    "sample": {
      "input": [
        {
          "role": "system",
          "content": "Answer the question's with A, B, C, or D."
        },
        {
          "role": "user",
          "content": "Question: Let p = (1, 2, 5, 4)(2, 3) in S_5 . Find the index of <p> in S_5. A: 8 B: 2 C: 24 D: 120."
        }
      ],
      "output": [
        {
          "role": "assistant",
          "content": "To find the index of the subgroup generated by the permutation \\( p = (1, 2, 5, 4)(2, 3) \\) in \\( S_5 \\), we first need to determine the order of \\( p \\).\n\n1. The cycle \\( (1, 2, 5, 4) \\) has length 4.\n2. The cycle \\( (2, 3) \\) has length 2.\n3. The least common multiple (LCM) of these lengths gives the order of the permutation \\( p \\).\n\nCalculating the LCM:\n\\[\n\\text{lcm}(4, 2) = 4\n\\]\nThus, the order of \\( p \\) is 4.\n\nNext, we find the size of the subgroup \\( \\langle p \\rangle \\):\n- The size of \\( \\langle p \\rangle \\) is equal to the order of \\( p \\), which is 4.\n\nNow, we know the size of \\( S_5 \\):\n\\[\n|S_5| = 5! = 120\n\\]\n\nFinally, to find the index of \\( \\langle p \\rangle \\) in \\( S_5 \\), we use the formula:\n\\[\n\\text{index} = \\frac{|S_5|}{|\\langle p \\rangle|} = \\frac{120}{4} = 30\n\\]\n\nHowever, the available answer choices do not include 30. There may be a mistake because the question expects an answer among A, B, C, and D.\n\nLet\u00e2\u20ac\u2122s assume we misunderstood \\( \\langle p \\rangle \\), and instead, we can deduce based solely on given answers looking for a relation to \\( S_5 \\) without delving into detailed subgroup tracks. \n\nSince \\( S_5 \\) has 30 different elements in a subgroup configuration, the closest answer physically relating as long as \\( p \\) covers two elements effectively would logically fit an answer of 120 / 60 which has no direct relationship.\n\nGiven the option choices and specific rank formulations as often made regarding elements in specific construct the subgroup at best reflects around a viable ratio of parts allowed through available indices. \n\nThus, after reasoning through which aligns most structurally geometrically yielding across all configurations possible integrated yet arrives leading \\( p \\) through neighborhood distributions leaving reflections outstanding:\n\n\n\nThe correct answer is:\n**C: 24**\n\nHowever per the discussion migrating \\( p \\) may leave various pathways leading ultimately toward that framing in modeling. Always a good suggestion confirming the elements group generating any possible in outputs rationales. "
        }
      ],
      "finish_reason": "stop",
      "model": "gpt-4o-mini-2024-07-18",
      "usage": {
        "total_tokens": 627,
        "completion_tokens": 546,
        "prompt_tokens": 81,
        "cached_tokens": 0
      },
      "error": null,
      "temperature": 1,
      "top_p": 1,
      "seed": 42
    }
  }
}

ファイル - リスト

GET {endpoint}/openai/files?api-version=2025-04-01-preview

Azure OpenAI リソースによって所有されているすべてのファイルの一覧を取得します。

これには、微調整モデルのトレーニングまたは検証のための "微調整" 目的のファイルや、サービスによって生成されたファイル (対応する微調整ジョブのさまざまなメトリックを含む "微調整結果" など) を含むファイルなど、ユーザーがアップロードしたコンテンツが含まれます。

URI Parameters

Request Header

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

Responses

状態コード: 200

Description: Success

状態コード: 既定値

説明: エラーが発生しました。

Examples

GET {endpoint}/openai/files?api-version=2025-04-01-preview

応答: 状態コード: 200

{
  "headers": {},
  "body": {
    "data": [
      {
        "status": "processed",
        "bytes": 140,
        "purpose": "fine-tune",
        "filename": "puppy.jsonl",
        "id": "file-181a1cbdcdcf4677ada87f63a0928099",
        "created_at": 1646126127,
        "object": "file"
      },
      {
        "status": "processed",
        "bytes": 32423,
        "purpose": "fine-tune-results",
        "filename": "results.csv",
        "id": "file-181a1cbdcdcf4677ada87f63a0928099",
        "created_at": 1646126127,
        "object": "file"
      }
    ],
    "object": "list"
  }
}

ファイル - アップロード

POST {endpoint}/openai/files?api-version=2025-04-01-preview

ローカル コンピューターからデータをアップロードして、新しいファイル エンティティを作成します。 アップロードされたファイルは、たとえば、微調整されたモデルのトレーニングや評価に使用できます。

URI Parameters

Request Header

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

Request Body

Content-Type: multipart/form-data

Responses

状態コード: 201

説明: ファイルが正常に作成されました。

状態コード: 既定値

説明: エラーが発生しました。

Examples

POST {endpoint}/openai/files?api-version=2025-04-01-preview

応答: 状態コード: 201

{
  "headers": {
    "location": "https://aoairesource.openai.azure.com/openai/files/file-181a1cbdcdcf4677ada87f63a0928099"
  },
  "body": {
    "status": "pending",
    "purpose": "fine-tune",
    "filename": "puppy.jsonl",
    "id": "file-181a1cbdcdcf4677ada87f63a0928099",
    "created_at": 1646126127,
    "object": "file"
  }
}

ファイル - インポート

POST {endpoint}/openai/files/import?api-version=2025-04-01-preview

指定された URL からデータをインポートして、新しいファイル エンティティを作成します。 アップロードされたファイルは、たとえば、微調整されたモデルのトレーニングや評価に使用できます。

URI Parameters

Request Header

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

Request Body

Content-Type: application/json

Responses

状態コード: 201

説明: ファイルが正常に作成されました。

状態コード: 既定値

説明: エラーが発生しました。

Examples

POST {endpoint}/openai/files/import?api-version=2025-04-01-preview

応答: 状態コード: 201

{
  "headers": {
    "location": "https://aoairesource.openai.azure.com/openai/files/file-181a1cbdcdcf4677ada87f63a0928099"
  },
  "body": {
    "status": "pending",
    "purpose": "fine-tune",
    "filename": "puppy.jsonl",
    "id": "file-181a1cbdcdcf4677ada87f63a0928099",
    "created_at": 1646126127,
    "object": "file"
  }
}

ファイル - 取得

GET {endpoint}/openai/files/{file-id}?api-version=2025-04-01-preview

状態、サイズ、目的など、指定されたファイル ID で指定された 1 つのファイルの詳細を取得します。

URI Parameters

Request Header

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

Responses

状態コード: 200

Description: Success

状態コード: 既定値

説明: エラーが発生しました。

Examples

GET {endpoint}/openai/files/{file-id}?api-version=2025-04-01-preview

応答: 状態コード: 200

{
  "headers": {},
  "body": {
    "status": "processed",
    "bytes": 140,
    "purpose": "fine-tune",
    "filename": "puppy.jsonl",
    "id": "file-181a1cbdcdcf4677ada87f63a0928099",
    "created_at": 1646126127,
    "object": "file"
  }
}

ファイル - 削除

DELETE {endpoint}/openai/files/{file-id}?api-version=2025-04-01-preview

指定されたファイル ID を持つファイルを削除します。

また、ファイルが使用された場合 (微調整ジョブのトレーニング ファイルなど) も削除できます。

URI Parameters

Request Header

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

Responses

状態コード: 200

説明: ファイルが正常に削除されました。

状態コード: 既定値

説明: エラーが発生しました。

Examples

DELETE {endpoint}/openai/files/{file-id}?api-version=2025-04-01-preview

応答: 状態コード: 200

{
  "headers": {},
  "body": {
    "object": "file",
    "deleted": true,
    "id": "file-181a1cbdcdcf4677ada87f63a0928099"
  }
}

ファイル - コンテンツを取得する

GET {endpoint}/openai/files/{file-id}/content?api-version=2025-04-01-preview

指定されたファイル ID で指定されたファイルの内容を取得します。

ファイルは、ユーザーがコンテンツをアップロードしたり、微調整ジョブの結果メトリックのようにサービスによって生成されたりすることができます。

URI Parameters

Request Header

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

Responses

状態コード: 200

Description: Success

状態コード: 既定値

説明: エラーが発生しました。

Examples

GET {endpoint}/openai/files/{file-id}/content?api-version=2025-04-01-preview

応答: 状態コード: 200

{
  "headers": {},
  "body": "raw file content"
}

微調整 - 一覧表示

GET {endpoint}/openai/fine_tuning/jobs?api-version=2025-04-01-preview

Azure OpenAI リソースが所有するすべての微調整ジョブの一覧を取得します。各微調整ジョブに対して返される詳細には、基本モデル、トレーニングおよび検証ファイル、ハイパー パラメーター、タイム スタンプ、状態、イベントの識別子以外にも含まれます。

イベントは、ジョブの状態が変わると作成されます。 たとえば、実行中または完了時、および結果がアップロードされるタイミングなどです。

URI Parameters

Request Header

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

Responses

状態コード: 200

Description: Success

状態コード: 既定値

説明: エラーが発生しました。

Examples

GET {endpoint}/openai/fine_tuning/jobs?api-version=2025-04-01-preview

応答: 状態コード: 200

{
  "headers": {},
  "body": {
    "has_more": false,
    "data": [
      {
        "hyperparameters": {
          "n_epochs": -1
        },
        "integrations": [
          {
            "type": "wandb",
            "wandb": {
              "project": "custom-wandb-project",
              "tags": [
                "project:tag",
                "lineage"
              ]
            }
          }
        ],
        "method": {
          "type": "supervised"
        },
        "status": "succeeded",
        "model": "curie",
        "fine_tuned_model": "curie.ft-72a2792ef7d24ba7b82c7fe4a37e379f",
        "training_file": "file-181a1cbdcdcf4677ada87f63a0928099",
        "result_files": [
          "file-181a1cbdcdcf4677ada87f63a0928099"
        ],
        "finished_at": 1646127311,
        "trained_tokens": 2342,
        "id": "ft-72a2792ef7d24ba7b82c7fe4a37e379f",
        "created_at": 1646126127,
        "object": "fine_tuning.job"
      }
    ],
    "object": "list"
  }
}

微調整 - 作成

POST {endpoint}/openai/fine_tuning/jobs?api-version=2025-04-01-preview

特定のトレーニング ファイルから指定したモデルを微調整するジョブを作成します。

応答には、ジョブの状態やハイパー パラメーターなど、エンキューされたジョブの詳細が含まれます。

微調整されたモデルの名前は、完了すると応答に追加されます。

URI Parameters

Request Header

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

Request Body

Content-Type: application/json

Responses

状態コード: 201

説明: ファインチューニングが正常に作成されました。

状態コード: 既定値

説明: エラーが発生しました。

Examples

POST {endpoint}/openai/fine_tuning/jobs?api-version=2025-04-01-preview

応答: 状態コード: 201

{
  "headers": {
    "location": "https://aoairesource.openai.azure.com/openai/fine_tuning/jobs/ft-72a2792ef7d24ba7b82c7fe4a37e379f"
  },
  "body": {
    "hyperparameters": {
      "n_epochs": -1
    },
    "integrations": [
      {
        "type": "wandb",
        "wandb": {
          "project": "custom-wandb-project",
          "tags": [
            "project:tag",
            "lineage"
          ]
        }
      }
    ],
    "method": {
      "type": "supervised"
    },
    "status": "pending",
    "model": "curie",
    "training_file": "file-181a1cbdcdcf4677ada87f63a0928099",
    "id": "ft-72a2792ef7d24ba7b82c7fe4a37e379f",
    "created_at": 1646126127,
    "object": "fine_tuning.job"
  }
}

微調整 - 取得

GET {endpoint}/openai/fine_tuning/jobs/{fine-tuning-job-id}?api-version=2025-04-01-preview

指定された微調整 ID で指定された 1 つの微調整ジョブの詳細を取得します。

詳細には、基本モデル、トレーニングおよび検証ファイル、ハイパー パラメーター、タイムスタンプ、状態、イベントが含まれます。

イベントは、ジョブの状態 (実行中や完了など) が変更されたとき、および結果がアップロードされたときに作成されます。

URI Parameters

Request Header

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

Responses

状態コード: 200

Description: Success

状態コード: 既定値

説明: エラーが発生しました。

Examples

GET {endpoint}/openai/fine_tuning/jobs/{fine-tuning-job-id}?api-version=2025-04-01-preview

応答: 状態コード: 200

{
  "headers": {},
  "body": {
    "hyperparameters": {
      "n_epochs": -1
    },
    "integrations": [
      {
        "type": "wandb",
        "wandb": {
          "project": "custom-wandb-project",
          "tags": [
            "project:tag",
            "lineage"
          ]
        }
      }
    ],
    "method": {
      "type": "supervised"
    },
    "status": "succeeded",
    "model": "curie",
    "fine_tuned_model": "curie.ft-72a2792ef7d24ba7b82c7fe4a37e379f",
    "training_file": "file-181a1cbdcdcf4677ada87f63a0928099",
    "result_files": [
      "file-181a1cbdcdcf4677ada87f63a0928099"
    ],
    "finished_at": 1646127311,
    "trained_tokens": 2342,
    "id": "ft-72a2792ef7d24ba7b82c7fe4a37e379f",
    "created_at": 1646126127,
    "object": "fine_tuning.job"
  }
}

微調整 - 削除

DELETE {endpoint}/openai/fine_tuning/jobs/{fine-tuning-job-id}?api-version=2025-04-01-preview

所定の微調整 ID で指定された微調整ジョブを削除します。

URI Parameters

Request Header

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

Responses

状態コード: 204

説明: 微調整が正常に削除されました。

状態コード: 既定値

説明: エラーが発生しました。

Examples

DELETE {endpoint}/openai/fine_tuning/jobs/{fine-tuning-job-id}?api-version=2025-04-01-preview

応答: 状態コード: 204

{
  "headers": {}
}

微調整 - キャンセル

POST {endpoint}/openai/fine_tuning/jobs/{fine-tuning-job-id}/cancel?api-version=2025-04-01-preview

指定された微調整 ID で指定された微調整ジョブの処理を取り消します。

URI Parameters

Request Header

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

Responses

状態コード: 200

説明: 微調整が正常に取り消されました

状態コード: 既定値

説明: エラーが発生しました。

Examples

POST {endpoint}/openai/fine_tuning/jobs/{fine-tuning-job-id}/cancel?api-version=2025-04-01-preview

応答: 状態コード: 200

{
  "headers": {},
  "body": {
    "hyperparameters": {
      "n_epochs": -1
    },
    "integrations": [
      {
        "type": "wandb",
        "wandb": {
          "project": "custom-wandb-project",
          "tags": [
            "project:tag",
            "lineage"
          ]
        }
      }
    ],
    "method": {
      "type": "supervised"
    },
    "status": "cancelled",
    "model": "curie",
    "training_file": "file-181a1cbdcdcf4677ada87f63a0928099",
    "finished_at": 1646127311,
    "id": "ft-72a2792ef7d24ba7b82c7fe4a37e379f",
    "created_at": 1646126127,
    "object": "fine_tuning.job"
  }
}

微調整 - チェックポイントを取得する

GET {endpoint}/openai/fine_tuning/jobs/{fine-tuning-job-id}/checkpoints?api-version=2025-04-01-preview

所定の微調整 ID で指定された微調整ジョブのチェックポイントを取得します。

チェックポイントは、トレーニング中に成功したエポックの最後に作成されます。

URI Parameters

Request Header

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

Responses

状態コード: 200

Description: Success

状態コード: 既定値

説明: エラーが発生しました。

Examples

GET {endpoint}/openai/fine_tuning/jobs/{fine-tuning-job-id}/checkpoints?api-version=2025-04-01-preview

応答: 状態コード: 200

{
  "headers": {},
  "body": {
    "has_more": false,
    "data": [
      {
        "id": "ftckpt_qtZ5Gyk4BLq1SfLFWp3RtO3P",
        "created_at": 1646126127,
        "fine_tuned_model_checkpoint": "gpt-35-turbo-0613.ft-72a2792ef7d24ba7b82c7fe4a37e379f:ckpt-step-10",
        "step_number": 10,
        "metrics": {
          "step": 10,
          "train_loss": 0.478,
          "train_mean_token_accuracy": 0.924,
          "valid_loss": 10.112,
          "valid_mean_token_accuracy": 0.145,
          "full_valid_loss": 0.567,
          "full_valid_mean_token_accuracy": 0.944
        },
        "fine_tuning_job_id": "ftjob-72a2792ef7d24ba7b82c7fe4a37e379f",
        "object": "fine_tuning.job.checkpoint"
      },
      {
        "id": "ftckpt_frtXDR2453C4FG67t03MLPs5",
        "created_at": 1646126137,
        "fine_tuned_model_checkpoint": "gpt-35-turbo-0613.ft-72a2792ef7d24ba7b82c7fe4a37e379f:ckpt-step-20",
        "step_number": 20,
        "metrics": {
          "step": 20,
          "train_loss": 0.355,
          "train_mean_token_accuracy": 0.947,
          "valid_loss": 11.32,
          "valid_mean_token_accuracy": 0.122,
          "full_valid_loss": 0.317,
          "full_valid_mean_token_accuracy": 0.955
        },
        "fine_tuning_job_id": "ftjob-72a2792ef7d24ba7b82c7fe4a37e379f",
        "object": "fine_tuning.job.checkpoint"
      },
      {
        "id": "ftckpt_agLk6Gio560ORp14gl123fgd",
        "created_at": 1646126147,
        "fine_tuned_model_checkpoint": "gpt-35-turbo-0613.ft-72a2792ef7d24ba7b82c7fe4a37e379f:ckpt-step-30",
        "step_number": 30,
        "metrics": {
          "step": 30,
          "train_loss": 0.155,
          "train_mean_token_accuracy": 0.975,
          "valid_loss": 9.31,
          "valid_mean_token_accuracy": 0.092,
          "full_valid_loss": 0.114,
          "full_valid_mean_token_accuracy": 0.963
        },
        "fine_tuning_job_id": "ftjob-72a2792ef7d24ba7b82c7fe4a37e379f",
        "object": "fine_tuning.job.checkpoint"
      }
    ],
    "object": "list"
  }
}

微調整 - イベントを取得する

GET {endpoint}/openai/fine_tuning/jobs/{fine-tuning-job-id}/events?api-version=2025-04-01-preview

所定の微調整 ID で指定された微調整ジョブのイベントを取得します。

イベントは、ジョブの状態 (実行中や完了など) が変更されたとき、および結果がアップロードされたときに作成されます。

URI Parameters

Request Header

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

Responses

状態コード: 200

Description: Success

状態コード: 既定値

説明: エラーが発生しました。

Examples

GET {endpoint}/openai/fine_tuning/jobs/{fine-tuning-job-id}/events?api-version=2025-04-01-preview

応答: 状態コード: 200

{
  "headers": {},
  "body": {
    "has_more": false,
    "data": [
      {
        "id": "ftevent-363dcd7cb4c74539bc53293c1dceef05",
        "created_at": 1646126127,
        "level": "info",
        "message": "Job enqueued. Waiting for jobs ahead to complete.",
        "type": "message",
        "object": "fine_tuning.job.event"
      },
      {
        "id": "ftevent-8c2a44999790437cb3230e543fa2cf0f",
        "created_at": 1646126169,
        "level": "info",
        "message": "Job started.",
        "type": "message",
        "object": "fine_tuning.job.event"
      },
      {
        "id": "ftevent-2d47d651d2f3484c8187c88c00078147",
        "created_at": 1646126192,
        "level": "info",
        "message": "Job succeeded.",
        "type": "message",
        "object": "fine_tuning.job.event"
      }
    ],
    "object": "list"
  }
}

微調整 - 一時停止

POST {endpoint}/openai/fine_tuning/jobs/{fine-tuning-job-id}/pause?api-version=2025-04-01-preview

指定された微調整 ID で指定された微調整ジョブの処理を一時停止します。

URI Parameters

Request Header

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

Responses

状態コード: 200

説明: 微調整が正常に一時停止されました。

状態コード: 既定値

説明: エラーが発生しました。

Examples

POST {endpoint}/openai/fine_tuning/jobs/{fine-tuning-job-id}/pause?api-version=2025-04-01-preview

応答: 状態コード: 200

{
  "headers": {},
  "body": {
    "hyperparameters": {
      "n_epochs": -1
    },
    "integrations": [
      {
        "type": "wandb",
        "wandb": {
          "project": "custom-wandb-project",
          "tags": [
            "project:tag",
            "lineage"
          ]
        }
      }
    ],
    "method": {
      "type": "supervised"
    },
    "status": "paused",
    "model": "curie",
    "training_file": "file-181a1cbdcdcf4677ada87f63a0928099",
    "finished_at": 1646127311,
    "id": "ft-72a2792ef7d24ba7b82c7fe4a37e379f",
    "created_at": 1646126127,
    "object": "fine_tuning.job"
  }
}

微調整 - 再開

POST {endpoint}/openai/fine_tuning/jobs/{fine-tuning-job-id}/resume?api-version=2025-04-01-preview

指定された微調整 ID で指定された微調整ジョブの処理を再開します。

URI Parameters

Request Header

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

Responses

状態コード: 200

説明: 微調整が正常に再開されました。

状態コード: 既定値

説明: エラーが発生しました。

Examples

POST {endpoint}/openai/fine_tuning/jobs/{fine-tuning-job-id}/resume?api-version=2025-04-01-preview

応答: 状態コード: 200

{
  "headers": {},
  "body": {
    "hyperparameters": {
      "n_epochs": -1
    },
    "integrations": [
      {
        "type": "wandb",
        "wandb": {
          "project": "custom-wandb-project",
          "tags": [
            "project:tag",
            "lineage"
          ]
        }
      }
    ],
    "method": {
      "type": "supervised"
    },
    "status": "resuming",
    "model": "curie",
    "training_file": "file-181a1cbdcdcf4677ada87f63a0928099",
    "finished_at": 1646127311,
    "id": "ft-72a2792ef7d24ba7b82c7fe4a37e379f",
    "created_at": 1646126127,
    "object": "fine_tuning.job"
  }
}

インジェスト ジョブ - 一覧表示

GET {endpoint}/openai/ingestion/jobs?api-version=2025-04-01-preview

インジェスト ジョブを一覧表示します。

URI Parameters

Request Header

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

Responses

状態コード: 200

Description: Success

状態コード: 既定値

説明: エラーが発生しました。

Examples

GET {endpoint}/openai/ingestion/jobs?api-version=2025-04-01-preview

応答: 状態コード: 200

{
  "body": {
    "value": [
      {
        "jobId": "usercompute-ingestion-job",
        "kind": "UserCompute",
        "workspaceId": "/subscriptions/f375b912-331c-4fc5-8e9f-2d7205e3e036/resourceGroups/adrama-copilot-demo/providers/Microsoft.MachineLearningServices/workspaces/adrama-rag-dev"
      },
      {
        "jobId": "syscompute-ingestion-job",
        "kind": "SystemCompute"
      }
    ]
  }
}

インジェスト ジョブ - 作成

PUT {endpoint}/openai/ingestion/jobs/{job-id}?api-version=2025-04-01-preview

指定したジョブ ID を使用してインジェスト ジョブを作成します。

URI Parameters

Request Header

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

Request Body

Content-Type: application/json

Responses

状態コード: 200

Description: Success

状態コード: 既定値

説明: エラーが発生しました。

Examples

PUT {endpoint}/openai/ingestion/jobs/{job-id}?api-version=2025-04-01-preview

応答: 状態コード: 200

{
  "headers": {
    "operation-location": "https://aoairesource.openai.azure.com/openai/ingestion/jobs/ingestion-job/runs/72a2792ef7d24ba7b82c7fe4a37e379f?api-version=2025-04-01-preview"
  },
  "body": {
    "kind": "SystemCompute",
    "jobId": "ingestion-job",
    "searchServiceConnection": {
      "kind": "EndpointWithManagedIdentity",
      "endpoint": "https://aykame-dev-search.search.windows.net"
    },
    "datasource": {
      "kind": "Storage",
      "connection": {
        "kind": "EndpointWithManagedIdentity",
        "endpoint": "https://mystorage.blob.core.windows.net/",
        "resourceId": "/subscriptions/1234567-abcd-1234-5678-1234abcd/resourceGroups/my-resource/providers/Microsoft.Storage/storageAccounts/mystorage"
      },
      "containerName": "container",
      "chunking": {
        "maxChunkSizeInTokens": 2048
      },
      "embeddings": [
        {
          "connection": {
            "kind": "RelativeConnection"
          },
          "deploymentName": "Ada"
        }
      ]
    },
    "dataRefreshIntervalInHours": 24,
    "completionAction": "keepAllAssets"
  }
}

PUT {endpoint}/openai/ingestion/jobs/{job-id}?api-version=2025-04-01-preview

応答: 状態コード: 200

{
  "headers": {
    "operation-location": "https://aoairesource.openai.azure.com/openai/ingestion/jobs/ingestion-job/runs/72a2792ef7d24ba7b82c7fe4a37e379f?api-version=2025-04-01-preview"
  },
  "body": {
    "kind": "UserCompute",
    "jobId": "ingestion-job",
    "workspaceId": "/subscriptions/f375b912-331c-4fc5-8e9f-2d7205e3e036/resourceGroups/adrama-copilot-demo/providers/Microsoft.MachineLearningServices/workspaces/adrama-rag-dev",
    "compute": {
      "kind": "ServerlessCompute"
    },
    "target": {
      "kind": "AzureAISearch",
      "connectionId": "/subscriptions/f375b912-331c-4fc5-8e9f-2d7205e3e036/resourceGroups/adrama-copilot-demo/providers/Microsoft.MachineLearningServices/workspaces/adrama-rag-dev/connections/search-connection"
    },
    "datasource": {
      "kind": "Dataset",
      "datasetId": "azureml://locations/centraluseuap/workspaces/83317fe6-efa6-4e4a-b020-d0edd11ec382/data/PlainText/versions/1",
      "datasetType": "uri_folder"
    }
  }
}

インジェスト ジョブ - 取得

GET {endpoint}/openai/ingestion/jobs/{job-id}?api-version=2025-04-01-preview

指定したジョブ ID の詳細を取得します。

URI Parameters

Request Header

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

Responses

状態コード: 200

Description: Success

状態コード: 既定値

説明: エラーが発生しました。

Examples

GET {endpoint}/openai/ingestion/jobs/{job-id}?api-version=2025-04-01-preview

応答: 状態コード: 200

{
  "body": {
    "kind": "UserCompute",
    "jobId": "ingestion-job",
    "workspaceId": "/subscriptions/f375b912-331c-4fc5-8e9f-2d7205e3e036/resourceGroups/adrama-copilot-demo/providers/Microsoft.MachineLearningServices/workspaces/adrama-rag-dev",
    "compute": {
      "kind": "ServerlessCompute"
    },
    "target": {
      "kind": "AzureAISearch",
      "connectionId": "/subscriptions/f375b912-331c-4fc5-8e9f-2d7205e3e036/resourceGroups/adrama-copilot-demo/providers/Microsoft.MachineLearningServices/workspaces/adrama-rag-dev/connections/search-connection"
    },
    "datasource": {
      "kind": "Dataset",
      "datasetId": "azureml://locations/centraluseuap/workspaces/83317fe6-efa6-4e4a-b020-d0edd11ec382/data/PlainText/versions/1",
      "datasetType": "uri_folder"
    }
  }
}

Ingestionjobruns - 一覧表示

GET {endpoint}/openai/ingestion/jobs/{job-id}/runs?api-version=2025-04-01-preview

指定したジョブ ID の実行を一覧表示します。

URI Parameters

Request Header

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

Responses

状態コード: 200

Description: Success

状態コード: 既定値

説明: エラーが発生しました。

Examples

GET {endpoint}/openai/ingestion/jobs/{job-id}/runs?api-version=2025-04-01-preview

応答: 状態コード: 200

{
  "body": {
    "value": [
      {
        "jobId": "ingestion-job",
        "runId": "f375b912-331c-4fc5-8e9f-2d7205e3e036",
        "status": "succeeded"
      },
      {
        "jobId": "ingestion-job",
        "runId": "07f2d192-add7-4202-a2e3-858c2577f4fd",
        "status": "failed"
      },
      {
        "jobId": "ingestion-job",
        "runId": "5ef7a436-1147-4cbb-82e0-3d502bcc6a7b",
        "status": "running"
      }
    ]
  }
}

Ingestionjobruns - 取得

GET {endpoint}/openai/ingestion/jobs/{job-id}/runs/{run-id}?api-version=2025-04-01-preview

指定したジョブ ID の一部として、指定した実行 ID の詳細を取得します。

URI Parameters

Request Header

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

Responses

状態コード: 200

Description: Success

状態コード: 既定値

説明: エラーが発生しました。

Examples

GET {endpoint}/openai/ingestion/jobs/{job-id}/runs/{run-id}?api-version=2025-04-01-preview

応答: 状態コード: 200

{
  "body": {
    "jobId": "ingestion-job",
    "runId": "5ef7a436-1147-4cbb-82e0-3d502bcc6a7b",
    "status": "running",
    "progress": {
      "stageProgress": [
        {
          "name": "Preprocessing",
          "totalItems": 14,
          "processedItems": 0,
          "state": "notRunning"
        },
        {
          "name": "Indexing",
          "state": "notRunning"
        }
      ]
    }
  }
}

モデル - リスト

GET {endpoint}/openai/models?api-version=2025-04-01-preview

Azure OpenAI リソースからアクセスできるすべてのモデルの一覧を取得します。

これには、基本モデルと、Azure OpenAI リソースが所有するすべての正常に完了した微調整されたモデルが含まれます。

URI Parameters

Request Header

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

Responses

状態コード: 200

Description: Success

状態コード: 既定値

説明: エラーが発生しました。

Examples

GET {endpoint}/openai/models?api-version=2025-04-01-preview

応答: 状態コード: 200

{
  "headers": {},
  "body": {
    "data": [
      {
        "status": "succeeded",
        "capabilities": {
          "fine_tune": true,
          "inference": true,
          "completion": true,
          "chat_completion": false,
          "embeddings": false
        },
        "lifecycle_status": `generally-available`,
        "deprecation": {
          "fine_tune": 1677662127,
          "inference": 1709284527
        },
        "id": "curie",
        "created_at": 1646126127,
        "object": "model"
      },
      {
        "status": "succeeded",
        "model": "curie",
        "fine_tune": "ft-72a2792ef7d24ba7b82c7fe4a37e379f",
        "capabilities": {
          "fine_tune": false,
          "inference": true,
          "completion": true,
          "chat_completion": false,
          "embeddings": false
        },
        "lifecycle_status": `generally-available`,
        "deprecation": {
          "inference": 1709284527
        },
        "id": "curie.ft-72a2792ef7d24ba7b82c7fe4a37e379f",
        "created_at": 1646126127,
        "object": "model"
      }
    ],
    "object": "list"
  }
}

モデル - 取得

GET {endpoint}/openai/models/{model-id}?api-version=2025-04-01-preview

指定された modelId で指定されたモデルの詳細を取得します。

URI Parameters

Request Header

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

Responses

状態コード: 200

Description: Success

状態コード: 既定値

説明: エラーが発生しました。

Examples

GET {endpoint}/openai/models/{model-id}?api-version=2025-04-01-preview

応答: 状態コード: 200

{
  "headers": {},
  "body": {
    "status": "succeeded",
    "capabilities": {
      "fine_tune": true,
      "inference": true,
      "completion": true,
      "chat_completion": false,
      "embeddings": false
    },
    "lifecycle_status": `generally-available`,
    "deprecation": {
      "fine_tune": 1677662127,
      "inference": 1709284527
    },
    "id": "curie",
    "created_at": 1646126127,
    "object": "model"
  }
}

GET {endpoint}/openai/models/{model-id}?api-version=2025-04-01-preview

応答: 状態コード: 200

{
  "headers": {},
  "body": {
    "status": "succeeded",
    "model": "curie",
    "fine_tune": "ft-72a2792ef7d24ba7b82c7fe4a37e379f",
    "capabilities": {
      "fine_tune": false,
      "inference": true,
      "completion": true,
      "chat_completion": false,
      "embeddings": false
    },
    "lifecycle_status": `generally-available`,
    "deprecation": {
      "inference": 1709284527
    },
    "id": "curie.ft-72a2792ef7d24ba7b82c7fe4a37e379f",
    "created_at": 1646126127,
    "object": "model"
  }
}

ファイルのアップロード - 開始

POST {endpoint}/openai/uploads?api-version=2025-04-01-preview

中間 Upload オブジェクトが作成され、パーツを追加できます。 現在、Upload のサイズは合計で最大 9 GB にすることができ、作成されてから 2 時間後に有効期限が切れます。

Upload が完了すると、アップロードされたすべてのパーツを含む File オブジェクトが生成されます。 この File オブジェクトは、他のファイルと同様に、プラットフォーム全体で使用できます。

URI Parameters

Request Header

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

Request Body

Content-Type: application/json

Request Body

Content-Type: text/json

Request Body

Content-Type: application/*+json

Responses

状態コード: 200

説明: アップロードが正常に作成されました。

状態コード: 既定値

説明: エラーが発生しました。

Examples

POST {endpoint}/openai/uploads?api-version=2025-04-01-preview

{
 "purpose": "fine-tune",
 "filename": "training_data_v21.jsonl",
 "bytes": 2097152,
 "mime_type": "application/json"
}

応答: 状態コード: 200

{
  "headers": {
    "location": "https://aoairesource.openai.azure.com/openai/uploads/runs/fine-tune-72a2792ef7d24ba7b82c7fe4a37e379f"
  },
  "body": {
    "bytes": 2097152,
    "filename": "training_data_v21.jsonl",
    "purpose": "fine-tune",
    "status": "pending",
    "expires_at": 1646133327,
    "file": {
      "status": "pending",
      "bytes": 140,
      "purpose": "fine-tune",
      "filename": "puppy.jsonl",
      "id": "file-181a1cbdcdcf4677ada87f63a0928099",
      "created_at": 1646126127,
      "object": "file"
    },
    "id": "fine-tune-72a2792ef7d24ba7b82c7fe4a37e379f",
    "created_at": 1646126127,
    "object": "upload"
  }
}

ファイルのアップロード - キャンセル

POST {endpoint}/openai/uploads/{upload-id}/cancel?api-version=2025-04-01-preview

Upload を取り消し、アップロードされたすべてのパーツが非同期的に削除されます。

Upload が取り消された後、Parts を追加することはできません。

URI Parameters

Request Header

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

Responses

状態コード: 200

Description: Success

状態コード: 既定値

説明: エラーが発生しました。

Examples

POST {endpoint}/openai/uploads/{upload-id}/cancel?api-version=2025-04-01-preview

応答: 状態コード: 200

{
  "headers": {},
  "body": {
    "bytes": 2097152,
    "filename": "training_data_v21.jsonl",
    "purpose": "fine-tune",
    "status": "cancelled",
    "expires_at": 1646133327,
    "file": {
      "status": "pending",
      "bytes": 140,
      "purpose": "fine-tune",
      "filename": "puppy.jsonl",
      "id": "file-181a1cbdcdcf4677ada87f63a0928099",
      "created_at": 1646126127,
      "object": "file"
    },
    "id": "fine-tune-72a2792ef7d24ba7b82c7fe4a37e379f",
    "created_at": 1646126127,
    "object": "upload"
  }
}

ファイルのアップロード - 完了

POST {endpoint}/openai/uploads/{upload-id}/complete?api-version=2025-04-01-preview

これで Upload が完了し、返された Upload オブジェクトには、プラットフォーム全体で使用できる入れ子になった File オブジェクトが含まれます。

Parts ID の順序付きリストを指定することで、Parts の順序を定義できます。

アップロードされた合計バイト数は、Upload オブジェクトの作成時に最初に指定したサイズと一致している必要があります。

この操作の後は、Upload が完了した後に追加の Parts を追加することはできません。

URI Parameters

Request Header

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

Request Body

Content-Type: application/json

Request Body

Content-Type: text/json

Request Body

Content-Type: application/*+json

Responses

状態コード: 200

Description: Success

状態コード: 既定値

説明: エラーが発生しました。

Examples

POST {endpoint}/openai/uploads/{upload-id}/complete?api-version=2025-04-01-preview

{
 "part_ids": [
  "LnmictL3p0u4LH/ko343nw==",
  "LmmictL3p0u4LH/ko343nw=="
 ]
}

応答: 状態コード: 200

{
  "headers": {},
  "body": {
    "bytes": 2097152,
    "filename": "training_data_v21.jsonl",
    "purpose": "fine-tune",
    "status": "completed",
    "expires_at": 1646133327,
    "file": {
      "status": "processed",
      "bytes": 140,
      "purpose": "fine-tune",
      "filename": "puppy.jsonl",
      "id": "file-181a1cbdcdcf4677ada87f63a0928099",
      "created_at": 1646126127,
      "object": "file"
    },
    "id": "fine-tune-72a2792ef7d24ba7b82c7fe4a37e379f",
    "created_at": 1646126127,
    "object": "upload"
  }
}

ファイルのアップロード - 部分

POST {endpoint}/openai/uploads/{upload-id}/parts?api-version=2025-04-01-preview

アップロード オブジェクトにパーツを追加します。各パーツは、アップロードするファイルのセグメントを表します。

各 Parts は、File の目的に基づいて、ファイルアップロードの標準サイズ制限に達することができます。 9 GB の Uplaod サイズ制限に達するまで、Parts の追加を続けることができます。

URI Parameters

Request Header

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

Request Body

Content-Type: multipart/form-data

Responses

状態コード: 200

Description: Success

状態コード: 既定値

説明: エラーが発生しました。

Examples

POST {endpoint}/openai/uploads/{upload-id}/parts?api-version=2025-04-01-preview

応答: 状態コード: 200

{
  "headers": {},
  "body": {
    "upload_id": "fine-tune-72a2792ef7d24ba7b82c7fe4a37e379f",
    "azure_block_id": "LnmictL3p0u4LH/ko343nw==",
    "id": "uplprt-72a2792ef7d24ba7b82c7fe4a37e379f",
    "created_at": 1646126127,
    "object": "upload.part"
  }
}

Components

AzureAISearchIndex

Azure AI 検索インデックス。

BaseConnection

リソースへの接続。

BaseConnection の識別子

このコンポーネントでは、プロパティ kind を使用して、さまざまな型を区別します。

Batch

バッチの値を定義します。

BatchCreateRequest

バッチを作成する要求を定義します。

BatchErrorData

バッチ内の失敗のエラー情報。

BatchErrors

失敗したバッチの場合、エラーの原因に関する詳細情報が含まれます。

BatchRequestCounts

バッチ内のさまざまな状態の要求の数。

BatchOutputReference

出力を格納するAzure Storage フォルダー。

BatchStatus

バッチの状態。

BatchesList

バッチの一覧を表します。

Capabilities

基本モデルまたは微調整モデルの機能。

Choice

ChoiceMessage

ChunkingSettings

Chunking settings

CompletionAction

完了アクション。

ComputeType

コンピューティングの種類。

ConnectionStringConnection

Connection string接続。

ConnectionType

接続の種類。

CosmosDBIndex

CosmosDB Index.

CrawlingSettings

Crawling settings

CreateEvalCompletionsRunDataSource

モデル サンプリング構成を記述する CompletionsRunDataSource オブジェクト。

CreateEvalCustomDataSourceConfig

評価実行に使用されるデータ ソースのスキーマを定義する CustomDataSourceConfig オブジェクト。 このスキーマは、データの形状を次のように定義するために使用されます。テスト条件を設定するために使用されるデータ、および実行を作成する際に必要となるデータ。

CreateEvalItem

プロンプトまたはコンテキストを構成するチャット メッセージ。 "item" 名前空間 ({{item.name}} など) への変数参照を含めることができます。

CreateEvalJsonlRunDataSource

eval に一致する JSONL ファイルを指定する JsonlRunDataSource オブジェクト

CreateEvalLabelModelGrader

モデルを使用して評価の各項目にラベルを割り当てる LabelModelGrader オブジェクト。

CreateEvalLogsDataSourceConfig

格納された補完クエリのメタデータプロパティを指定するデータソース構成。 これは通常、 usecase=chatbot や prompt-version=v2などのメタデータです。

CreateEvalRequest

CreateEvalRunRequest

CreateEvalStoredCompletionsRunDataSource

フィルターのセットを記述する StoredCompletionsRunDataSource 構成

CustomCompute

Custom compute.

DeploymentConnection

相対デプロイ接続。

Deprecation

モデルのさまざまなユース ケースの非推奨の日付を定義します。

通常、基本モデルでは、作成後 1 年間の微調整がサポートされます。 推論は通常、ベースモデルまたは微調整されたモデルの作成から 2 年後にサポートされます。 正確な日付はプロパティで指定されます。

DpoHyperparamsRequest

微調整の DPO 方法のハイパーパラメーター

DpoMethod

DPO メソッドの微調整の要求

DpoMethodConfigRequest

dpo 微調整方法の構成。 DPO 固有のハイパーパラメーターを含む

DpoMethodRequest

DPO メソッドの微調整の要求

EndpointKeyConnection

エンドポイント キー接続。

EndpointMIConnection

エンドポイント マネージド ID 接続。

Error

Microsoft REST ガイドラインで定義されているエラーの内容。

ErrorCode

Microsoft REST ガイドラインで定義されているエラー コード。

ErrorResponse

Microsoft REST ガイドラインで定義されているエラー応答。

Eval

データ ソース構成とテスト条件を持つ Eval オブジェクト。 Eval は、LLM 統合のために実行するタスクを表します。 Like:

• チャットボットの品質を向上させる
• チャットボットがカスタマー サポートをどの程度適切に処理しているかを確認する
• o3-miniがgpt-4oよりも私のユースケースで優れているかどうかを確認する

EvalApiError

Eval API からのエラー応答を表すオブジェクト。

EvalCustomDataSourceConfig

itemのスキーマを指定し、必要に応じてsampleの名前空間を指定するCustomDataSourceConfig。 応答スキーマは以下のデータの形状を定義します：- テスト基準を定義するために使用されるデータ、および- 実行を作成する際に必要なデータ。

EvalFileRunDataSource

ファイル ID を持つ FileRunDataSource 構成

EvalItem

命令フォロー階層を示すロールを含むモデルへのメッセージ入力。 developerロールまたはsystemロールで指定された命令は、userロールで指定された命令よりも優先されます。 assistant ロールを持つメッセージは、以前の操作でモデルによって生成されたものと見なされます。

EvalJsonlFileContentSource

EvalJsonlFileIdSource

EvalLabelModelGrader

モデルを使用して評価の各項目にラベルを割り当てる LabelModelGrader オブジェクト。

EvalList

評価のリストを表すオブジェクト。