Azure AI 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

从上传的请求文件创建和执行批处理。

响应包括排队作业的详细信息，包括作业状态。

完成后，结果文件的 ID 将添加到响应中。

URI 参数

请求标头

使用基于令牌的身份验证或 API 密钥。 建议使用基于令牌的身份验证进行身份验证，更安全。

请求主体

“内容类型”: 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

获取由给定批处理 ID 指定的单个批处理的详细信息。

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

取消由给定批处理 ID 指定的批处理的处理。

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

按给定的存储完成 ID 获取存储的完成。

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

按给定的存储完成 ID 更新存储的完成。

URI 参数

请求标头

使用基于令牌的身份验证或 API 密钥。 建议使用基于令牌的身份验证进行身份验证，更安全。

请求主体

“内容类型”: 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

按给定的存储完成 ID 删除存储的完成。

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

按给定的存储完成 ID 获取存储的完成消息。

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

按 ID 获取评估。

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

说明：错误的请求（例如缺少 eval 对象）

例子

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

按 ID 获取评估运行。

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

按 ID 获取评估运行输出项。

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 资源拥有的所有文件的列表。

其中包括用户上传的内容（如用于训练或验证微调模型）的文件，以及服务生成的文件（如“微调结果”），其中包含相应微调作业的各种指标。

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 密钥。 建议使用基于令牌的身份验证进行身份验证，更安全。

请求主体

内容类型：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 密钥。 建议使用基于令牌的身份验证进行身份验证，更安全。

请求主体

“内容类型”: 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

获取给定文件 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

删除具有给定文件 ID 的文件。

如果一个文件被使用，例如作为微调任务的训练文件时，也允许删除。

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

获取由给定文件 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 密钥。 建议使用基于令牌的身份验证进行身份验证，更安全。

请求主体

“内容类型”: 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

获取由给定的微调 ID 指定的微调作业的检查点。

检查点是在训练期间成功的轮次结束时创建的。

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

创建具有指定作业 ID 的引入作业。

URI 参数

请求标头

使用基于令牌的身份验证或 API 密钥。 建议使用基于令牌的身份验证进行身份验证，更安全。

请求主体

“内容类型”: 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

获取指定作业 ID 的详细信息。

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

列出指定作业 ID 的运行。

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

获取作为指定作业 ID 的一部分的指定运行 ID 的详细信息。

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

将创建一个中间上传对象，使你可以向其添加部件。 目前，上传大小最多可为 9 GB，创建后两小时将过期。

上传完成后，将生成文件对象，其中包含所有上传的部分。 然后，此文件对象可以像任何其他文件一样在我们的平台上使用。

URI 参数

请求标头

使用基于令牌的身份验证或 API 密钥。 建议使用基于令牌的身份验证进行身份验证，更安全。

请求主体

“内容类型”: 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

取消上传，并将导致所有上传的部分以异步方式删除。

取消上传后，不会添加任何部件。

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 对象包含一个嵌套文件对象，该对象可供跨平台使用。

可以通过提供部件 ID 的有序列表来定义部件的顺序。

上传的总字节数必须与最初在创建 Upload 对象时指定的大小匹配。

完成上传后，无需添加其他部件。

URI 参数

请求标头

使用基于令牌的身份验证或 API 密钥。 建议使用基于令牌的身份验证进行身份验证，更安全。

请求主体

“内容类型”: 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

将部件添加到 Upload 对象，其中每个部件表示要上传的文件段。

根据文件用途，每个部件最多可达到文件上传的标准大小限制。 可以继续添加部件，直到达到上传大小限制 9 GB。

URI 参数

请求标头

使用基于令牌的身份验证或 API 密钥。 建议使用基于令牌的身份验证进行身份验证，更安全。

请求主体

内容类型：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"
  }
}

组件

Azure人工智能搜索索引

Azure AI 搜索索引。

BaseConnection

与资源的连接。

BaseConnection 的鉴别器

此组件使用属性 kind 区分不同类型的：

批次

定义批处理的值。

BatchCreateRequest

定义创建批处理的请求。

批处理错误数据

批处理中失败的错误信息。

批量错误

对于失败的批处理，这将包含有关失败原因的详细信息。

BatchRequestCounts

请求对批处理中不同状态进行计数。

BatchOutputReference

用于存储输出的 Azure 存储文件夹。

BatchStatus

批处理的状态。

BatchesList

表示批处理的列表。

能力

基本模型或微调模型的功能。

选择

ChoiceMessage

ChunkingSettings

分块设置

CompletionAction

完成操作。

计算类型 (ComputeType)

计算类型。

ConnectionStringConnection

连接字符串连接。

连接类型

连接类型。

CosmosDBIndex

CosmosDB 索引。

CrawlingSettings

爬网设置

CreateEvalCompletionsRunDataSource

描述模型采样配置的 CompletionsRunDataSource 对象。

CreateEvalCustomDataSourceConfig

一个 CustomDataSourceConfig 对象，用于定义用于评估运行的数据源的架构。 此架构用于定义数据的形状：- 用于定义测试条件和 - 创建运行时需要哪些数据

CreateEvalItem

构成提示或上下文的聊天消息。 可能包括对“item”命名空间的变量引用，即 {{item.name}}。

CreateEvalJsonlRunDataSource

一个 JsonlRunDataSource 对象，该对象指定与 eval 匹配的 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 准则中定义的错误代码。

错误响应

Microsoft REST 准则中定义的错误响应。

评估

具有数据源配置和测试条件的 Eval 对象。 评估表示要为 LLM 集成完成的任务。 喜欢：

• 提高聊天机器人的质量
• 了解聊天机器人如何处理客户支持
• 检查 o3-mini 在我的用例中是否比 gpt-4o 更好

EvalApiError

一个对象，表示来自 Eval API 的错误响应。

EvalCustomDataSourceConfig

一个 CustomDataSourceConfig，用于指定你的 item 架构和可选 sample 命名空间。 响应架构定义数据的形状，即： - 用于定义测试条件和 - 创建运行时需要哪些数据

EvalFileRunDataSource

包含文件 ID 的 FileRunDataSource 配置

EvalItem

模型的消息输入，具有指示以下层次结构的说明的角色。 使用 developer 或 system 角色提供的说明优先于角色 user 提供的说明。 假定具有 assistant 角色的消息是由模型在以前的交互中生成的。

评估Jsonl文件内容来源

EvalJsonlFileIdSource

EvalLabelModelGrader

一个 LabelModelGrader 对象，该对象使用模型将标签分配给评估中的每个项。