Справочник по предварительной версии REST API для Разработки моделей Microsoft Foundry в Azure OpenAI

В этой статье приведена информация о конечных точках вывода REST API для Azure OpenAI.

Спецификации API

Управление и взаимодействие с моделями и ресурсами Azure OpenAI разделены на три основных поверхности API:

• Контрольная плоскость
• Плоскость данных — авторинг
• Плоскость данных — вывод

Каждая поверхность/спецификация API инкапсулирует разный набор возможностей Azure OpenAI. Каждый API имеет свой уникальный набор версий предварительного просмотра и стабильных/общедоступных (GA) версий API. В настоящее время превью обычно выходят по ежемесячному ритму.

Authentication

Azure OpenAI предлагает два метода аутентификации. Вы можете использовать либо API Keys, либо Microsoft Entra ID.

• Аутентификация ключа API: для такого типа аутентификации все запросы API должны содержать ключ API в api-key заголовке HTTP. Quickstart предоставляет рекомендации по совершению звонков с помощью такого типа аутентификации.

• Microsoft Entra ID аутентификация: Вы можете аутентифицировать вызов API с помощью токена Microsoft Entra. Токены аутентификации включены в запрос в качестве Authorization заголовка. Предоставленный токен должен быть предшествован Bearer, например Bearer YOUR_AUTH_TOKEN, . Вы можете прочитать наше руководство по аутентификации с помощью Microsoft Entra ID.

Версионирование REST API

API сервисов версируются с использованием api-version параметра запроса. Все версии следуют структуре ГГГГ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.

Если вы ищете документацию по последнему выпуску API общедоступной версии, обратитесь к последнему API вывода плоскости данных общедоступной версии.

Партия — список

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

Получает список всех партий, принадлежащих ресурсу Azure OpenAI.

Параметры URI

Заголовок запроса

Используйте либо аутентификация на основе токенов, либо API-ключ. Рекомендуется аутентификация с помощью токен-аутентификации и более безопасной.

Ответы

Код статуса: 200

Описание: успех

Код статуса: по умолчанию

Описание: произошла ошибка.

Examples

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

Ответы: Код статуса: 200

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

Пакет — создание

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

Создаёт и выполняет пакет из загруженного файла запросов.

Ответ содержит детали заложенной в очереди вакансии, включая статус работы.

ID файла результата добавляется в ответ после завершения.

Параметры URI

Заголовок запроса

Используйте либо аутентификация на основе токенов, либо API-ключ. Рекомендуется аутентификация с помощью токен-аутентификации и более безопасной.

Тело запроса

Тип содержания: application/json

Ответы

Код статуса: 201

Описание: Партия успешно собрана.

Код статуса: по умолчанию

Описание: произошла ошибка.

Examples

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

Ответы: Статус кода: 201

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

Партия — Get

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

Получает данные для одной партии, заданной с идентификатором партии.

Параметры URI

Заголовок запроса

Используйте либо аутентификация на основе токенов, либо API-ключ. Рекомендуется аутентификация с помощью токен-аутентификации и более безопасной.

Ответы

Код статуса: 200

Описание: успех

Код статуса: по умолчанию

Описание: произошла ошибка.

Examples

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

Ответы: Код статуса: 200

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

Партия — отмена

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

Отменяет обработку партии, заданной с указанным идентификатором партии.

Параметры URI

Заголовок запроса

Используйте либо аутентификация на основе токенов, либо API-ключ. Рекомендуется аутентификация с помощью токен-аутентификации и более безопасной.

Ответы

Код статуса: 200

Описание: Партия успешно отменена.

Код статуса: по умолчанию

Описание: произошла ошибка.

Examples

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

Ответы: Код статуса: 200

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

Сохраненное завершение — список

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

Получает список сохранённых завершений.

Параметры URI

Заголовок запроса

Используйте либо аутентификация на основе токенов, либо API-ключ. Рекомендуется аутентификация с помощью токен-аутентификации и более безопасной.

Ответы

