Microsoft Foundry 模型中的 Azure OpenAI 編寫 REST API 預覽參考

本文提供 Azure OpenAI 的推斷 REST API 端點詳細資料。

API 規格

對 Azure OpenAI 模型和資源的管理與互動，分別由三個主要 API 介面執行：

• 控制平面
• 資料平面 - 製作
• 資料平面 - 推斷

每個 API 介面/規格都會封裝一組不同的 Azure OpenAI 功能。 每個 API 都各有獨特的預覽版和穩定/正式發行 (GA) API 版本。 預覽版本目前通常會遵循每月頻率。

認證

Azure OpenAI 提供兩種驗證方法。 您可以使用 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 日期結構。 例如：

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 參數

請求標頭

使用令牌型驗證或 API 金鑰。 建議使用令牌型驗證進行驗證，且更安全。

回覆

狀態碼：200

描述：成功

狀態碼：預設值

描述：發生錯誤。

範例

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

從上傳的要求檔案建立和執行批次。

回應包含加入佇列作業的詳細資料，包括作業狀態。

結果檔案的識別碼會在完成之後新增至回應。

URI 參數

請求標頭

使用令牌型驗證或 API 金鑰。 建議使用令牌型驗證進行驗證，且更安全。

請求主體

Content-Type：application/json

回覆

狀態代碼： 201

描述：已成功建立批次。

狀態碼：預設值

描述：發生錯誤。

範例

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

取得指定批次識別碼所指定單一批次的詳細資料。

URI 參數

請求標頭

使用令牌型驗證或 API 金鑰。 建議使用令牌型驗證進行驗證，且更安全。

回覆

狀態碼：200

描述：成功

狀態碼：預設值

描述：發生錯誤。

範例

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

取消指定批次識別碼所指定批次的處理。

URI 參數

請求標頭

使用令牌型驗證或 API 金鑰。 建議使用令牌型驗證進行驗證，且更安全。

回覆

狀態碼：200

描述：已成功取消批次。

狀態碼：預設值

描述：發生錯誤。

範例

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 參數

請求標頭

使用令牌型驗證或 API 金鑰。 建議使用令牌型驗證進行驗證，且更安全。

回覆

狀態碼：200

描述：成功

狀態碼：預設值

描述：發生錯誤。

範例

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

依指定的預存完成識別碼取得預存完成。

URI 參數

請求標頭

使用令牌型驗證或 API 金鑰。 建議使用令牌型驗證進行驗證，且更安全。

回覆

狀態碼：200

描述：成功

狀態碼：預設值

描述：發生錯誤。

範例

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

依指定的預存完成識別碼更新預存完成。

URI 參數

請求標頭

使用令牌型驗證或 API 金鑰。 建議使用令牌型驗證進行驗證，且更安全。

請求主體

Content-Type：application/json

回覆

狀態碼：200

描述：成功

狀態碼：預設值

描述：發生錯誤。

範例

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

刪除指定的預存完成識別碼的預存完成。

URI 參數

請求標頭

使用令牌型驗證或 API 金鑰。 建議使用令牌型驗證進行驗證，且更安全。

回覆

狀態碼：200

描述：已成功刪除預存的完成項目。

狀態碼：預設值

描述：發生錯誤。

範例

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

依指定的預存完成識別碼取得預存完成訊息。

URI 參數

請求標頭

使用令牌型驗證或 API 金鑰。 建議使用令牌型驗證進行驗證，且更安全。

回覆

狀態碼：200

描述：成功

狀態碼：預設值

描述：發生錯誤。

範例

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

列出專案的評估細項。

URI 參數

請求標頭

使用令牌型驗證或 API 金鑰。 建議使用令牌型驗證進行驗證，且更安全。

回覆

狀態碼：200

描述：評估清單

範例

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 參數

請求標頭

使用令牌型驗證或 API 金鑰。 建議使用令牌型驗證進行驗證，且更安全。

回覆

狀態代碼： 201

描述：正常

範例

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 參數