Код статуса: 200

Описание: успех

Код статуса: по умолчанию

Описание: произошла ошибка.

Examples

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

Ответы: Код статуса: 200

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

Сохраненное завершение — получить

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

Сохраняется завершение по заданному идентификатору сохранённого завершения.

Параметры URI

Заголовок запроса

Используйте либо аутентификация на основе токенов, либо API-ключ. Рекомендуется аутентификация с помощью токен-аутентификации и более безопасной.

Ответы

Код статуса: 200

Описание: успех

Код статуса: по умолчанию

Описание: произошла ошибка.

Examples

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

Ответы: Код статуса: 200

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

Сохраненное завершение — обновление

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

Обновите сохраненное завершение по заданному идентификатору сохранённого завершения.

Параметры URI

Заголовок запроса

Используйте либо аутентификация на основе токенов, либо API-ключ. Рекомендуется аутентификация с помощью токен-аутентификации и более безопасной.

Тело запроса

Тип содержания: application/json

Ответы

Код статуса: 200

Описание: успех

Код статуса: по умолчанию

Описание: произошла ошибка.

Examples

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

Ответы: Код статуса: 200

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

Сохраненное завершение — Удалить

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

Удалить сохранённое завершение по заданному идентификатору сохранённого завершения.

Параметры URI

Заголовок запроса

Используйте либо аутентификация на основе токенов, либо API-ключ. Рекомендуется аутентификация с помощью токен-аутентификации и более безопасной.

Ответы

Код статуса: 200

Описание: Сохранённое завершение было успешно удалено.

Код статуса: по умолчанию

Описание: произошла ошибка.

Examples

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

Ответы: Код статуса: 200

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

Сохраненное завершение — Getmessages

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

Получает хранящиеся сообщения о завершении по заданному идентификатору сохранённого завершения.

Параметры URI

Заголовок запроса

Используйте либо аутентификация на основе токенов, либо API-ключ. Рекомендуется аутентификация с помощью токен-аутентификации и более безопасной.

Ответы

Код статуса: 200

Описание: успех

Код статуса: по умолчанию

Описание: произошла ошибка.

Examples

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

Ответы: Код статуса: 200

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

Оценка — Список получения

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

Перечислите оценки для проекта.

Параметры URI

Заголовок запроса

Используйте либо аутентификация на основе токенов, либо API-ключ. Рекомендуется аутентификация с помощью токен-аутентификации и более безопасной.

Ответы

Код статуса: 200

Описание: Список оценок

Examples

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

Ответы: Код статуса: 200

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

Оценка — Создание

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

Создайте структуру оценки, которую можно использовать для проверки производительности модели. Оценка — это набор критериев тестирования и источник данных. После создания оценки можно запускать её на разных моделях и параметрах моделей. Мы поддерживаем несколько типов оценщиков и источников данных.

Параметры URI

Заголовок запроса

Используйте либо аутентификация на основе токенов, либо API-ключ. Рекомендуется аутентификация с помощью токен-аутентификации и более безопасной.

Ответы

Код статуса: 201

Описание: ОК

Examples

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

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

Ответы: Статус кода: 201

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

Оценка — Удалить

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

Удалить оценку.

Параметры URI

Заголовок запроса

Используйте либо аутентификация на основе токенов, либо API-ключ. Рекомендуется аутентификация с помощью токен-аутентификации и более безопасной.

Ответы

Код статуса: 200

Описание: Успешно удалил оценку.

Код статуса: 404

Описание: Оценка не обнаружена.

Examples

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

Ответы: Код статуса: 200

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

Код статуса: 404

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

Оценка — Получить

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

Пройдите обследование по ID.

Параметры URI

Заголовок запроса

Используйте либо аутентификация на основе токенов, либо API-ключ. Рекомендуется аутентификация с помощью токен-аутентификации и более безопасной.

Ответы

Код статуса: 200

Описание: Оценка

Examples

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

Ответы: Код статуса: 200

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

Оценка — обновление

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

Обновите определённые свойства оценки.

Параметры URI

Заголовок запроса

Используйте либо аутентификация на основе токенов, либо API-ключ. Рекомендуется аутентификация с помощью токен-аутентификации и более безопасной.

Ответы

Код статуса: 200

Описание: Обновлённая оценка

Examples

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

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

Ответы: Код статуса: 200

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

Оценка — Getrunlist

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

Получите список забегов для оценки.

Параметры URI

Заголовок запроса

Используйте либо аутентификация на основе токенов, либо API-ключ. Рекомендуется аутентификация с помощью токен-аутентификации и более безопасной.

Ответы

Код статуса: 200

Описание: Список забегов для оценки

Examples

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

Ответы: Код статуса: 200

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

Оценка — Создать, запустить

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

Создайте новый пробег оценки. Это конечная точка, с которой начнётся оценка оценки.

Параметры URI

Заголовок запроса

Используйте либо аутентификация на основе токенов, либо API-ключ. Рекомендуется аутентификация с помощью токен-аутентификации и более безопасной.

Ответы

Код статуса: 201

Описание: Успешно создал пробег для оценки

Статус кода: 400

Описание: Плохой запрос (например, отсутствующий объект оценки)

Examples

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

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

Ответы: Статус кода: 201

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

Оценка — Удаление запуска

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

Удалить пробег по оценке.

Параметры URI

Заголовок запроса

Используйте либо аутентификация на основе токенов, либо API-ключ. Рекомендуется аутентификация с помощью токен-аутентификации и более безопасной.

Ответы

Код статуса: 200

Описание: успешно удалил пробег по оценке

Код статуса: 404

Описание: Бег не найден

Examples

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

Ответы: Код статуса: 200

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

Код статуса: 404

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

Оценка — Беги

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

Проведите обследование в ID.

Параметры URI

Заголовок запроса

Используйте либо аутентификация на основе токенов, либо API-ключ. Рекомендуется аутентификация с помощью токен-аутентификации и более безопасной.

Ответы

Код статуса: 200

Описание: Оценочный забег

Examples

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

Ответы: Код статуса: 200

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

Оценка — Cancel run

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

Отменить текущий запуск оценки.

Параметры URI

Заголовок запроса

Используйте либо аутентификация на основе токенов, либо API-ключ. Рекомендуется аутентификация с помощью токен-аутентификации и более безопасной.

Ответы

Код статуса: 200

Описание: объект запуска с отменённой оценкой

Examples

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

Ответы: Код статуса: 200

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

Оценка - Getrunoutputitems

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

Получите список выходных элементов для оценочного запуска.

Параметры URI

Заголовок запроса

Используйте либо аутентификация на основе токенов, либо API-ключ. Рекомендуется аутентификация с помощью токен-аутентификации и более безопасной.

Ответы

Код статуса: 200

Описание: Список выходных элементов для оценочного запуска

Examples

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

Ответы: Код статуса: 200

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

Оценка - Getrunoutputitem

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

Получите вывод для оценки, запусти по ID.

Параметры URI

Заголовок запроса

Используйте либо аутентификация на основе токенов, либо API-ключ. Рекомендуется аутентификация с помощью токен-аутентификации и более безопасной.

Ответы

Код статуса: 200

Описание: Выводной элемент оценочного запуска

Examples

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

Ответы: Код статуса: 200

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

Файлы — список

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

Получает список всех файлов, принадлежащих ресурсу Azure OpenAI.

К ним относятся пользовательский контент, например файлы с целью «fine-tune» для обучения или валидации моделей fine-tune, а также файлы, генерируемые сервисом, например «fine-tune-results», содержащие различные метрики для соответствующей задачи тонкой настройки.

Параметры URI

Заголовок запроса

Используйте либо аутентификация на основе токенов, либо API-ключ. Рекомендуется аутентификация с помощью токен-аутентификации и более безопасной.

Ответы

Код статуса: 200

Описание: успех

Код статуса: по умолчанию