請求標頭

使用令牌型驗證或 API 金鑰。 建議使用令牌型驗證進行驗證，且更安全。

回覆

狀態碼：200

描述：已成功刪除評估。

狀態代碼： 404

描述：找不到評估。

範例

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

依識別碼取得評估。

URI 參數

請求標頭

使用令牌型驗證或 API 金鑰。 建議使用令牌型驗證進行驗證，且更安全。

回覆

狀態碼：200

描述：評估

範例

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 參數

請求標頭

使用令牌型驗證或 API 金鑰。 建議使用令牌型驗證進行驗證，且更安全。

回覆

狀態碼：200

描述：更新的評估

範例

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 參數

請求標頭

使用令牌型驗證或 API 金鑰。 建議使用令牌型驗證進行驗證，且更安全。

回覆

狀態碼：200

描述：評估的執行清單

範例

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 參數

請求標頭

使用令牌型驗證或 API 金鑰。 建議使用令牌型驗證進行驗證，且更安全。

回覆

狀態代碼： 201

描述：已成功為評估建立執行

狀態代碼： 400

描述：錯誤的請求（例如遺漏評估物件）

範例

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 參數

請求標頭

使用令牌型驗證或 API 金鑰。 建議使用令牌型驗證進行驗證，且更安全。

回覆

狀態碼：200

描述：已成功刪除評估回合

狀態代碼： 404

描述：找不到執行

範例

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

取得依識別碼的評估執行。

URI 參數

請求標頭

使用令牌型驗證或 API 金鑰。 建議使用令牌型驗證進行驗證，且更安全。

回覆

狀態碼：200

描述：評估回合

範例

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 參數

請求標頭

使用令牌型驗證或 API 金鑰。 建議使用令牌型驗證進行驗證，且更安全。

回覆

狀態碼：200

描述：取消的評估運行對象

範例

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 參數

請求標頭

使用令牌型驗證或 API 金鑰。 建議使用令牌型驗證進行驗證，且更安全。

回覆

狀態碼：200

描述：評估回合的輸出項目清單

範例

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

依識別碼取得評估執行輸出項目。

URI 參數

請求標頭

使用令牌型驗證或 API 金鑰。 建議使用令牌型驗證進行驗證，且更安全。

回覆

狀態碼：200

描述：評估執行輸出項目

範例

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 資源所擁有的所有檔案清單。

其中包括使用者上傳的內容，例如具有目的為「微調」的檔案，用於定型或驗證微調模型，以及服務所產生的檔案，例如 「fine-tune-results」，其中包含對應微調作業的各種計量。

URI 參數

請求標頭

使用令牌型驗證或 API 金鑰。 建議使用令牌型驗證進行驗證，且更安全。

回覆

狀態碼：200

描述：成功

狀態碼：預設值

描述：發生錯誤。

範例

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 參數

請求標頭

使用令牌型驗證或 API 金鑰。 建議使用令牌型驗證進行驗證，且更安全。

請求主體

Content-Type：multipart/form-data

回覆

狀態代碼： 201

描述：已成功建立檔案。

狀態碼：預設值

描述：發生錯誤。

範例

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 參數

請求標頭

使用令牌型驗證或 API 金鑰。 建議使用令牌型驗證進行驗證，且更安全。

請求主體

Content-Type：application/json

回覆

狀態代碼： 201

描述：已成功建立檔案。

狀態碼：預設值

描述：發生錯誤。

範例

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

取得指定 file-id 所指定之單一檔案的詳細資料，包括狀態、大小、用途等。

URI 參數

請求標頭

使用令牌型驗證或 API 金鑰。 建議使用令牌型驗證進行驗證，且更安全。

回覆

狀態碼：200

描述：成功

狀態碼：預設值

描述：發生錯誤。

範例

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

刪除具有指定檔案識別碼的檔案。

如果使用檔案，例如微調作業中的訓練檔案，則也允許刪除。

URI 參數

請求標頭