Описание: произошла ошибка.

Examples

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

Ответы: Код статуса: 200

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

Файлы — Загрузка

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

Создаёт новую файловую сущность, загрузив данные с локальной машины. Загруженные файлы, например, могут использоваться для обучения или оценки тонко настроенных моделей.

Параметры URI

Заголовок запроса

Используйте либо аутентификация на основе токенов, либо API-ключ. Рекомендуется аутентификация с помощью токен-аутентификации и более безопасной.

Тело запроса

Content-Type: многочастный формат данных

Ответы

Код статуса: 201

Описание: Файл успешно создан.

Код статуса: по умолчанию

Описание: произошла ошибка.

Examples

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

Ответы: Статус кода: 201

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

Файлы — импорт

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

Создаёт новую сущность файла, импортируя данные с предоставленного URL. Загруженные файлы, например, могут использоваться для обучения или оценки тонко настроенных моделей.

Параметры URI

Заголовок запроса

Используйте либо аутентификация на основе токенов, либо API-ключ. Рекомендуется аутентификация с помощью токен-аутентификации и более безопасной.

Тело запроса

Тип содержания: application/json

Ответы

Код статуса: 201

Описание: Файл успешно создан.

Код статуса: по умолчанию

Описание: произошла ошибка.

Examples

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

Ответы: Статус кода: 201

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

Файлы - Получить

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

Получает данные для одного файла, указанного в данном идентификаторе файла, включая статус, размер, назначение и т.д.

Параметры URI

Заголовок запроса

Используйте либо аутентификация на основе токенов, либо API-ключ. Рекомендуется аутентификация с помощью токен-аутентификации и более безопасной.

Ответы

Код статуса: 200

Описание: успех

Код статуса: по умолчанию

Описание: произошла ошибка.

Examples

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

Ответы: Код статуса: 200

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

Файлы — Удалить

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

Удаляет файл с указанным ID файла.

Удаление также разрешено, если файл использовался, например, в качестве обучающего файла в задании тонкой настройки.

Параметры URI

Заголовок запроса

Используйте либо аутентификация на основе токенов, либо API-ключ. Рекомендуется аутентификация с помощью токен-аутентификации и более безопасной.

Ответы

Код статуса: 200

Описание: Файл был успешно удален.

Код статуса: по умолчанию

Описание: произошла ошибка.

Examples

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

Ответы: Код статуса: 200

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

Файлы - Получить контент

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

Получает содержимое файла, указанного в данном идентификаторе файла.

Файлы могут быть загруженным пользователем контентом или генерироваться сервисом, подобными метрикам результатов работы по тонкой настройке.

Параметры URI

Заголовок запроса

Используйте либо аутентификация на основе токенов, либо API-ключ. Рекомендуется аутентификация с помощью токен-аутентификации и более безопасной.

Ответы

Код статуса: 200

Описание: успех

Код статуса: по умолчанию

Описание: произошла ошибка.

Examples

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

Ответы: Код статуса: 200

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

Тонкая настройка — список

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

Получает список всех заданий для тонкой настройки, принадлежащих ресурсу Azure OpenAI. Детали, возвращаемые для каждого задания тонкой настройки, помимо идентификатора, содержат базовую модель, файлы обучения и валидации, гиперпараметры, временные метки, статус и события.

События создаются при изменении статуса работы. Например, запущенные или полные, и когда загружаются результаты.

Параметры URI

Заголовок запроса

Используйте либо аутентификация на основе токенов, либо API-ключ. Рекомендуется аутентификация с помощью токен-аутентификации и более безопасной.

Ответы

Код статуса: 200

Описание: успех

Код статуса: по умолчанию

Описание: произошла ошибка.

Examples

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

Ответы: Код статуса: 200

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

Тонкая настройка — создание

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

Создаёт задание, которое тонко настраивает заданную модель из данного обучающего файла.

Ответ включает детали задания в очереди, включая статус и гиперпараметры.

Название тонко настроенной модели добавляется к ответу после завершения.