使用令牌型驗證或 API 金鑰。 建議使用令牌型驗證進行驗證，且更安全。

回覆

狀態碼：200

描述：已成功刪除檔案。

狀態碼：預設值

描述：發生錯誤。

範例

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

取得指定 file-id 所指定檔案的內容。

檔案可以是用戶上傳的內容，或由服務產生，例如微調作業的結果計量。

URI 參數

請求標頭

使用令牌型驗證或 API 金鑰。 建議使用令牌型驗證進行驗證，且更安全。

回覆

狀態碼：200

描述：成功

狀態碼：預設值

描述：發生錯誤。

範例

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 參數

請求標頭

使用令牌型驗證或 API 金鑰。 建議使用令牌型驗證進行驗證，且更安全。

回覆

狀態碼：200

描述：成功

狀態碼：預設值

描述：發生錯誤。

範例

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 參數

請求標頭

使用令牌型驗證或 API 金鑰。 建議使用令牌型驗證進行驗證，且更安全。

請求主體

Content-Type：application/json

回覆

狀態代碼： 201

描述：已成功建立微調。

狀態碼：預設值

描述：發生錯誤。

範例

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

取得指定 fine-tune-id 所指定單一微調作業的詳細資料。

詳細數據包含基底模型、定型和驗證檔案、超參數、時間戳、狀態和事件。

當作業狀態變更 (例如執行或完成) 時，以及上傳結果時，就會建立事件。

URI 參數

請求標頭

使用令牌型驗證或 API 金鑰。 建議使用令牌型驗證進行驗證，且更安全。

回覆

狀態碼：200

描述：成功

狀態碼：預設值

描述：發生錯誤。

範例

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

刪除指定的 fine-tune-id 所指定的微調作業。

URI 參數

請求標頭

使用令牌型驗證或 API 金鑰。 建議使用令牌型驗證進行驗證，且更安全。

回覆

狀態代碼： 204

描述：已成功刪除微調。

狀態碼：預設值

描述：發生錯誤。

範例

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

取消指定 fine-tune-id 所指定微調作業的處理。

URI 參數

請求標頭

使用令牌型驗證或 API 金鑰。 建議使用令牌型驗證進行驗證，且更安全。

回覆

狀態碼：200

描述：已成功取消微調

狀態碼：預設值

描述：發生錯誤。

範例

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

取得指定 fine-tune-id 所指定微調作業的檢查點。

檢查點會在訓練期間成功的 Epoch 結尾建立。

URI 參數

請求標頭

使用令牌型驗證或 API 金鑰。 建議使用令牌型驗證進行驗證，且更安全。

回覆

狀態碼：200

描述：成功

狀態碼：預設值

描述：發生錯誤。

範例

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

取得指定 fine-tune-id 所指定微調作業的事件。

當作業狀態變更 (例如執行或完成) 時，以及上傳結果時，就會建立事件。

URI 參數

請求標頭

使用令牌型驗證或 API 金鑰。 建議使用令牌型驗證進行驗證，且更安全。

回覆

狀態碼：200

描述：成功

狀態碼：預設值

描述：發生錯誤。

範例

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

暫停指定 fine-tune-id 所指定微調作業的處理。

URI 參數

請求標頭

使用令牌型驗證或 API 金鑰。 建議使用令牌型驗證進行驗證，且更安全。

回覆

狀態碼：200

描述：微調已成功暫停。

狀態碼：預設值

描述：發生錯誤。

範例

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

繼續處理指定 fine-tune-id 所指定的微調作業。

URI 參數

請求標頭

使用令牌型驗證或 API 金鑰。 建議使用令牌型驗證進行驗證，且更安全。

回覆

狀態碼：200

描述：已成功繼續微調。

狀態碼：預設值

描述：發生錯誤。

範例

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 參數

請求標頭

使用令牌型驗證或 API 金鑰。 建議使用令牌型驗證進行驗證，且更安全。

回覆

狀態碼：200

描述：成功

狀態碼：預設值

描述：發生錯誤。

範例

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

使用指定的作業識別碼建立擷取作業。

URI 參數

請求標頭

使用令牌型驗證或 API 金鑰。 建議使用令牌型驗證進行驗證，且更安全。

請求主體

Content-Type：application/json

回覆

狀態碼：200

描述：成功

狀態碼：預設值

描述：發生錯誤。

範例

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

取得指定作業識別碼的詳細資料。

URI 參數

請求標頭

使用令牌型驗證或 API 金鑰。 建議使用令牌型驗證進行驗證，且更安全。

回覆

狀態碼：200

描述：成功

狀態碼：預設值

描述：發生錯誤。

範例

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

列出指定作業識別碼的執行。

URI 參數

請求標頭

使用令牌型驗證或 API 金鑰。 建議使用令牌型驗證進行驗證，且更安全。

回覆

狀態碼：200

描述：成功

狀態碼：預設值

描述：發生錯誤。

範例

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

取得指定執行識別碼的詳細資料，作為指定作業識別碼的一部分。

URI 參數

請求標頭

使用令牌型驗證或 API 金鑰。 建議使用令牌型驗證進行驗證，且更安全。

回覆

狀態碼：200

描述：成功

狀態碼：預設值

描述：發生錯誤。

範例

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 參數

請求標頭

使用令牌型驗證或 API 金鑰。 建議使用令牌型驗證進行驗證，且更安全。

回覆

狀態碼：200

描述：成功

狀態碼：預設值

描述：發生錯誤。

範例

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 參數

請求標頭

使用令牌型驗證或 API 金鑰。 建議使用令牌型驗證進行驗證，且更安全。

回覆

狀態碼：200

描述：成功

狀態碼：預設值

描述：發生錯誤。

範例

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，且會在建立後兩小時到期。

Upload 完成後，將產生 File 物件，其中包含所有上傳的組件。 然後，這個 File 物件就可用於我們的平台，就像任何其他檔案一樣。

URI 參數

請求標頭

使用令牌型驗證或 API 金鑰。 建議使用令牌型驗證進行驗證，且更安全。

請求主體

Content-Type：application/json

請求主體

Content-Type：text/json

請求主體