Параметры URI

Заголовок запроса

Используйте либо аутентификация на основе токенов, либо API-ключ. Рекомендуется аутентификация с помощью токен-аутентификации и более безопасной.

Тело запроса

Тип содержания: application/json

Ответы

Код статуса: 201

Описание: Тонкая настройка успешно создана.

Код статуса: по умолчанию

Описание: произошла ошибка.

Examples

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

Ответы: Статус кода: 201

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

Тонкая настройка — Get

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

Получает данные для одного задания тонкой настройки, заданного fine-tune-id.

Детали содержат базовую модель, файлы обучения и валидации, гиперпараметры, временные метки, статус и события.

События создаются при изменении статуса работы, например, при выполнении или завершении, а также при загрузке результатов.

Параметры URI

Заголовок запроса

Используйте либо аутентификация на основе токенов, либо API-ключ. Рекомендуется аутентификация с помощью токен-аутентификации и более безопасной.

Ответы

Код статуса: 200

Описание: успех

Код статуса: по умолчанию

Описание: произошла ошибка.

Examples

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

Ответы: Код статуса: 200

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

Тонкая настройка — Delete

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

Удаляет задание тонкой настройки, заданное fine-tune-id.

Параметры URI

Заголовок запроса

Используйте либо аутентификация на основе токенов, либо API-ключ. Рекомендуется аутентификация с помощью токен-аутентификации и более безопасной.

Ответы

Статус кода: 204

Описание: Тонкая настройка была успешно удалена.

Код статуса: по умолчанию

Описание: произошла ошибка.

Examples

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

Ответы: Код статуса: 204

{
  "headers": {}
}

Тонкая настройка — отмена

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

Отменяет обработку задачи тонкой настройки, заданной fine-tune-id.

Параметры URI

Заголовок запроса

Используйте либо аутентификация на основе токенов, либо API-ключ. Рекомендуется аутентификация с помощью токен-аутентификации и более безопасной.

Ответы

Код статуса: 200

Описание: Тонкая настройка была успешно отменена

Код статуса: по умолчанию

Описание: произошла ошибка.

Examples

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

Ответы: Код статуса: 200

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

Тонкая настройка — получение контрольных точек

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

Получает контрольные точки для задачи тонкой настройки, указанной в данном fine-tune-id.

Контрольные точки создаются в конце успешных эпох во время тренировок.

Параметры URI

Заголовок запроса

Используйте либо аутентификация на основе токенов, либо API-ключ. Рекомендуется аутентификация с помощью токен-аутентификации и более безопасной.

Ответы

Код статуса: 200

Описание: успех

Код статуса: по умолчанию

Описание: произошла ошибка.

Examples

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

Ответы: Код статуса: 200

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

Тонкая настройка — получите события

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

Получает события для задания тонкой настройки, заданной fine-tune-id.

События создаются при изменении статуса работы, например, при выполнении или завершении, а также при загрузке результатов.

Параметры URI

Заголовок запроса

Используйте либо аутентификация на основе токенов, либо API-ключ. Рекомендуется аутентификация с помощью токен-аутентификации и более безопасной.

Ответы

Код статуса: 200

Описание: успех

Код статуса: по умолчанию

Описание: произошла ошибка.

Examples

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

Ответы: Код статуса: 200

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

Тонкая настройка — пауза

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

Пауза в обработке задачи тонкой настройки, заданной fine-tune-id.

Параметры URI

Заголовок запроса

Используйте либо аутентификация на основе токенов, либо API-ключ. Рекомендуется аутентификация с помощью токен-аутентификации и более безопасной.

Ответы

Код статуса: 200

Описание: Тонкая настройка успешно приостановлена.

Код статуса: по умолчанию

Описание: произошла ошибка.

Examples

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

Ответы: Код статуса: 200

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

Тонкая настройка — Резюме

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

Возобновляет обработку задачи тонкой настройки, заданной fine-tune-id.

Параметры URI

Заголовок запроса

Используйте либо аутентификация на основе токенов, либо API-ключ. Рекомендуется аутентификация с помощью токен-аутентификации и более безопасной.

Ответы

Код статуса: 200

Описание: Тонкая настройка была успешно возобновлена.

Код статуса: по умолчанию

Описание: произошла ошибка.

Examples

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

Ответы: Код статуса: 200

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

Вакансии для прогружения — список

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

Перечисляет задачи по употреблению.

Параметры URI

Заголовок запроса

Используйте либо аутентификация на основе токенов, либо API-ключ. Рекомендуется аутентификация с помощью токен-аутентификации и более безопасной.

Ответы

Код статуса: 200

Описание: успех

Код статуса: по умолчанию

Описание: произошла ошибка.

Examples

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

Ответы: Код статуса: 200

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

Задания на погружение — создание

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

Создаёт задание на погружение с указанным идентификатором задания.

Параметры URI

Заголовок запроса

Используйте либо аутентификация на основе токенов, либо API-ключ. Рекомендуется аутентификация с помощью токен-аутентификации и более безопасной.

Тело запроса

Тип содержания: application/json

Ответы

Код статуса: 200

Описание: успех

Код статуса: по умолчанию

Описание: произошла ошибка.

Examples

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

Ответы: Код статуса: 200

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

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

Ответы: Код статуса: 200

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

Вакансии на проглатывание — получите

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

Получает данные указанного идентификатора работы.

Параметры URI

Заголовок запроса

Используйте либо аутентификация на основе токенов, либо API-ключ. Рекомендуется аутентификация с помощью токен-аутентификации и более безопасной.

Ответы

Код статуса: 200

Описание: успех

Код статуса: по умолчанию

Описание: произошла ошибка.

Examples

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

Ответы: Код статуса: 200

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

Ingestionjobruns — Список

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

Перечисляет запуски указанного идентификатора задания.

Параметры URI

Заголовок запроса

Используйте либо аутентификация на основе токенов, либо API-ключ. Рекомендуется аутентификация с помощью токен-аутентификации и более безопасной.

Ответы

Код статуса: 200

Описание: успех

Код статуса: по умолчанию

Описание: произошла ошибка.

Examples

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

Ответы: Код статуса: 200

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

Ingestionjobruns - Получить

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

Получает детали указанного идентификатора запуска как часть указанного идентификатора задания.

Параметры URI

Заголовок запроса

Используйте либо аутентификация на основе токенов, либо API-ключ. Рекомендуется аутентификация с помощью токен-аутентификации и более безопасной.

Ответы

Код статуса: 200

Описание: успех

Код статуса: по умолчанию

Описание: произошла ошибка.

Examples

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

Ответы: Код статуса: 200

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

Модели — Список

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

Получает список всех моделей, доступных через ресурс Azure OpenAI.

К ним относятся базовые модели, а также все успешно завершённые тонко настроенные модели, принадлежащие ресурсу Azure OpenAI.

Параметры URI

Заголовок запроса

Используйте либо аутентификация на основе токенов, либо API-ключ. Рекомендуется аутентификация с помощью токен-аутентификации и более безопасной.

Ответы

Код статуса: 200

Описание: успех

Код статуса: по умолчанию

Описание: произошла ошибка.

Examples

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

Ответы: Код статуса: 200

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

Модели — Получите

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

Получает данные для модели, указанной в данной modelId.

Параметры URI

Заголовок запроса

Используйте либо аутентификация на основе токенов, либо API-ключ. Рекомендуется аутентификация с помощью токен-аутентификации и более безопасной.

Ответы

Код статуса: 200

Описание: успех

Код статуса: по умолчанию

Описание: произошла ошибка.

Examples

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

Ответы: Код статуса: 200

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

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

Ответы: Код статуса: 200

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

Загрузка файла — Начало

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

Создаётся промежуточный объект загрузки, позволяющий добавлять в него части. В настоящее время максимальный размер загрузки может достигать 9 ГБ и истекает через два часа после создания.