Content-Type：application/*+json

回覆

狀態碼：200

描述：已成功建立上傳。

狀態碼：預設值

描述：發生錯誤。

範例

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 之後，可能不會新增任何組件。

URI 參數

請求標頭

使用令牌型驗證或 API 金鑰。 建議使用令牌型驗證進行驗證，且更安全。

回覆

狀態碼：200

描述：成功

狀態碼：預設值

描述：發生錯誤。

範例

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 物件，已準備好可供跨平台使用。

您可以藉由提供組件識別碼的排序清單來定義組件的順序。

上傳的位元組總數必須符合建立 Upload 物件時原本指定的大小。

在此作業後，就無法在完成 Upload 之後新增其他組件。

URI 參數

請求標頭

使用令牌型驗證或 API 金鑰。 建議使用令牌型驗證進行驗證，且更安全。

請求主體

Content-Type：application/json

請求主體

Content-Type：text/json

請求主體

Content-Type：application/*+json

回覆

狀態碼：200

描述：成功

狀態碼：預設值

描述：發生錯誤。

範例

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

將 Part 新增至 Upload 物件，其中每個 Part 代表您要上傳之檔案的區段。

根據 File 用途，每個組件最多可達檔案上傳的標準大小限制。 您可以繼續新增組件，直到達到 Upload 大小限制 9 GB 為止。

URI 參數

請求標頭

使用令牌型驗證或 API 金鑰。 建議使用令牌型驗證進行驗證，且更安全。

請求主體

Content-Type：multipart/form-data

回覆

狀態碼：200

描述：成功

狀態碼：預設值

描述：發生錯誤。

範例

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"
  }
}

元件

AzureAI搜尋索引

Azure AI 搜尋服務索引。

BaseConnection

與資源的連線。

BaseConnection 的鑑別子

此元件會使用 屬性 kind 來區分不同的類型：

Batch

定義批次的值。

批量創建請求 (BatchCreateRequest)

定義建立批次的要求。

批次錯誤資料

批次中失敗的錯誤資訊。

批量錯誤

對於失敗的批次，這將會包含失敗原因的詳細資訊。

BatchRequestCounts

要求會計算批次內不同狀態的要求計數。

BatchOutputReference

用來儲存輸出的 Azure 記憶體資料夾。

BatchStatus

批次的狀態。

BatchesList

表示批次清單。

能力

基本或微調模型的功能。

選擇

ChoiceMessage

ChunkingSettings

區塊化設定

CompletionAction

完成動作。

計算類型

計算類型。

ConnectionStringConnection

連接字串連線。

連接類型

連線類型。

CosmosDB索引

CosmosDB 索引。

CrawlingSettings

編目設定

CreateEvalCompletionsRunDataSource

CompletionsRunDataSource 物件，描述模型取樣組態。

創建自訂評估資料來源配置

CustomDataSourceConfig 物件，定義用於評估執行的數據源架構。 此架構可用來定義數據的形狀：- 用來定義測試準則和 - 建立執行時需要哪些數據

建立評估項目

組成提示或內容的聊天訊息。 可能包含 “item” 命名空間的變數參考，即 {{item.name}}。

CreateEvalJsonlRunDataSource

JsonlRunDataSource 物件，指定符合評估的 JSONL 檔案

CreateEvalLabelModelGrader

LabelModelGrader 物件，使用模型將標籤指派給評估中的每個專案。

CreateEvalLogsDataSourceConfig

資料來源設定，指定預存完成查詢的中繼資料屬性。 這通常是像 usecase=chatbot 或 prompt-version=v2 等的元數據。

CreateEvalRequest

CreateEvalRunRequest

CreateEvalStoredCompletionsRunDataSource

描述一組篩選條件的 StoredCompletionsRunDataSource 組態

自定義計算 (CustomCompute)

自訂計算。

DeploymentConnection

相對部署連線。

淘汰

定義模型不同使用案例的淘汰日期。

在建立之後，通常基本模型支援 1 年的微調。 在建立基本或微調模型之後，通常支援推斷 2 年。 確切的日期會指定於屬性中。

DpoHyperparamsRequest

微調 DPO 方法的超參數

DpoMethod

DPO 方法微調的要求

DpoMethodConfigRequest

dpo 微調方法的設定。 包含 DPO 專屬超參數

DpoMethodRequest

DPO 方法微調的要求

EndpointKeyConnection

端點金鑰連線。

EndpointMIConnection

端點受控識別連線。

錯誤

Microsoft REST 指導方針中所定義的錯誤內容。

錯誤代碼

Microsoft REST 指導方針中所定義的錯誤碼。

ErrorResponse

Microsoft REST 指導方針中所定義的錯誤回應。

Eval

具有數據源組態和測試準則的 Eval 物件。 評估代表要為 LLM 整合完成的工作。 例如：

• 改善聊天機器人的品質
• 查看聊天機器人如何處理客戶支援
• 檢查 o3-mini 在我的使用案例是否比 gpt-4o 更好

EvalApiError

物件，表示來自 Eval API 的錯誤回應。

EvalCustomDataSourceConfig

CustomDataSourceConfig，指定您的 item 的架構，並可選擇指定 sample 命名空間。 回應架構會定義數據的形狀：- 用來定義測試準則和 - 建立執行時需要哪些數據

EvalFileRunDataSource

具有檔案標識碼的 FileRunDataSource 組態

EvalItem

對於模型的訊息輸入，角色指出下列階層的指示。 由 developer 或 system 角色給出的指示優先於由角色 user 給出的指示。 具有 assistant 角色的訊息被認為是在先前交互作用中由模型產生的。

EvalJsonlFileContentSource

EvalJsonlFileIdSource

EvalLabelModelGrader

LabelModelGrader 物件，使用模型將標籤指派給評估中的每個專案。