После завершения загрузки будет сгенерирован объект File, содержащий все загруженные части. Этот объект File можно использовать на нашей платформе, как и любой другой файл.

Параметры URI

Заголовок запроса

Используйте либо аутентификация на основе токенов, либо API-ключ. Рекомендуется аутентификация с помощью токен-аутентификации и более безопасной.

Тело запроса

Тип содержания: application/json

Тело запроса

Content-Type: text/json

Тело запроса

Content-Type: application/*+json

Ответы

Код статуса: 200

Описание: Загрузка успешно создана.

Код статуса: по умолчанию

Описание: произошла ошибка.

Examples

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

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

Ответы: Код статуса: 200

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

Загрузка файла — отмена

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

Отменяет загрузку, и все загруженные части будут удалены асинхронно.

После отмены загрузки детали не могут быть добавлены.

Параметры URI

Заголовок запроса

Используйте либо аутентификация на основе токенов, либо API-ключ. Рекомендуется аутентификация с помощью токен-аутентификации и более безопасной.

Ответы

Код статуса: 200

Описание: успех

Код статуса: по умолчанию

Описание: произошла ошибка.

Examples

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

Ответы: Код статуса: 200

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

Файл загрузки — Полностью

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

Это завершает загрузку, и возвращаемый объект Upload содержит вложенный объект File, готовый к использованию на всей платформе.

Порядок деталей можно определить, предоставив упорядоченный список идентификаторов деталей.

Общее количество загруженных байт должно совпадать с изначально указанным при создании объекта Upload.

После этой операции дополнительные детали не могут быть добавлены после завершения загрузки.

Параметры URI

Заголовок запроса

Используйте либо аутентификация на основе токенов, либо API-ключ. Рекомендуется аутентификация с помощью токен-аутентификации и более безопасной.

Тело запроса

Тип содержания: application/json

Тело запроса

Content-Type: text/json

Тело запроса

Content-Type: application/*+json

Ответы

Код статуса: 200

Описание: успех

Код статуса: по умолчанию

Описание: произошла ошибка.

Examples

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

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

Ответы: Код статуса: 200

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

Загрузка файла — часть

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

Добавляет часть к объекту загрузки, где каждая часть представляет сегмент загружаемого файла.

Каждая деталь может соответствовать стандартному лимиту размера для загрузки файла, в зависимости от цели файла. Вы можете продолжать добавлять детали до достижения лимита по размеру загрузки в 9 ГБ.

Параметры URI

Заголовок запроса

Используйте либо аутентификация на основе токенов, либо API-ключ. Рекомендуется аутентификация с помощью токен-аутентификации и более безопасной.

Тело запроса

Content-Type: многочастный формат данных

Ответы

Код статуса: 200

Описание: успех

Код статуса: по умолчанию

Описание: произошла ошибка.

Examples

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

Ответы: Код статуса: 200

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

Компоненты

Индекс поиска Azure AI

индекс Поиск с использованием ИИ Azure.

BaseConnection

Связь с ресурсом.

Дискриминатор для BaseConnection

Этот компонент использует свойство kind для различия различных типов:

Пакет

Определяет значения партии.

ЗапросНаПакетноеСоздание

Определяет запрос на создание партии.

Данные об ошибках при пакетной обработке

Информация об ошибке при сбое в пакете.

Ошибки пакета

Для партий с неудачей это содержит дополнительную информацию о причинах отказов.

Подсчёт пакетных запросов

Запрос учитывается для разных статусов внутри партии.

BatchOutputReference

Папка служба хранилища Azure для хранения выходных данных.

BatchStatus

Статус партии.

BatchesList

Представляет собой список партий.

Возможности

Возможности базовой или тонкой настройки модели.

Выбор

ChoiceMessage

ChunkingSettings

Параметры блокирования

Действие завершения

Действие завершения.

ТипВычислений

Тип вычисления.

СтрокаПодключения

Соединение строк соединения.

ConnectionType

Тип соединения.

CosmosDBIndex

Индекс CosmosDB.

Обход контентаSettings

Параметры обхода контента

СоздатьИсточникДанныхЗапускаОцениванияАвтозавершений

Объект CompletionsRunDataSource, описывающий конфигурацию выборки модели.

СозданиеНастройкиПользовательскогоИсточникаДанныхДляОценки

Объект CustomDataSourceConfig, определяющий схему для источника данных, используемого для выполнения оценки. Эта схема используется для определения формы данных, которые будут: - Используются для определения критериев тестирования и - Какие данные требуются при создании запуска

СоздатьЭлементОценки

Сообщение в чате, которое составляет запрос или контекст. Может содержать переменные ссылки на пространство имён «item», то есть {{item.name}}.

CreateEvalJsonlRunDataSource

Объект JsonlRunDataSource с этим задаёт JSONL-файл, совпадающий с eval

CreateEvalLabelModelGrader

Объект LabelModelGrader, который использует модель для присвоения меток каждому элементу в оценке.

Создать конфигурацию источника данных для журналов оценки

Конфигурация источника данных, которая задаёт свойство метаданных вашего сохранённого запроса о завершениях. Обычно это метаданные, такие как usecase=chatbot или prompt-version=v2и т.д.

СоздатьЗапросОценки

СоздатьЗапросНаВыполнениеОценки

Хранилище результатов запуска CreateEvalStoredCompletions

Конфигурация StoredCompletionsRunDataSource, описывающая набор фильтров

CustomCompute

Пользовательские вычисления.

DeploymentConnection

Относительная связь развертывания.

Депрекация

Определяет даты устаревания для различных сценариев использования модели.

Обычно базовые модели поддерживают 1 год тонкой настройки после создания. Вывод обычно поддерживается через 2 года после создания базовых или тонко настроенных моделей. Точные даты указаны в объектах.

DpoHyperparamsRequest

Гиперпараметры для метода тонкой настройки DPO

DpoMethod

Запрос на тонкую настройку метода DPO

DpoMethodConfigRequest

Конфигурация для dpo метода тонкой настройки. Включает специфические для DPO гиперпараметры

DpoMethodRequest

Запрос на тонкую настройку метода DPO

EndpointKeyConnection

Подключение ключей к конечной точке.

EndpointMIConnection

Управление идентификацией конечной точки.

Error

Содержимое ошибок, определенное в руководящих принципах Microsoft REST.

Код ошибки

Коды ошибок, определённые в руководствах Microsoft REST.

Ответ об ошибке

Ответ на ошибку, как определено в Microsoft REST-руководствах.

Оценка

Объект Eval с конфигурацией источника данных и критериями тестирования. Оценка представляет собой задачу, которую нужно выполнить для интеграции вашей LLM. Нравится:

• Улучшить качество моего чатбота
• Посмотрите, как мой чат-бот справляется с поддержкой клиентов
• Проверьте, подходит ли для меня O3-mini, чем GPT-4O

ОшибкаEvalApi

Объект, представляющий ответ на ошибку из Eval API.

EvalCustomDataSourceConfig

CustomDataSourceConfig, который задаёт схему ваших item и, по sample желанию, пространств имён. Схема ответа определяет форму данных, которые будут следующими: - Используемыми для определения критериев тестирования и - Какие данные требуются при создании запуска

EvalFileRunDataSource

Конфигурация FileRunDataSource с идентификатором файла

ЭвалАйтем

Ввод сообщения в модель с ролью, указывающей инструкцию по иерархии. Инструкции, заданные с developer ролью OR system , имеют приоритет над инструкциями, даемыми ролью user . Сообщения с этой assistant ролью предполагаются как сгенерированные моделью в предыдущих взаимодействиях.

ИсточникСодержимогоEvalJsonlФайла

EvalJsonlFileIdSource

EvalLabelModelGrader

Объект LabelModelGrader, который использует модель для присвоения меток каждому элементу в оценке.

Список оценок

Объект, представляющий список оценок.