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

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

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

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

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

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

Important

Теперь появился новый API предпросмотра вывода. Узнайте больше в нашем руководстве по жизненному циклу API.

API	Последний превью релиза	Последний релиз GA	Specifications	Описание
Контрольная плоскость	2025-07-01-preview	2025-06-01	Файлы спецификаций	API плоскости управления используется для операций, таких как создание ресурсов, развертывание моделей и другие задачи управления ресурсами высокого уровня. Плоскость управления также регулирует, что можно делать с такими возможностями, как Azure Resource Manager, Bicep, Terraform и Azure CLI.
Плоскость данных	v1 preview	v1	Файлы спецификаций	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

Имя.	In	Обязательный	Тип	Описание
endpoint	path	Yes	string url	Поддерживается Azure конечных точек OpenAI (протокол и имя хоста, например: https://aoairesource.openai.azure.com. Замените «aoairesource» на имя вашего ресурса Azure OpenAI). https://{your-resource-name}.openai.azure.com
После	Запрос	Нет	string	Идентификатор последнего события из предыдущего запроса на пагинацию.
limit	Запрос	Нет	целое число	Количество партий для извлечения. По умолчанию 20.
$filter	Запрос	Нет	string	Выражение OData для описания условий фильтрации.
$orderby	Запрос	Нет	string	Выражение OData для описания порядка сортировки.
api-version	Запрос	Yes	string	Запрошенная версия API.

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

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

Имя.	Обязательный	Тип	Описание
Authorization	True	string	Пример:Authorization: Bearer {Azure_OpenAI_Auth_Token} Для генерации токена аутентификации с помощью Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Тип: oauth2 URL авторизации: https://login.microsoftonline.com/common/oauth2/v2.0/authorize Область применения: https://ai.azure.com/.default
API-ключ	True	string	Предоставьте ключ API Azure OpenAI здесь

Ответы

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

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

Тип содержимого	Тип	Description
application/json	BatchesList

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

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

Тип содержимого	Тип	Description
application/json	ErrorResponse

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

Имя.	In	Обязательный	Тип	Описание
endpoint	path	Yes	string url	Поддерживается Azure конечных точек OpenAI (протокол и имя хоста, например: https://aoairesource.openai.azure.com. Замените «aoairesource» на имя вашего ресурса Azure OpenAI). https://{your-resource-name}.openai.azure.com
api-version	Запрос	Yes	string	Запрошенная версия API.

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

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

Имя.	Обязательный	Тип	Описание
Authorization	True	string	Пример:Authorization: Bearer {Azure_OpenAI_Auth_Token} Для генерации токена аутентификации с помощью Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Тип: oauth2 URL авторизации: https://login.microsoftonline.com/common/oauth2/v2.0/authorize Область применения: https://ai.azure.com/.default
API-ключ	True	string	Предоставьте ключ API Azure OpenAI здесь

Тело запроса

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

Имя.	Тип	Описание	Обязательный	По умолчанию
окно завершения	string	Сроки, в течение которых должна быть обработана партия.	Yes
endpoint	string	Конечная точка API, используемая пакетом.	Yes
input_blob	string	URL blob служба хранилища Azure для использования в качестве входа для batch.	Нет
идентификатор_входного_файла	string	ID входного файла для партии.	Нет
metadata	object	Набор пар ключ-значение, которые можно прикрепить к партии. Это может быть полезно для хранения дополнительной информации о партии в структурированном формате.	Нет
вывод истекает после	FileExpiresAfter	Определяет срок действия файла.	Нет
папка вывода	BatchOutputReference	Папка служба хранилища Azure для хранения выходных данных.	Нет

Ответы

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

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

Тип содержимого	Тип	Description
application/json	Партия

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

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

Тип содержимого	Тип	Description
application/json	ErrorResponse

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

Имя.	In	Обязательный	Тип	Описание
endpoint	path	Yes	string url	Поддерживается Azure конечных точек OpenAI (протокол и имя хоста, например: https://aoairesource.openai.azure.com. Замените «aoairesource» на имя вашего ресурса Azure OpenAI). https://{your-resource-name}.openai.azure.com
идентификатор партии	path	Yes	string	Идентификатор партии.
api-version	Запрос	Yes	string	Запрошенная версия API.

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

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

Имя.	Обязательный	Тип	Описание
Authorization	True	string	Пример:Authorization: Bearer {Azure_OpenAI_Auth_Token} Для генерации токена аутентификации с помощью Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Тип: oauth2 URL авторизации: https://login.microsoftonline.com/common/oauth2/v2.0/authorize Область применения: https://ai.azure.com/.default
API-ключ	True	string	Предоставьте ключ API Azure OpenAI здесь

Ответы

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

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

Тип содержимого	Тип	Description
application/json	Партия

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

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

Тип содержимого	Тип	Description
application/json	ErrorResponse

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

Имя.	In	Обязательный	Тип	Описание
endpoint	path	Yes	string url	Поддерживается Azure конечных точек OpenAI (протокол и имя хоста, например: https://aoairesource.openai.azure.com. Замените «aoairesource» на имя вашего ресурса Azure OpenAI). https://{your-resource-name}.openai.azure.com
идентификатор партии	path	Yes	string	Идентификатор партии.
api-version	Запрос	Yes	string	Запрошенная версия API.

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

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

Имя.	Обязательный	Тип	Описание
Authorization	True	string	Пример:Authorization: Bearer {Azure_OpenAI_Auth_Token} Для генерации токена аутентификации с помощью Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Тип: oauth2 URL авторизации: https://login.microsoftonline.com/common/oauth2/v2.0/authorize Область применения: https://ai.azure.com/.default
API-ключ	True	string	Предоставьте ключ API Azure OpenAI здесь

Ответы

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

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

Тип содержимого	Тип	Description
application/json	Партия

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

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

Тип содержимого	Тип	Description
application/json	ErrorResponse

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

Имя.	In	Обязательный	Тип	Описание
endpoint	path	Yes	string url	Поддерживается Azure конечных точек OpenAI (протокол и имя хоста, например: https://aoairesource.openai.azure.com. Замените «aoairesource» на имя вашего ресурса Azure OpenAI). https://{your-resource-name}.openai.azure.com
metadata	Запрос	Нет	string	Фильтруйте по паре (ключ, значение) в сохранённом завершении.
model	Запрос	Нет	string	Фильтруйте по названию модели.
После	Запрос	Нет	string	Идентификатор последнего сохраненного завершения из предыдущего запроса на страницирование.
limit	Запрос	Нет	целое число	Количество сохранённых завершений для извлечения. По умолчанию 20.
заказ	Запрос	Нет	string	Порядок результатов по созданному времени (восходящее или убывающее). По умолчанию используйте описание.
api-version	Запрос	Yes	string	Запрошенная версия API.

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

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

Имя.	Обязательный	Тип	Описание
Authorization	True	string	Пример:Authorization: Bearer {Azure_OpenAI_Auth_Token} Для генерации токена аутентификации с помощью Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Тип: oauth2 URL авторизации: https://login.microsoftonline.com/common/oauth2/v2.0/authorize Область применения: https://ai.azure.com/.default
API-ключ	True	string	Предоставьте ключ API Azure OpenAI здесь

Ответы

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

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

Тип содержимого	Тип	Description
application/json	СохраненныйСписокЗавершения

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

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

Тип содержимого	Тип	Description
application/json	ErrorResponse

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

Имя.	In	Обязательный	Тип	Описание
endpoint	path	Yes	string url	Поддерживается Azure конечных точек OpenAI (протокол и имя хоста, например: https://aoairesource.openai.azure.com. Замените «aoairesource» на имя вашего ресурса Azure OpenAI). https://{your-resource-name}.openai.azure.com
сохранённый идентификатор завершения	path	Yes	string	Идентификатор сохранённого завершения.
api-version	Запрос	Yes	string	Запрошенная версия API.

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

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

Имя.	Обязательный	Тип	Описание
Authorization	True	string	Пример:Authorization: Bearer {Azure_OpenAI_Auth_Token} Для генерации токена аутентификации с помощью Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Тип: oauth2 URL авторизации: https://login.microsoftonline.com/common/oauth2/v2.0/authorize Область применения: https://ai.azure.com/.default
API-ключ	True	string	Предоставьте ключ API Azure OpenAI здесь

Ответы

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

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

Тип содержимого	Тип	Description
application/json	StoredCompletionResponse

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

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

Тип содержимого	Тип	Description
application/json	ErrorResponse

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

Имя.	In	Обязательный	Тип	Описание
endpoint	path	Yes	string url	Поддерживается Azure конечных точек OpenAI (протокол и имя хоста, например: https://aoairesource.openai.azure.com. Замените «aoairesource» на имя вашего ресурса Azure OpenAI). https://{your-resource-name}.openai.azure.com
сохранённый идентификатор завершения	path	Yes	string	Идентификатор сохранённого завершения.
api-version	Запрос	Yes	string	Запрошенная версия API.

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

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

Имя.	Обязательный	Тип	Описание
Authorization	True	string	Пример:Authorization: Bearer {Azure_OpenAI_Auth_Token} Для генерации токена аутентификации с помощью Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Тип: oauth2 URL авторизации: https://login.microsoftonline.com/common/oauth2/v2.0/authorize Область применения: https://ai.azure.com/.default
API-ключ	True	string	Предоставьте ключ API Azure OpenAI здесь

Тело запроса

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

Имя.	Тип	Описание	Обязательный	По умолчанию
metadata	object	Произвольные пары ключ-значение для дополнительной информации.	Нет

Ответы

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

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

Тип содержимого	Тип	Description
application/json	Хранимая компиляция

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

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

Тип содержимого	Тип	Description
application/json	ErrorResponse

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

Имя.	In	Обязательный	Тип	Описание
endpoint	path	Yes	string url	Поддерживается Azure конечных точек OpenAI (протокол и имя хоста, например: https://aoairesource.openai.azure.com. Замените «aoairesource» на имя вашего ресурса Azure OpenAI). https://{your-resource-name}.openai.azure.com
сохранённый идентификатор завершения	path	Yes	string	Идентификатор сохранённого завершения.
api-version	Запрос	Yes	string	Запрошенная версия API.

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

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

Имя.	Обязательный	Тип	Описание
Authorization	True	string	Пример:Authorization: Bearer {Azure_OpenAI_Auth_Token} Для генерации токена аутентификации с помощью Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Тип: oauth2 URL авторизации: https://login.microsoftonline.com/common/oauth2/v2.0/authorize Область применения: https://ai.azure.com/.default
API-ключ	True	string	Предоставьте ключ API Azure OpenAI здесь

Ответы

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

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

Тип содержимого	Тип	Description
application/json	StoredCompletionDelete

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

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

Тип содержимого	Тип	Description
application/json	ErrorResponse

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

Имя.	In	Обязательный	Тип	Описание
endpoint	path	Yes	string url	Поддерживается Azure конечных точек OpenAI (протокол и имя хоста, например: https://aoairesource.openai.azure.com. Замените «aoairesource» на имя вашего ресурса Azure OpenAI). https://{your-resource-name}.openai.azure.com
сохранённый идентификатор завершения	path	Yes	string	Идентификатор сохранённого завершения.
После	Запрос	Нет	string	Идентификатор последнего сохранившегося сообщения завершения из предыдущего запроса на страницирование.
limit	Запрос	Нет	целое число	Количество сохранившихся сообщений о завершении, которые нужно получить. По умолчанию 20.
заказ	Запрос	Нет	string	Порядок результатов по индексу сообщений (восходящий или убывающий). По умолчанию используйте ASC.
api-version	Запрос	Yes	string	Запрошенная версия API.

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

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

Имя.	Обязательный	Тип	Описание
Authorization	True	string	Пример:Authorization: Bearer {Azure_OpenAI_Auth_Token} Для генерации токена аутентификации с помощью Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Тип: oauth2 URL авторизации: https://login.microsoftonline.com/common/oauth2/v2.0/authorize Область применения: https://ai.azure.com/.default
API-ключ	True	string	Предоставьте ключ API Azure OpenAI здесь

Ответы

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

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

Тип содержимого	Тип	Description
application/json	СохраненныеСообщенияОбЗавершении

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

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

Тип содержимого	Тип	Description
application/json	ErrorResponse

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

Имя.	In	Обязательный	Тип	Описание
endpoint	path	Yes	string url	Поддерживается Azure конечных точек OpenAI (протокол и имя хоста, например: https://aoairesource.openai.azure.com. Замените «aoairesource» на имя вашего ресурса Azure OpenAI). https://{your-resource-name}.openai.azure.com
После	Запрос	Нет	string	Идентификатор последней оценки из предыдущего запроса на пагинацию.
limit	Запрос	Нет	целое число	Количество оценок, которые нужно получить.
заказ	Запрос	Нет	string Возможные значения: asc, desc	Сортируйте порядок оценок по временной метке. Используйте asc для восходящего порядка или desc для убывания.
сортировать_по	Запрос	Нет	string Возможные значения: created_at, updated_at	Оценки можно упорядочивать по времени создания или последнему обновлению. Используйте created_at для создания или updated_at для последнего обновления.
api-version	Запрос	Yes	string	Запрошенная версия API.

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

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

Имя.	Обязательный	Тип	Описание
Authorization	True	string	Пример:Authorization: Bearer {Azure_OpenAI_Auth_Token} Для генерации токена аутентификации с помощью Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Тип: oauth2 URL авторизации: https://login.microsoftonline.com/common/oauth2/v2.0/authorize Область применения: https://ai.azure.com/.default
API-ключ	True	string	Предоставьте ключ API Azure OpenAI здесь

Ответы

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

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

Тип содержимого	Тип	Description
application/json	EvalList

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

Имя.	In	Обязательный	Тип	Описание
endpoint	path	Yes	string url	Поддерживается Azure конечных точек OpenAI (протокол и имя хоста, например: https://aoairesource.openai.azure.com. Замените «aoairesource» на имя вашего ресурса Azure OpenAI). https://{your-resource-name}.openai.azure.com
api-version	Запрос	Yes	string	Запрошенная версия API.

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

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

Имя.	Обязательный	Тип	Описание
Authorization	True	string	Пример:Authorization: Bearer {Azure_OpenAI_Auth_Token} Для генерации токена аутентификации с помощью Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Тип: oauth2 URL авторизации: https://login.microsoftonline.com/common/oauth2/v2.0/authorize Область применения: https://ai.azure.com/.default
API-ключ	True	string	Предоставьте ключ API Azure OpenAI здесь

Ответы

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

Описание: ОК

Тип содержимого	Тип	Description
application/json	Eval

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

Имя.	In	Обязательный	Тип	Описание
endpoint	path	Yes	string url	Поддерживается Azure конечных точек OpenAI (протокол и имя хоста, например: https://aoairesource.openai.azure.com. Замените «aoairesource» на имя вашего ресурса Azure OpenAI). https://{your-resource-name}.openai.azure.com
eval-id	path	Yes	string	ID оценки нужно удалить.
api-version	Запрос	Yes	string	Запрошенная версия API.

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

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

Имя.	Обязательный	Тип	Описание
Authorization	True	string	Пример:Authorization: Bearer {Azure_OpenAI_Auth_Token} Для генерации токена аутентификации с помощью Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Тип: oauth2 URL авторизации: https://login.microsoftonline.com/common/oauth2/v2.0/authorize Область применения: https://ai.azure.com/.default
API-ключ	True	string	Предоставьте ключ API Azure OpenAI здесь

Ответы

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

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

Тип содержимого	Тип	Description
application/json	object

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

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

Тип содержимого	Тип	Description
application/json	Ошибка

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

Имя.	In	Обязательный	Тип	Описание
endpoint	path	Yes	string url	Поддерживается Azure конечных точек OpenAI (протокол и имя хоста, например: https://aoairesource.openai.azure.com. Замените «aoairesource» на имя вашего ресурса Azure OpenAI). https://{your-resource-name}.openai.azure.com
eval-id	path	Yes	string	ID оценки для извлечения.
api-version	Запрос	Yes	string	Запрошенная версия API.

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

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

Имя.	Обязательный	Тип	Описание
Authorization	True	string	Пример:Authorization: Bearer {Azure_OpenAI_Auth_Token} Для генерации токена аутентификации с помощью Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Тип: oauth2 URL авторизации: https://login.microsoftonline.com/common/oauth2/v2.0/authorize Область применения: https://ai.azure.com/.default
API-ключ	True	string	Предоставьте ключ API Azure OpenAI здесь

Ответы

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

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

Тип содержимого	Тип	Description
application/json	Eval

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

Имя.	In	Обязательный	Тип	Описание
endpoint	path	Yes	string url	Поддерживается Azure конечных точек OpenAI (протокол и имя хоста, например: https://aoairesource.openai.azure.com. Замените «aoairesource» на имя вашего ресурса Azure OpenAI). https://{your-resource-name}.openai.azure.com
eval-id	path	Yes	string	ID оценки для обновления.
api-version	Запрос	Yes	string	Запрошенная версия API.

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

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

Имя.	Обязательный	Тип	Описание
Authorization	True	string	Пример:Authorization: Bearer {Azure_OpenAI_Auth_Token} Для генерации токена аутентификации с помощью Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Тип: oauth2 URL авторизации: https://login.microsoftonline.com/common/oauth2/v2.0/authorize Область применения: https://ai.azure.com/.default
API-ключ	True	string	Предоставьте ключ API Azure OpenAI здесь

Ответы

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

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

Тип содержимого	Тип	Description
application/json	Eval

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

Имя.	In	Обязательный	Тип	Описание
endpoint	path	Yes	string url	Поддерживается Azure конечных точек OpenAI (протокол и имя хоста, например: https://aoairesource.openai.azure.com. Замените «aoairesource» на имя вашего ресурса Azure OpenAI). https://{your-resource-name}.openai.azure.com
eval-id	path	Yes	string	ID оценки для извлечения выполняет данные.
После	Запрос	Нет	string	Идентификатор для последнего запуска из предыдущего запроса на пагинацию.
limit	Запрос	Нет	целое число	Количество забегов для возвращения.
заказ	Запрос	Нет	string Возможные значения: asc, desc	Сортируйте порядок забегов по временной метке. Используйте asc для восходящего порядка или desc для убывания. По умолчанию — .asc
статус	Запрос	Нет	string Возможные значения: queued, in_progress, completed, canceled, failed	Фильтр работает по статусу. Используйте «в очередь», «in_progress», «неудачно», «завершено», «отменено».
api-version	Запрос	Yes	string	Запрошенная версия API.

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

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

Имя.	Обязательный	Тип	Описание
Authorization	True	string	Пример:Authorization: Bearer {Azure_OpenAI_Auth_Token} Для генерации токена аутентификации с помощью Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Тип: oauth2 URL авторизации: https://login.microsoftonline.com/common/oauth2/v2.0/authorize Область применения: https://ai.azure.com/.default
API-ключ	True	string	Предоставьте ключ API Azure OpenAI здесь

Ответы

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

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

Тип содержимого	Тип	Description
application/json	EvalRunList

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

Имя.	In	Обязательный	Тип	Описание
endpoint	path	Yes	string url	Поддерживается Azure конечных точек OpenAI (протокол и имя хоста, например: https://aoairesource.openai.azure.com. Замените «aoairesource» на имя вашего ресурса Azure OpenAI). https://{your-resource-name}.openai.azure.com
eval-id	path	Yes	string	ID оценки для создания забега.
api-version	Запрос	Yes	string	Запрошенная версия API.

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

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

Имя.	Обязательный	Тип	Описание
Authorization	True	string	Пример:Authorization: Bearer {Azure_OpenAI_Auth_Token} Для генерации токена аутентификации с помощью Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Тип: oauth2 URL авторизации: https://login.microsoftonline.com/common/oauth2/v2.0/authorize Область применения: https://ai.azure.com/.default
API-ключ	True	string	Предоставьте ключ API Azure OpenAI здесь

Ответы

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

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

Тип содержимого	Тип	Description
application/json	EvalRun

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

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

Тип содержимого	Тип	Description
application/json	Ошибка

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

Имя.	In	Обязательный	Тип	Описание
endpoint	path	Yes	string url	Поддерживается Azure конечных точек OpenAI (протокол и имя хоста, например: https://aoairesource.openai.azure.com. Замените «aoairesource» на имя вашего ресурса Azure OpenAI). https://{your-resource-name}.openai.azure.com
eval-id	path	Yes	string	ID оценки для удаления забега.
идентификатор run-id	path	Yes	string	ID пробежки для удаления.
api-version	Запрос	Yes	string	Запрошенная версия API.

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

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

Имя.	Обязательный	Тип	Описание
Authorization	True	string	Пример:Authorization: Bearer {Azure_OpenAI_Auth_Token} Для генерации токена аутентификации с помощью Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Тип: oauth2 URL авторизации: https://login.microsoftonline.com/common/oauth2/v2.0/authorize Область применения: https://ai.azure.com/.default
API-ключ	True	string	Предоставьте ключ API Azure OpenAI здесь

Ответы

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

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

Тип содержимого	Тип	Description
application/json	object

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

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

Тип содержимого	Тип	Description
application/json	Ошибка

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

Имя.	In	Обязательный	Тип	Описание
endpoint	path	Yes	string url	Поддерживается Azure конечных точек OpenAI (протокол и имя хоста, например: https://aoairesource.openai.azure.com. Замените «aoairesource» на имя вашего ресурса Azure OpenAI). https://{your-resource-name}.openai.azure.com
eval-id	path	Yes	string	ID оценки для извлечения выполняет данные.
идентификатор run-id	path	Yes	string	ID пробежки для извлечения.
api-version	Запрос	Yes	string	Запрошенная версия API.

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

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

Имя.	Обязательный	Тип	Описание
Authorization	True	string	Пример:Authorization: Bearer {Azure_OpenAI_Auth_Token} Для генерации токена аутентификации с помощью Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Тип: oauth2 URL авторизации: https://login.microsoftonline.com/common/oauth2/v2.0/authorize Область применения: https://ai.azure.com/.default
API-ключ	True	string	Предоставьте ключ API Azure OpenAI здесь

Ответы

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

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

Тип содержимого	Тип	Description
application/json	EvalRun

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

Имя.	In	Обязательный	Тип	Описание
endpoint	path	Yes	string url	Поддерживается Azure конечных точек OpenAI (протокол и имя хоста, например: https://aoairesource.openai.azure.com. Замените «aoairesource» на имя вашего ресурса Azure OpenAI). https://{your-resource-name}.openai.azure.com
eval-id	path	Yes	string	ID оценки, запуск которой вы хотите отменить.
идентификатор run-id	path	Yes	string	ID забега для отмены.
api-version	Запрос	Yes	string	Запрошенная версия API.

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

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

Имя.	Обязательный	Тип	Описание
Authorization	True	string	Пример:Authorization: Bearer {Azure_OpenAI_Auth_Token} Для генерации токена аутентификации с помощью Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Тип: oauth2 URL авторизации: https://login.microsoftonline.com/common/oauth2/v2.0/authorize Область применения: https://ai.azure.com/.default
API-ключ	True	string	Предоставьте ключ API Azure OpenAI здесь

Ответы

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

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

Тип содержимого	Тип	Description
application/json	EvalRun

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

Имя.	In	Обязательный	Тип	Описание
endpoint	path	Yes	string url	Поддерживается Azure конечных точек OpenAI (протокол и имя хоста, например: https://aoairesource.openai.azure.com. Замените «aoairesource» на имя вашего ресурса Azure OpenAI). https://{your-resource-name}.openai.azure.com
eval-id	path	Yes	string	ID оценки для извлечения выполняет данные.
идентификатор run-id	path	Yes	string	ID запуска для получения выходных элементов для.
После	Запрос	Нет	string	Идентификатор последнего вывода из предыдущего запроса на страницирование.
limit	Запрос	Нет	целое число	Количество выходных элементов для извлечения.
статус	Запрос	Нет	string Возможные значения: fail, pass	Фильтруйте выходные элементы по статусу. Используйте failed фильтрацию по неудачным выходным элементам или pass по перенесённым выходным элементам.
заказ	Запрос	Нет	string Возможные значения: asc, desc	Сортируйте порядок выходных элементов по временной метке. Используйте asc для восходящего порядка или desc для убывания. По умолчанию — .asc
api-version	Запрос	Yes	string	Запрошенная версия API.

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

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

Имя.	Обязательный	Тип	Описание
Authorization	True	string	Пример:Authorization: Bearer {Azure_OpenAI_Auth_Token} Для генерации токена аутентификации с помощью Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Тип: oauth2 URL авторизации: https://login.microsoftonline.com/common/oauth2/v2.0/authorize Область применения: https://ai.azure.com/.default
API-ключ	True	string	Предоставьте ключ API Azure OpenAI здесь

Ответы

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

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

Тип содержимого	Тип	Description
application/json	EvalRunOutputItemList

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

Имя.	In	Обязательный	Тип	Описание
endpoint	path	Yes	string url	Поддерживается Azure конечных точек OpenAI (протокол и имя хоста, например: https://aoairesource.openai.azure.com. Замените «aoairesource» на имя вашего ресурса Azure OpenAI). https://{your-resource-name}.openai.azure.com
eval-id	path	Yes	string	ID оценки для извлечения выполняет данные.
идентификатор run-id	path	Yes	string	ID пробежки для извлечения.
идентификатор элемента вывода	path	Yes	string	ID выходного элемента для извлечения.
api-version	Запрос	Yes	string	Запрошенная версия API.

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

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

Имя.	Обязательный	Тип	Описание
Authorization	True	string	Пример:Authorization: Bearer {Azure_OpenAI_Auth_Token} Для генерации токена аутентификации с помощью Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Тип: oauth2 URL авторизации: https://login.microsoftonline.com/common/oauth2/v2.0/authorize Область применения: https://ai.azure.com/.default
API-ключ	True	string	Предоставьте ключ API Azure OpenAI здесь

Ответы

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

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

Тип содержимого	Тип	Description
application/json	EvalRunOutputItem

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

Имя.	In	Обязательный	Тип	Описание
endpoint	path	Yes	string url	Поддерживается Azure конечных точек OpenAI (протокол и имя хоста, например: https://aoairesource.openai.azure.com. Замените «aoairesource» на имя вашего ресурса Azure OpenAI). https://{your-resource-name}.openai.azure.com
purpose	Запрос	Нет	string Возможные значения: , , , fine-tune, fine-tune-resultsassistantsassistants_outputbatchbatch_outputevalsevals_output	Только файлы возврата с определённой целью.
limit	Запрос	Нет	целое число	Ограничение на количество объектов, которые нужно вернуть. Лимит может варьироваться от 1 до 10 000, а по умолчанию — 10 000.
after	Запрос	Нет	string	Курсор для пагинации. after — это идентификатор объекта, который определяет ваше место в списке. Например, если вы сделали запрос в список и получили 100 объектов, заканчивающихся на obj_foo, ваш следующий вызов может включать after=obj_foo для получения следующей страницы списка.
заказ	Запрос	Нет	string	Сортируйте порядок по created_at временной метке объектов. asc для восходящего порядка и desc для убывания.
api-version	Запрос	Yes	string	Запрошенная версия API.

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

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

Имя.	Обязательный	Тип	Описание
Authorization	True	string	Пример:Authorization: Bearer {Azure_OpenAI_Auth_Token} Для генерации токена аутентификации с помощью Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Тип: oauth2 URL авторизации: https://login.microsoftonline.com/common/oauth2/v2.0/authorize Область применения: https://ai.azure.com/.default
API-ключ	True	string	Предоставьте ключ API Azure OpenAI здесь

Ответы

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

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

Тип содержимого	Тип	Description
application/json	FileList

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

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

Тип содержимого	Тип	Description
application/json	ErrorResponse

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

Имя.	In	Обязательный	Тип	Описание
endpoint	path	Yes	string url	Поддерживается Azure конечных точек OpenAI (протокол и имя хоста, например: https://aoairesource.openai.azure.com. Замените «aoairesource» на имя вашего ресурса Azure OpenAI). https://{your-resource-name}.openai.azure.com
api-version	Запрос	Yes	string	Запрошенная версия API.

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

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

Имя.	Обязательный	Тип	Описание
Authorization	True	string	Пример:Authorization: Bearer {Azure_OpenAI_Auth_Token} Для генерации токена аутентификации с помощью Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Тип: oauth2 URL авторизации: https://login.microsoftonline.com/common/oauth2/v2.0/authorize Область применения: https://ai.azure.com/.default
API-ключ	True	string	Предоставьте ключ API Azure OpenAI здесь

Тело запроса

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

Имя.	Тип	Описание	Обязательный	По умолчанию
Якорь	string	Определяет якорь относительно того, с какого времени должен быть сгенерирован абсолютный срок действия.	Нет
Секунд	целое число	Получает относительное время истечения за секунды.
Дальность: [1209600 - 2592000].	Нет
file	string	Получает или устанавливает файл для загрузки в Azure OpenAI.	Yes
purpose	string	Предназначение загруженных документов. Используйте «fine-tune» для тонкой настройки. Это позволяет нам проверить формат загруженного файла.	Yes

Ответы

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

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

Тип содержимого	Тип	Description
application/json	Файл

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

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

Тип содержимого	Тип	Description
application/json	ErrorResponse

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

Имя.	In	Обязательный	Тип	Описание
endpoint	path	Yes	string url	Поддерживается Azure конечных точек OpenAI (протокол и имя хоста, например: https://aoairesource.openai.azure.com. Замените «aoairesource» на имя вашего ресурса Azure OpenAI). https://{your-resource-name}.openai.azure.com
api-version	Запрос	Yes	string	Запрошенная версия API.

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

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

Имя.	Обязательный	Тип	Описание
Authorization	True	string	Пример:Authorization: Bearer {Azure_OpenAI_Auth_Token} Для генерации токена аутентификации с помощью Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Тип: oauth2 URL авторизации: https://login.microsoftonline.com/common/oauth2/v2.0/authorize Область применения: https://ai.azure.com/.default
API-ключ	True	string	Предоставьте ключ API Azure OpenAI здесь

Тело запроса

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

Имя.	Тип	Описание	Обязательный	По умолчанию
content_url	string	URL для скачивания документа (может быть SAS-url blob или любой другой внешний URL, доступный через GET-запрос).	Yes
истекает через	FileExpiresAfter	Определяет срок действия файла.	Нет
filename	string	Название файла JSON Lines, который будет загружен.
Если purpose настройка настроена на «fine-tune», каждая строка — это запись JSON, где поля «prompt» и «completeion» представляют ваши обучающие примеры.	Yes
purpose	Целевые назначения	Предназначение загруженных документов. Используйте «fine-tune» для тонкой настройки. Это позволяет нам проверить формат загруженного файла.	Yes

Ответы

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

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

Тип содержимого	Тип	Description
application/json	Файл

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

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

Тип содержимого	Тип	Description
application/json	ErrorResponse

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

Имя.	In	Обязательный	Тип	Описание
endpoint	path	Yes	string url	Поддерживается Azure конечных точек OpenAI (протокол и имя хоста, например: https://aoairesource.openai.azure.com. Замените «aoairesource» на имя вашего ресурса Azure OpenAI). https://{your-resource-name}.openai.azure.com
идентификатор файла	path	Yes	string	Идентификатор файла.
api-version	Запрос	Yes	string	Запрошенная версия API.

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

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

Имя.	Обязательный	Тип	Описание
Authorization	True	string	Пример:Authorization: Bearer {Azure_OpenAI_Auth_Token} Для генерации токена аутентификации с помощью Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Тип: oauth2 URL авторизации: https://login.microsoftonline.com/common/oauth2/v2.0/authorize Область применения: https://ai.azure.com/.default
API-ключ	True	string	Предоставьте ключ API Azure OpenAI здесь

Ответы

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

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

Тип содержимого	Тип	Description
application/json	Файл

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

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

Тип содержимого	Тип	Description
application/json	ErrorResponse

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

Имя.	In	Обязательный	Тип	Описание
endpoint	path	Yes	string url	Поддерживается Azure конечных точек OpenAI (протокол и имя хоста, например: https://aoairesource.openai.azure.com. Замените «aoairesource» на имя вашего ресурса Azure OpenAI). https://{your-resource-name}.openai.azure.com
идентификатор файла	path	Yes	string	Идентификатор файла.
api-version	Запрос	Yes	string	Запрошенная версия API.

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

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

Имя.	Обязательный	Тип	Описание
Authorization	True	string	Пример:Authorization: Bearer {Azure_OpenAI_Auth_Token} Для генерации токена аутентификации с помощью Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Тип: oauth2 URL авторизации: https://login.microsoftonline.com/common/oauth2/v2.0/authorize Область применения: https://ai.azure.com/.default
API-ключ	True	string	Предоставьте ключ API Azure OpenAI здесь

Ответы

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

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

Тип содержимого	Тип	Description
application/json	FileDelete

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

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

Тип содержимого	Тип	Description
application/json	ErrorResponse

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

Имя.	In	Обязательный	Тип	Описание
endpoint	path	Yes	string url	Поддерживается Azure конечных точек OpenAI (протокол и имя хоста, например: https://aoairesource.openai.azure.com. Замените «aoairesource» на имя вашего ресурса Azure OpenAI). https://{your-resource-name}.openai.azure.com
идентификатор файла	path	Yes	string	Идентификатор файла.
api-version	Запрос	Yes	string	Запрошенная версия API.

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

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

Имя.	Обязательный	Тип	Описание
Authorization	True	string	Пример:Authorization: Bearer {Azure_OpenAI_Auth_Token} Для генерации токена аутентификации с помощью Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Тип: oauth2 URL авторизации: https://login.microsoftonline.com/common/oauth2/v2.0/authorize Область применения: https://ai.azure.com/.default
API-ключ	True	string	Предоставьте ключ API Azure OpenAI здесь

Ответы

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

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

Тип содержимого	Тип	Description
application/octet-stream	string
application/json	string

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

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

Тип содержимого	Тип	Description
application/octet-stream	ErrorResponse
application/json	ErrorResponse

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

Имя.	In	Обязательный	Тип	Описание
endpoint	path	Yes	string url	Поддерживается Azure конечных точек OpenAI (протокол и имя хоста, например: https://aoairesource.openai.azure.com. Замените «aoairesource» на имя вашего ресурса Azure OpenAI). https://{your-resource-name}.openai.azure.com
После	Запрос	Нет	string	Идентификатор последнего события из предыдущего запроса на пагинацию.
limit	Запрос	Нет	целое число	Количество событий, которые нужно восстановить. По умолчанию 20.
api-version	Запрос	Yes	string	Запрошенная версия API.

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

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

Имя.	Обязательный	Тип	Описание
Authorization	True	string	Пример:Authorization: Bearer {Azure_OpenAI_Auth_Token} Для генерации токена аутентификации с помощью Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Тип: oauth2 URL авторизации: https://login.microsoftonline.com/common/oauth2/v2.0/authorize Область применения: https://ai.azure.com/.default
API-ключ	True	string	Предоставьте ключ API Azure OpenAI здесь

Ответы

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

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

Тип содержимого	Тип	Description
application/json	FineTuningJobList

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

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

Тип содержимого	Тип	Description
application/json	ErrorResponse

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

Имя.	In	Обязательный	Тип	Описание
endpoint	path	Yes	string url	Поддерживается Azure конечных точек OpenAI (протокол и имя хоста, например: https://aoairesource.openai.azure.com. Замените «aoairesource» на имя вашего ресурса Azure OpenAI). https://{your-resource-name}.openai.azure.com
api-version	Запрос	Yes	string	Запрошенная версия API.

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

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

Имя.	Обязательный	Тип	Описание
Authorization	True	string	Пример:Authorization: Bearer {Azure_OpenAI_Auth_Token} Для генерации токена аутентификации с помощью Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Тип: oauth2 URL авторизации: https://login.microsoftonline.com/common/oauth2/v2.0/authorize Область применения: https://ai.azure.com/.default
API-ключ	True	string	Предоставьте ключ API Azure OpenAI здесь

Тело запроса

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

Имя.	Тип	Описание	Обязательный	По умолчанию
гиперпараметры	FineTuningHyperParameters	Настройки гиперпараметров, используемые при тонкой настройке.	Нет
Интеграции	массив	Список конфигураций интеграций, поддерживающих задачу тонкой настройки. Планируется множество интеграций, поэтому обязательно проверьте и реагуйте на тип интеграции.	Нет
method	object	Метод, используемый для контролируемой тонкой настройки	Нет
└─ Тип	FineTuningMethodType		Нет
model	string	Идентификатор (model-id) базовой модели, используемый для этой тонкой настройки.	Yes
seed	целое число	Семя, используемое для работы по тонкой настройке. Передача одинаковых параметров seed и заданий должна давать одинаковые результаты, но может отличаться в редких случаях. Если seed не указан, он будет сгенерирован для вас.	Нет
Суффикс	string	Суффикс, используемый для обозначения тонко настроенной модели. Суффикс может содержать до 40 символов (a-z, A-Z, 0-9,- и _), которые будут добавлены к вашему тонко настроенному названию модели.	Нет
файл_обучения	string	Идентификатор файла (file-id), используемый для обучения этой тонко настроенной модели.	Yes
Файл_валидации	string	Идентификатор файла (file-id), который используется для оценки тонкой настройки модели во время обучения.	Нет

Ответы

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

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

Тип содержимого	Тип	Description
application/json	FineTuningJob

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

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

Тип содержимого	Тип	Description
application/json	ErrorResponse

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

Имя.	In	Обязательный	Тип	Описание
endpoint	path	Yes	string url	Поддерживается Azure конечных точек OpenAI (протокол и имя хоста, например: https://aoairesource.openai.azure.com. Замените «aoairesource» на имя вашего ресурса Azure OpenAI). https://{your-resource-name}.openai.azure.com
айди-задачи-тонкой-настройки	path	Yes	string	Идентификатор задачи тонкой настройки.
api-version	Запрос	Yes	string	Запрошенная версия API.

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

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

Имя.	Обязательный	Тип	Описание
Authorization	True	string	Пример:Authorization: Bearer {Azure_OpenAI_Auth_Token} Для генерации токена аутентификации с помощью Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Тип: oauth2 URL авторизации: https://login.microsoftonline.com/common/oauth2/v2.0/authorize Область применения: https://ai.azure.com/.default
API-ключ	True	string	Предоставьте ключ API Azure OpenAI здесь

Ответы

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

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

Тип содержимого	Тип	Description
application/json	FineTuningJob

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

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

Тип содержимого	Тип	Description
application/json	ErrorResponse

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

Имя.	In	Обязательный	Тип	Описание
endpoint	path	Yes	string url	Поддерживается Azure конечных точек OpenAI (протокол и имя хоста, например: https://aoairesource.openai.azure.com. Замените «aoairesource» на имя вашего ресурса Azure OpenAI). https://{your-resource-name}.openai.azure.com
айди-задачи-тонкой-настройки	path	Yes	string	Идентификатор задачи тонкой настройки.
api-version	Запрос	Yes	string	Запрошенная версия API.

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

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

Имя.	Обязательный	Тип	Описание
Authorization	True	string	Пример:Authorization: Bearer {Azure_OpenAI_Auth_Token} Для генерации токена аутентификации с помощью Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Тип: oauth2 URL авторизации: https://login.microsoftonline.com/common/oauth2/v2.0/authorize Область применения: https://ai.azure.com/.default
API-ключ	True	string	Предоставьте ключ API Azure OpenAI здесь

Ответы

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

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

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

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

Тип содержимого	Тип	Description
application/json	ErrorResponse

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

Имя.	In	Обязательный	Тип	Описание
endpoint	path	Yes	string url	Поддерживается Azure конечных точек OpenAI (протокол и имя хоста, например: https://aoairesource.openai.azure.com. Замените «aoairesource» на имя вашего ресурса Azure OpenAI). https://{your-resource-name}.openai.azure.com
айди-задачи-тонкой-настройки	path	Yes	string	Идентификатор задачи тонкой настройки.
api-version	Запрос	Yes	string	Запрошенная версия API.

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

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

Имя.	Обязательный	Тип	Описание
Authorization	True	string	Пример:Authorization: Bearer {Azure_OpenAI_Auth_Token} Для генерации токена аутентификации с помощью Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Тип: oauth2 URL авторизации: https://login.microsoftonline.com/common/oauth2/v2.0/authorize Область применения: https://ai.azure.com/.default
API-ключ	True	string	Предоставьте ключ API Azure OpenAI здесь

Ответы

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

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

Тип содержимого	Тип	Description
application/json	FineTuningJob

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

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

Тип содержимого	Тип	Description
application/json	ErrorResponse

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

Имя.	In	Обязательный	Тип	Описание
endpoint	path	Yes	string url	Поддерживается Azure конечных точек OpenAI (протокол и имя хоста, например: https://aoairesource.openai.azure.com. Замените «aoairesource» на имя вашего ресурса Azure OpenAI). https://{your-resource-name}.openai.azure.com
айди-задачи-тонкой-настройки	path	Yes	string	Идентификатор задачи тонкой настройки.
После	Запрос	Нет	string	Идентификатор последнего идентификатора контрольной точки из предыдущего запроса на страницирование.
limit	Запрос	Нет	целое число	Количество контрольных пунктов для возврата. По умолчанию 10.
api-version	Запрос	Yes	string	Запрошенная версия API.

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

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

Имя.	Обязательный	Тип	Описание
Authorization	True	string	Пример:Authorization: Bearer {Azure_OpenAI_Auth_Token} Для генерации токена аутентификации с помощью Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Тип: oauth2 URL авторизации: https://login.microsoftonline.com/common/oauth2/v2.0/authorize Область применения: https://ai.azure.com/.default
API-ключ	True	string	Предоставьте ключ API Azure OpenAI здесь

Ответы

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

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

Тип содержимого	Тип	Description
application/json	СписокКонтрольныхТочекТонкойНастройкиЗадачи

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

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

Тип содержимого	Тип	Description
application/json	ErrorResponse

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

Имя.	In	Обязательный	Тип	Описание
endpoint	path	Yes	string url	Поддерживается Azure конечных точек OpenAI (протокол и имя хоста, например: https://aoairesource.openai.azure.com. Замените «aoairesource» на имя вашего ресурса Azure OpenAI). https://{your-resource-name}.openai.azure.com
айди-задачи-тонкой-настройки	path	Yes	string	Идентификатор задачи тонкой настройки.
После	Запрос	Нет	string	Идентификатор последнего события из предыдущего запроса на пагинацию.
limit	Запрос	Нет	целое число	Количество событий, которые нужно восстановить. По умолчанию 20.
api-version	Запрос	Yes	string	Запрошенная версия API.

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

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

Имя.	Обязательный	Тип	Описание
Authorization	True	string	Пример:Authorization: Bearer {Azure_OpenAI_Auth_Token} Для генерации токена аутентификации с помощью Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Тип: oauth2 URL авторизации: https://login.microsoftonline.com/common/oauth2/v2.0/authorize Область применения: https://ai.azure.com/.default
API-ключ	True	string	Предоставьте ключ API Azure OpenAI здесь

Ответы

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

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

Тип содержимого	Тип	Description
application/json	FineTuningJobEventList

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

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

Тип содержимого	Тип	Description
application/json	ErrorResponse

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

Имя.	In	Обязательный	Тип	Описание
endpoint	path	Yes	string url	Поддерживается Azure конечных точек OpenAI (протокол и имя хоста, например: https://aoairesource.openai.azure.com. Замените «aoairesource» на имя вашего ресурса Azure OpenAI). https://{your-resource-name}.openai.azure.com
айди-задачи-тонкой-настройки	path	Yes	string	Идентификатор задачи тонкой настройки.
api-version	Запрос	Yes	string	Запрошенная версия API.

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

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

Имя.	Обязательный	Тип	Описание
Authorization	True	string	Пример:Authorization: Bearer {Azure_OpenAI_Auth_Token} Для генерации токена аутентификации с помощью Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Тип: oauth2 URL авторизации: https://login.microsoftonline.com/common/oauth2/v2.0/authorize Область применения: https://ai.azure.com/.default
API-ключ	True	string	Предоставьте ключ API Azure OpenAI здесь

Ответы

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

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

Тип содержимого	Тип	Description
application/json	FineTuningJob

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

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

Тип содержимого	Тип	Description
application/json	ErrorResponse

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

Имя.	In	Обязательный	Тип	Описание
endpoint	path	Yes	string url	Поддерживается Azure конечных точек OpenAI (протокол и имя хоста, например: https://aoairesource.openai.azure.com. Замените «aoairesource» на имя вашего ресурса Azure OpenAI). https://{your-resource-name}.openai.azure.com
айди-задачи-тонкой-настройки	path	Yes	string	Идентификатор задачи тонкой настройки.
api-version	Запрос	Yes	string	Запрошенная версия API.

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

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

Имя.	Обязательный	Тип	Описание
Authorization	True	string	Пример:Authorization: Bearer {Azure_OpenAI_Auth_Token} Для генерации токена аутентификации с помощью Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Тип: oauth2 URL авторизации: https://login.microsoftonline.com/common/oauth2/v2.0/authorize Область применения: https://ai.azure.com/.default
API-ключ	True	string	Предоставьте ключ API Azure OpenAI здесь

Ответы

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

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

Тип содержимого	Тип	Description
application/json	FineTuningJob

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

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

Тип содержимого	Тип	Description
application/json	ErrorResponse

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

Имя.	In	Обязательный	Тип	Описание
endpoint	path	Yes	string url	Поддерживается Azure конечных точек OpenAI (протокол и имя хоста, например: https://aoairesource.openai.azure.com. Замените «aoairesource» на имя вашего ресурса Azure OpenAI). https://{your-resource-name}.openai.azure.com
api-version	Запрос	Yes	string	Запрошенная версия API.
токен пользователей управления	заголовок	Нет	string	Токен, используемый для доступа к рабочему пространству (необходим только для пользовательских вычислительных задач).

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

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

Имя.	Обязательный	Тип	Описание
Authorization	True	string	Пример:Authorization: Bearer {Azure_OpenAI_Auth_Token} Для генерации токена аутентификации с помощью Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Тип: oauth2 URL авторизации: https://login.microsoftonline.com/common/oauth2/v2.0/authorize Область применения: https://ai.azure.com/.default
API-ключ	True	string	Предоставьте ключ API Azure OpenAI здесь

Ответы

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

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

Тип содержимого	Тип	Description
application/json	Прием заданийJobList

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

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

Тип содержимого	Тип	Description
application/json	ErrorResponse

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

Имя.	In	Обязательный	Тип	Описание
endpoint	path	Yes	string url	Поддерживается Azure конечных точек OpenAI (протокол и имя хоста, например: https://aoairesource.openai.azure.com. Замените «aoairesource» на имя вашего ресурса Azure OpenAI). https://{your-resource-name}.openai.azure.com
api-version	Запрос	Yes	string	Запрошенная версия API.
идентификатор задания	path	Yes	string	ID работы, которая будет создана.
токен пользователей управления	заголовок	Нет	string	Токен, используемый для доступа к рабочему пространству (необходим только для пользовательских вычислительных задач).
aml-user-token	заголовок	Нет	string	Токен, используемый для доступа к ресурсам внутри задания в рабочем пространстве (необходим только для пользовательских вычислительных задач).

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

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

Имя.	Обязательный	Тип	Описание
Authorization	True	string	Пример:Authorization: Bearer {Azure_OpenAI_Auth_Token} Для генерации токена аутентификации с помощью Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Тип: oauth2 URL авторизации: https://login.microsoftonline.com/common/oauth2/v2.0/authorize Область применения: https://ai.azure.com/.default
API-ключ	True	string	Предоставьте ключ API Azure OpenAI здесь

Тело запроса

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

Имя.	Тип	Описание	Обязательный	По умолчанию
jobId	string		Нет
добрый	ТипЗадачиПоПриемуДанных	Тип работы.	Yes

Ответы

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

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

Тип содержимого	Тип	Description
application/json	Задача приема данных

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

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

Тип содержимого	Тип	Description
application/json	ErrorResponse

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

Имя.	In	Обязательный	Тип	Описание
endpoint	path	Yes	string url	Поддерживается Azure конечных точек OpenAI (протокол и имя хоста, например: https://aoairesource.openai.azure.com. Замените «aoairesource» на имя вашего ресурса Azure OpenAI). https://{your-resource-name}.openai.azure.com
api-version	Запрос	Yes	string	Запрошенная версия API.
идентификатор задания	path	Yes	string	Идентификация работы.

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

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

Имя.	Обязательный	Тип	Описание
Authorization	True	string	Пример:Authorization: Bearer {Azure_OpenAI_Auth_Token} Для генерации токена аутентификации с помощью Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Тип: oauth2 URL авторизации: https://login.microsoftonline.com/common/oauth2/v2.0/authorize Область применения: https://ai.azure.com/.default
API-ключ	True	string	Предоставьте ключ API Azure OpenAI здесь

Ответы

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

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

Тип содержимого	Тип	Description
application/json	Задача приема данных

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

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

Тип содержимого	Тип	Description
application/json	ErrorResponse

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

Имя.	In	Обязательный	Тип	Описание
endpoint	path	Yes	string url	Поддерживается Azure конечных точек OpenAI (протокол и имя хоста, например: https://aoairesource.openai.azure.com. Замените «aoairesource» на имя вашего ресурса Azure OpenAI). https://{your-resource-name}.openai.azure.com
api-version	Запрос	Yes	string	Запрошенная версия API.
идентификатор задания	path	Yes	string	Идентификация работы.
токен пользователей управления	заголовок	Нет	string	Токен, используемый для доступа к рабочему пространству (необходим только для пользовательских вычислительных задач).

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

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

Имя.	Обязательный	Тип	Описание
Authorization	True	string	Пример:Authorization: Bearer {Azure_OpenAI_Auth_Token} Для генерации токена аутентификации с помощью Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Тип: oauth2 URL авторизации: https://login.microsoftonline.com/common/oauth2/v2.0/authorize Область применения: https://ai.azure.com/.default
API-ключ	True	string	Предоставьте ключ API Azure OpenAI здесь

Ответы

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

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

Тип содержимого	Тип	Description
application/json	Прием заданийJobRunList

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

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

Тип содержимого	Тип	Description
application/json	ErrorResponse

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

Имя.	In	Обязательный	Тип	Описание
endpoint	path	Yes	string url	Поддерживается Azure конечных точек OpenAI (протокол и имя хоста, например: https://aoairesource.openai.azure.com. Замените «aoairesource» на имя вашего ресурса Azure OpenAI). https://{your-resource-name}.openai.azure.com
api-version	Запрос	Yes	string	Запрошенная версия API.
идентификатор задания	path	Yes	string	Идентификация работы.
идентификатор run-id	path	Yes	string	Id самого забега.
токен пользователей управления	заголовок	Нет	string	Токен, используемый для доступа к рабочему пространству (необходим только для пользовательских вычислительных задач).

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

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

Имя.	Обязательный	Тип	Описание
Authorization	True	string	Пример:Authorization: Bearer {Azure_OpenAI_Auth_Token} Для генерации токена аутентификации с помощью Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Тип: oauth2 URL авторизации: https://login.microsoftonline.com/common/oauth2/v2.0/authorize Область применения: https://ai.azure.com/.default
API-ключ	True	string	Предоставьте ключ API Azure OpenAI здесь

Ответы

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

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

Тип содержимого	Тип	Description
application/json	Выполнение задачи по загрузке данных

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

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

Тип содержимого	Тип	Description
application/json	ErrorResponse

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

Имя.	In	Обязательный	Тип	Описание
endpoint	path	Yes	string url	Поддерживается Azure конечных точек OpenAI (протокол и имя хоста, например: https://aoairesource.openai.azure.com. Замените «aoairesource» на имя вашего ресурса Azure OpenAI). https://{your-resource-name}.openai.azure.com
api-version	Запрос	Yes	string	Запрошенная версия API.

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

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

Имя.	Обязательный	Тип	Описание
Authorization	True	string	Пример:Authorization: Bearer {Azure_OpenAI_Auth_Token} Для генерации токена аутентификации с помощью Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Тип: oauth2 URL авторизации: https://login.microsoftonline.com/common/oauth2/v2.0/authorize Область применения: https://ai.azure.com/.default
API-ключ	True	string	Предоставьте ключ API Azure OpenAI здесь

Ответы

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

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

Тип содержимого	Тип	Description
application/json	ModelList

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

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

Тип содержимого	Тип	Description
application/json	ErrorResponse

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

Имя.	In	Обязательный	Тип	Описание
endpoint	path	Yes	string url	Поддерживается Azure конечных точек OpenAI (протокол и имя хоста, например: https://aoairesource.openai.azure.com. Замените «aoairesource» на имя вашего ресурса Azure OpenAI). https://{your-resource-name}.openai.azure.com
идентификатор модели	path	Yes	string	Идентификатор модели.
api-version	Запрос	Yes	string	Запрошенная версия API.

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

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

Имя.	Обязательный	Тип	Описание
Authorization	True	string	Пример:Authorization: Bearer {Azure_OpenAI_Auth_Token} Для генерации токена аутентификации с помощью Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Тип: oauth2 URL авторизации: https://login.microsoftonline.com/common/oauth2/v2.0/authorize Область применения: https://ai.azure.com/.default
API-ключ	True	string	Предоставьте ключ API Azure OpenAI здесь

Ответы

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

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

Тип содержимого	Тип	Description
application/json	Модель

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

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

Тип содержимого	Тип	Description
application/json	ErrorResponse

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

Имя.	In	Обязательный	Тип	Описание
endpoint	path	Yes	string url	Поддерживается Azure конечных точек OpenAI (протокол и имя хоста, например: https://aoairesource.openai.azure.com. Замените «aoairesource» на имя вашего ресурса Azure OpenAI). https://{your-resource-name}.openai.azure.com
api-version	Запрос	Yes	string	Запрошенная версия API.

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

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

Имя.	Обязательный	Тип	Описание
Authorization	True	string	Пример:Authorization: Bearer {Azure_OpenAI_Auth_Token} Для генерации токена аутентификации с помощью Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Тип: oauth2 URL авторизации: https://login.microsoftonline.com/common/oauth2/v2.0/authorize Область применения: https://ai.azure.com/.default
API-ключ	True	string	Предоставьте ключ API Azure OpenAI здесь

Тело запроса

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

Имя.	Тип	Описание	Обязательный	По умолчанию
байт	целое число		Yes
filename	string		Yes
тип MIME	string		Yes
purpose	Целевые назначения	Предназначение загруженных документов. Используйте «fine-tune» для тонкой настройки. Это позволяет нам проверить формат загруженного файла.	Yes

Тело запроса

Content-Type: text/json

Имя.	Тип	Описание	Обязательный	По умолчанию
байт	целое число		Yes
filename	string		Yes
тип MIME	string		Yes
purpose	Целевые назначения	Предназначение загруженных документов. Используйте «fine-tune» для тонкой настройки. Это позволяет нам проверить формат загруженного файла.	Yes

Тело запроса

Content-Type: application/*+json

Имя.	Тип	Описание	Обязательный	По умолчанию
байт	целое число		Yes
filename	string		Yes
тип MIME	string		Yes
purpose	Целевые назначения	Предназначение загруженных документов. Используйте «fine-tune» для тонкой настройки. Это позволяет нам проверить формат загруженного файла.	Yes

Ответы

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

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

Тип содержимого	Тип	Description
application/json	UploadResource

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

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

Тип содержимого	Тип	Description
application/json	ErrorResponse

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

Имя.	In	Обязательный	Тип	Описание
endpoint	path	Yes	string url	Поддерживается Azure конечных точек OpenAI (протокол и имя хоста, например: https://aoairesource.openai.azure.com. Замените «aoairesource» на имя вашего ресурса Azure OpenAI). https://{your-resource-name}.openai.azure.com
идентификатор загрузки	path	Yes	string	Идентификатор загрузки.
api-version	Запрос	Yes	string	Запрошенная версия API.

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

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

Имя.	Обязательный	Тип	Описание
Authorization	True	string	Пример:Authorization: Bearer {Azure_OpenAI_Auth_Token} Для генерации токена аутентификации с помощью Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Тип: oauth2 URL авторизации: https://login.microsoftonline.com/common/oauth2/v2.0/authorize Область применения: https://ai.azure.com/.default
API-ключ	True	string	Предоставьте ключ API Azure OpenAI здесь

Ответы

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

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

Тип содержимого	Тип	Description
application/json	UploadResource

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

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

Тип содержимого	Тип	Description
application/json	ErrorResponse

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

Имя.	In	Обязательный	Тип	Описание
endpoint	path	Yes	string url	Поддерживается Azure конечных точек OpenAI (протокол и имя хоста, например: https://aoairesource.openai.azure.com. Замените «aoairesource» на имя вашего ресурса Azure OpenAI). https://{your-resource-name}.openai.azure.com
идентификатор загрузки	path	Yes	string	Идентификатор загрузки.
api-version	Запрос	Yes	string	Запрошенная версия API.

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

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

Имя.	Обязательный	Тип	Описание
Authorization	True	string	Пример:Authorization: Bearer {Azure_OpenAI_Auth_Token} Для генерации токена аутентификации с помощью Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Тип: oauth2 URL авторизации: https://login.microsoftonline.com/common/oauth2/v2.0/authorize Область применения: https://ai.azure.com/.default
API-ключ	True	string	Предоставьте ключ API Azure OpenAI здесь

Тело запроса

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

Имя.	Тип	Описание	Обязательный	По умолчанию
md5	string		Нет
идентификаторы деталей	массив		Yes

Тело запроса

Content-Type: text/json

Имя.	Тип	Описание	Обязательный	По умолчанию
md5	string		Нет
идентификаторы деталей	массив		Yes

Тело запроса

Content-Type: application/*+json

Имя.	Тип	Описание	Обязательный	По умолчанию
md5	string		Нет
идентификаторы деталей	массив		Yes

Ответы

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

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

Тип содержимого	Тип	Description
application/json	UploadResource

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

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

Тип содержимого	Тип	Description
application/json	ErrorResponse

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

Имя.	In	Обязательный	Тип	Описание
endpoint	path	Yes	string url	Поддерживается Azure конечных точек OpenAI (протокол и имя хоста, например: https://aoairesource.openai.azure.com. Замените «aoairesource» на имя вашего ресурса Azure OpenAI). https://{your-resource-name}.openai.azure.com
идентификатор загрузки	path	Yes	string	Идентификатор загрузки.
api-version	Запрос	Yes	string	Запрошенная версия API.

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

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

Имя.	Обязательный	Тип	Описание
Authorization	True	string	Пример:Authorization: Bearer {Azure_OpenAI_Auth_Token} Для генерации токена аутентификации с помощью Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Тип: oauth2 URL авторизации: https://login.microsoftonline.com/common/oauth2/v2.0/authorize Область применения: https://ai.azure.com/.default
API-ключ	True	string	Предоставьте ключ API Azure OpenAI здесь

Тело запроса

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

Имя.	Тип	Описание	Обязательный	По умолчанию
Данные	string		Yes

Ответы

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

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

Тип содержимого	Тип	Description
application/json	UploadPartResource

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

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

Тип содержимого	Тип	Description
application/json	ErrorResponse

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.

Имя.	Тип	Описание	Обязательный	По умолчанию
connectionId	string	ID соединения, указывающего на Поиск с использованием ИИ Azure Index.	Нет
добрый	ТипЦели	Целевой тип.	Yes

BaseConnection

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

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

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

Значение типа	Схема

Имя.	Тип	Описание	Обязательный	По умолчанию
добрый	Тип подключения	Тип соединения.	Yes

Пакет

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

Имя.	Тип	Описание	Обязательный	По умолчанию
отменено_в	целое число	Временная метка, когда эта партия была отменена (в эпохах Unix).	Нет
cancelling_at	целое число	Временная метка, когда эта партия начала отменять (в эпохах unix).	Нет
завершено_в	целое число	Временная метка завершения этой партии (в эпохах unix).	Нет
окно завершения	string	Сроки, в течение которых должна быть обработана партия.	Нет
создано_в	целое число	Временная метка создания этой партии (в эпохах unix).	Нет
endpoint	string	Конечная точка API, используемая пакетом.	Нет
error_blob	string	Blob url, содержащий выходы запросов с ошибками.	Нет
идентификатор_ошибки_файла	string	ID файла, содержащий выходы запросов с ошибками.	Нет
Ошибки	BatchErrors	Для партий с неудачей это содержит дополнительную информацию о причинах отказов.	Нет
истекло_в	целое число	Временная метка, когда эта партия истекает (в эпохах unix).	Нет
срок_действия_до	целое число	Временная метка срока действия этой партии (в эпохах unix).	Нет
не удалось в	целое число	Временная метка, когда эта партия провалилась (в эпохах unix).	Нет
финализация_в	целое число	Временная метка, когда эта партия начала завершаться (в эпохах unix).	Нет
id	string	Идентичность этого предмета.	Yes
в_процессе_на	целое число	Временная метка, когда эта партия начала развиваться (в эпохах unix).	Нет
input_blob	string	URL blob, содержащий входный файл для партии.	Нет
идентификатор_входного_файла	string	ID входного файла для партии.	Yes
metadata	object	Набор пар ключ-значение, которые можно прикрепить к партии. Это может быть полезно для хранения дополнительной информации о партии в структурированном формате.	Нет
object	TypeDiscriminator	Определяет тип объекта.	Нет
output_blob	string	Blob url, содержащий выходы успешно выполненных запросов.	Нет
идентификатор_выходного_файла	string	ID файла, содержащий выходы успешно выполненных запросов.	Нет
Количество_запросов	BatchRequestCounts	Запрос учитывается для разных статусов внутри партии.	Нет
статус	BatchStatus	Статус партии.	Нет

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

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

Имя.	Тип	Описание	Обязательный	По умолчанию
окно завершения	string	Сроки, в течение которых должна быть обработана партия.	Yes
endpoint	string	Конечная точка API, используемая пакетом.	Yes
input_blob	string	URL blob служба хранилища Azure для использования в качестве входа для batch.	Нет
идентификатор_входного_файла	string	ID входного файла для партии.	Нет
metadata	object	Набор пар ключ-значение, которые можно прикрепить к партии. Это может быть полезно для хранения дополнительной информации о партии в структурированном формате.	Нет
вывод истекает после	FileExpiresAfter	Определяет срок действия файла.	Нет
папка вывода	BatchOutputReference	Папка служба хранилища Azure для хранения выходных данных.	Нет

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

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

Имя.	Тип	Описание	Обязательный	По умолчанию
код	string	Код ошибки, указывающий тип ошибки.	Нет
линия	string	Номер строки входного файла, где произошла ошибка, если применимо (может быть null).	Нет
сообщение	string	Читаемое человеком сообщение с подробностями об ошибке.	Нет
параметр	string	Имя параметра, вызвавшего ошибку, если применимо (может быть null).	Нет

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

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

Имя.	Тип	Описание	Обязательный	По умолчанию
Данные	BatchErrorData	Информация об ошибке при сбое в пакете.	Нет
object	string	Тип объекта ошибок. Это всегда «список».	Нет

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

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

Имя.	Тип	Описание	Обязательный	По умолчанию
завершено	целое число	Количество успешно выполненных запросов в партии.	Нет
ошибка	целое число	Количество неудачных запросов в партии.	Нет
Общая	целое число	Общее количество запросов в партии.	Нет

BatchOutputReference

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

Имя.	Тип	Описание	Обязательный	По умолчанию
разделитель	string	Необязательный параметр. Разделитель, используемый в пути к папке, по умолчанию /.	Нет
url	string	URL папки служба хранилища Azure, где сохраняется пакетный вывод.	Нет

BatchStatus

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

Недвижимость	Ценность
Description	Статус партии.
Тип	string
Значения	validating failed in_progress finalizing completed expired cancelling cancelled

BatchesList

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

Имя.	Тип	Описание	Обязательный	По умолчанию
Данные	массив	Список пунктов.	Нет
первый_идентификатор	string	ID первой партии в списке возвращенных партий.	Нет
есть_еще	boolean	Значение, указывающее, содержит ли список больше элементов, чем возвращённо.	Нет
last_id	string	ID последней партии в списке возвращенных партий.	Нет
object	TypeDiscriminator	Определяет тип объекта.	Нет

Возможности

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

Имя.	Тип	Описание	Обязательный	По умолчанию
завершение чата	boolean	Значение, указывающее, поддерживает ли модель завершение чата.	Yes
completion	boolean	Значение, указывающее, поддерживает ли модель завершение.	Yes
эмбеддинги	boolean	Значение, указывающее, поддерживает ли модель эмбеддинги.	Yes
fine_tune	boolean	Значение, указывающее, можно ли использовать модель для тонкой настройки.	Yes
Вывод	boolean	Значение, указывающее, возможно ли развертывание модели.	Yes

Выбор

Имя.	Тип	Описание	Обязательный	По умолчанию
причина окончания	string	Причина, по которой модель перестала генерировать токены.	Нет
index	целое число	Индекс выбора в списке вариантов.	Нет
logprobs	object	Записывайте вероятностную информацию для выбора.	Нет
сообщение	ChoiceMessage		Нет

ChoiceMessage

Имя.	Тип	Описание	Обязательный	По умолчанию
содержимое	string	Содержание сообщения.	Нет
Роль	string	Роль сущности, которая создаёт сообщение.	Нет
вызовы инструментов	массив	Список соответствующих вызовов инструментов.	Нет

ChunkingSettings

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

Имя.	Тип	Описание	Обязательный	По умолчанию
МаксимальныйРазмерБлокаВТокенах	целое число		Нет

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

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

Недвижимость	Ценность
Description	Действие завершения.
Тип	string
Значения	cleanUpTempAssets keepAllAssets

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

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

Недвижимость	Ценность
Description	Тип вычисления.
Тип	string
Значения	ServerlessCompute CustomCompute

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

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

Имя.	Тип	Описание	Обязательный	По умолчанию
connectionString	string	Строка соединения	Нет
добрый	Тип подключения	Тип соединения.	Yes

ConnectionType

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

Недвижимость	Ценность
Description	Тип соединения.
Тип	string
Значения	EndpointWithKey ConnectionString EndpointWithManagedIdentity WorkspaceConnection RelativeConnection

CosmosDBIndex

Индекс CosmosDB.

Имя.	Тип	Описание	Обязательный	По умолчанию
collectionName	string	Название коллекции Cosmos DB.	Нет
connectionId	string	ID соединения, указывающего на космическую базу данных.	Нет
databaseName	string	Название базы данных Cosmos DB.	Нет
добрый	ТипЦели	Целевой тип.	Yes

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

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

Имя.	Тип	Описание	Обязательный	По умолчанию
МаксимальнаяГлубинаСканирования (maxCrawlDepth)	целое число		Нет
максимальноеВремяСканированияВМинутах	целое число		Нет
максВремяСкачиванияВМинутах	целое число		Нет
максимальный размер файла	целое число		Нет
maxFiles	целое число		Нет
максимальное количество перенаправлений	целое число		Нет

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

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

Имя.	Тип	Описание	Обязательный	По умолчанию
входные_сообщения	object		Нет
└─ ссылка_на_элемент	string	Ссылка на переменную в пространстве имён 'item', например, 'item.name'.	Нет
└─ Шаблон	массив	Список сообщений в чате, формирующих подсказку или контекст. Может содержать переменные ссылки на пространство имён 'item', например, {{item.name}}.	Нет
└─ Тип	перечисление	Тип вводных сообщений. Либо другое template , либо item_reference. Возможные значения: template, item_reference	Нет
model	string	Название модели для генерации завершений (например, 'o3-mini').	Нет
параметры выборки	object		Нет
└─max_completion_tokens	целое число	Максимальное количество токенов в генерируемом выходе.	Нет
Начальное значение └️	целое число	Начальное значение для инициализации случайности во время выборки.	Нет	42
└─ Температура	number	Более высокая температура увеличивает случайность выходов.	Нет	1
└️ top_p	number	Альтернатива температуре для отбора пробы ядра; Версия 1.0 включает все жетоны.	Нет	1
source	object		Yes
└─ Тип	перечисление	Тип источника. Может быть одним из EvalJsonlFileContentSource, EvalJsonlFileIdSourceили EvalStoredCompletionsSource. Возможные значения: EvalJsonlFileContentSource, EvalJsonlFileIdSource, EvalStoredCompletionsSource	Нет
type	перечисление	Тип запущенного источника данных. Всегда completions. Возможные значения: completions	Yes

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

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

Имя.	Тип	Описание	Обязательный	По умолчанию
включить_пример_схемы	boolean	Стоит ли оценивать ожидать, что вы заполните пространство имён выборок (то есть генерируя ответы с вашего источника данных)	Нет	Неправда
схема_элемента	object	Схема json для каждой строки в источнике данных.	Yes
type	перечисление	Тип источника данных. Всегда custom. Возможные значения: custom	Yes

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

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

Имя.	Тип	Описание	Обязательный	По умолчанию
содержимое	['string', 'InputTextContent', 'object']	Текстовые вводы в модель — могут содержать строки шаблона.	Yes
Роль	перечисление	Роль ввода сообщения. Один из user, assistant, system, или developer. Возможные значения: user, assistant, system, developer	Yes
type	перечисление	Тип ввода сообщения. Всегда message. Возможные значения: message	Нет

CreateEvalJsonlRunDataSource

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

Имя.	Тип	Описание	Обязательный	По умолчанию
source	object		Yes
└─ Содержимое	массив	Содержимое файла jsonl.	Нет
Идентификатор └️	string	Идентификатор файла.	Нет
└─ Тип	перечисление	Тип jsonl-источника. Всегда file_id. Возможные значения: file_id	Нет
type	перечисление	Тип источника данных. Всегда jsonl. Возможные значения: jsonl	Yes

CreateEvalLabelModelGrader

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

Имя.	Тип	Описание	Обязательный	По умолчанию
Ввод	массив	Список сообщений в чате, формирующих подсказку или контекст. Может содержать переменные ссылки на пространство имён «item», то есть {{item.name}}.	Yes
labels	массив	Метки для классификации каждого элемента в оценке.	Yes
model	string	Модель, которую использовать для оценки. Должны поддерживать структурированные выходы.	Yes
name	string	Имя оценщика.	Yes
передача_меток	массив	Ярлыки, указывающие на проходящий результат. Должно быть, это подмножество меток.	Yes
type	перечисление	Тип объекта, который всегда label_modelравен . Возможные значения: label_model	Yes

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

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

Имя.	Тип	Описание	Обязательный	По умолчанию
metadata	object	Фильтры метаданных для источника данных журналов.	Нет
type	перечисление	Тип источника данных. Всегда logs. Возможные значения: logs	Yes

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

Имя.	Тип	Описание	Обязательный	По умолчанию
настройка_источника_данных	object	Объект CustomDataSourceConfig, определяющий схему для источника данных, используемого для выполнения оценки. Эта схема используется для определения формы данных, которые будут: - Используются для определения критериев тестирования и - Какие данные требуются при создании запуска	Yes
└include_sample_schema	boolean	Стоит ли оценивать ожидать, что вы заполните пространство имён выборок (то есть генерируя ответы с вашего источника данных)	Нет	Неправда
└item_schema	object	Схема json для каждой строки в источнике данных.	Нет
└─ Метаданные	object	Фильтры метаданных для источника данных журналов.	Нет
└─ Тип	перечисление	Тип источника данных. Всегда logs. Возможные значения: logs	Нет
metadata	Metadata	Набор из 16 пар ключ-значение, которые можно прикрепить к объекту. Это может быть полезно для хранения дополнительной информации об объекте в структурированном формате и для запроса объектов через API или панель управления. Клавиши — это строки с максимальной длиной 64 символа. Значения — это строки с максимальной длиной 512 символов.	Нет
name	string	Название оценки.	Нет
критерии тестирования	массив	Список оценщиков для всех оценочных забегов этой группы.	Yes

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

Имя.	Тип	Описание	Обязательный	По умолчанию
источник данных	object	Объект JsonlRunDataSource с этим задаёт JSONL-файл, совпадающий с eval	Yes
└input_messages	object		Нет
└─ ссылка_на_элемент	string	Ссылка на переменную в пространстве имён 'item', например, 'item.name'.	Нет
└─ Шаблон	массив	Список сообщений в чате, формирующих подсказку или контекст. Может содержать переменные ссылки на пространство имён 'item', например, {{item.name}}.	Нет
└─ Тип	перечисление	Тип вводных сообщений. Либо другое template , либо item_reference. Возможные значения: template, item_reference	Нет
└─ Модель	string	Название модели для генерации завершений (например, 'o3-mini').	Нет
└─sampling_params	object		Нет
└─max_completion_tokens	целое число	Максимальное количество токенов в генерируемом выходе.	Нет
Начальное значение └️	целое число	Начальное значение для инициализации случайности во время выборки.	Нет	42
└─ Температура	number	Более высокая температура увеличивает случайность выходов.	Нет	1
└️ top_p	number	Альтернатива температуре для отбора пробы ядра; Версия 1.0 включает все жетоны.	Нет	1
└─ Источник	object		Нет
└─ Тип	перечисление	Тип источника. Может быть одним из EvalJsonlFileContentSource, EvalJsonlFileIdSourceили EvalStoredCompletionsSource. Возможные значения: EvalJsonlFileContentSource, EvalJsonlFileIdSource, EvalStoredCompletionsSource	Нет
└─ Тип	перечисление	Тип запущенного источника данных. Всегда completions. Возможные значения: completions	Нет
metadata	Metadata	Набор из 16 пар ключ-значение, которые можно прикрепить к объекту. Это может быть полезно для хранения дополнительной информации об объекте в структурированном формате и для запроса объектов через API или панель управления. Клавиши — это строки с максимальной длиной 64 символа. Значения — это строки с максимальной длиной 512 символов.	Нет
name	string	Название забега.	Нет

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

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

Имя.	Тип	Описание	Обязательный	По умолчанию
создано после	целое число	Опциональная Unix-метка времени для фильтрации элементов, созданных после этого времени.	Нет
создано до	целое число	Необязательная временная метка Unix для фильтрации элементов, созданных до этого времени.	Нет
limit	целое число	Опциональное максимальное количество предметов для возврата.	Нет
metadata	Metadata	Набор из 16 пар ключ-значение, которые можно прикрепить к объекту. Это может быть полезно для хранения дополнительной информации об объекте в структурированном формате и для запроса объектов через API или панель управления. Клавиши — это строки с максимальной длиной 64 символа. Значения — это строки с максимальной длиной 512 символов.	Нет
model	string	Необязательная модель для фильтрации (например, 'gpt-4o').	Нет
type	перечисление	Тип источника данных. Всегда stored_completions. Возможные значения: stored_completions	Yes

CustomCompute

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

Имя.	Тип	Описание	Обязательный	По умолчанию
computeId	string	Id пользовательского вычисления	Нет
добрый	ComputeType	Тип вычисления.	Yes

DeploymentConnection

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

Имя.	Тип	Описание	Обязательный	По умолчанию
добрый	Тип подключения	Тип соединения.	Yes

Депрекация

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

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

Имя.	Тип	Описание	Обязательный	По умолчанию
fine_tune	целое число	Дата окончания поддержки тонкой настройки этой модели. Будет null для тонкой настройки моделей.	Нет
Вывод	целое число	Дата окончания вывода для поддержки этой модели.	Yes

DpoHyperparamsRequest

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

Имя.	Тип	Описание	Обязательный	По умолчанию
размер пакета	целое число	Размер пакета, используемый для обучения. Размер пакета — это количество примеров обучения, используемых для обучения одного и обратного прохода. В целом мы обнаружили, что большие пакеты лучше работают для больших наборов данных. Значение по умолчанию и максимальное значение этого свойства специфичны для базовой модели.	Нет
Бета	number	Бета-значение DPO.	Нет
мультипликатор L2	number	Множитель регуляризации L2	Нет
множитель скорости обучения	number	Умножение скорости обучения, используемое для обучения. Скорость тонкой настройки обучения — это исходная скорость обучения, используемая для предварительного обучения, умноженная на это значение. Более крупные показатели обучения, как правило, лучше работают с большими размерами пакетов. Рекомендуем экспериментировать со значениями в диапазоне от 0,02 до 0,2, чтобы увидеть, что даёт наилучшие результаты.	Нет
количество эпох	целое число	Количество эпох для обучения модели. Эпоха относится к одному полному циклу через обучающий набор данных.	Нет

DpoMethod

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

Имя.	Тип	Описание	Обязательный	По умолчанию
dpo	DpoMethodConfigRequest	Конфигурация для dpo метода тонкой настройки. Включает специфические для DPO гиперпараметры	Yes
type	FineTuningMethodType		Yes

DpoMethodConfigRequest

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

Имя.	Тип	Описание	Обязательный	По умолчанию
гиперпараметры	DpoHyperparamsRequest	Гиперпараметры для метода тонкой настройки DPO	Нет

DpoMethodRequest

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

Имя.	Тип	Описание	Обязательный	По умолчанию
dpo	DpoMethodConfigRequest	Конфигурация для dpo метода тонкой настройки. Включает специфические для DPO гиперпараметры	Yes
type	FineTuningMethodType		Yes

EndpointKeyConnection

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

Имя.	Тип	Описание	Обязательный	По умолчанию
endpoint	string	Endpoint	Нет
ключ	string	Ключ	Нет
добрый	Тип подключения	Тип соединения.	Yes

EndpointMIConnection

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

Имя.	Тип	Описание	Обязательный	По умолчанию
endpoint	string	Endpoint	Нет
добрый	Тип подключения	Тип соединения.	Yes
resourceId	string	Идентификатор ресурса	Нет

Error

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

Имя.	Тип	Описание	Обязательный	По умолчанию
код	Код ошибки	Коды ошибок, определённые в руководствах Microsoft REST.	Yes
Детали	массив	Детали об ошибке, если доступны.	Нет
innererror	ВнутренняяОшибка	Внутренняя ошибка, определенная в Microsoft REST-рекомендациях.	Нет
сообщение	string	Послание этой ошибки.	Yes
target	string	Место, где произошла ошибка, если оно доступно.	Нет

Код ошибки

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

Недвижимость	Ценность
Description	Коды ошибок, определённые в руководствах Microsoft REST.
Тип	string
Значения	conflict invalidPayload forbidden notFound unexpectedEntityState itemDoesAlreadyExist serviceUnavailable internalFailure quotaExceeded jsonlValidationFailed fileImportFailed tooManyRequests unauthorized contentFilter

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

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

Имя.	Тип	Описание	Обязательный	По умолчанию
error	Ошибка	Содержимое ошибок, определенное в руководящих принципах Microsoft REST.	Yes

Оценка

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

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

Имя.	Тип	Описание	Обязательный	По умолчанию
создано_в	целое число	Временная метка Unix (в секундах) для момента создания оценки.	Yes
настройка_источника_данных	object	CustomDataSourceConfig, который задаёт схему ваших item и, по sample желанию, пространств имён. Схема ответа определяет форму данных, которые будут следующими: - Используемыми для определения критериев тестирования и - Какие данные требуются при создании запуска	Yes
└─ Метаданные	Metadata	Набор из 16 пар ключ-значение, которые можно прикрепить к объекту. Это может быть полезно для хранения дополнительной информации об объекте в структурированном формате и для запроса объектов через API или панель управления. Клавиши — это строки с максимальной длиной 64 символа. Значения — это строки с максимальной длиной 512 символов.	Нет
└─ Схема	object	Схема json для элементов исходных данных запуска. Узнайте, как строить JSON-схемы здесь.	Нет
└─ Тип	перечисление	Тип источника данных. Всегда stored_completions. Возможные значения: stored_completions	Нет
id	string	Уникальный идентификатор для оценки.	Yes
metadata	Metadata	Набор из 16 пар ключ-значение, которые можно прикрепить к объекту. Это может быть полезно для хранения дополнительной информации об объекте в структурированном формате и для запроса объектов через API или панель управления. Клавиши — это строки с максимальной длиной 64 символа. Значения — это строки с максимальной длиной 512 символов.	Yes
name	string	Название оценки.	Yes
object	перечисление	Тип объекта. Возможные значения: eval	Yes
критерии тестирования	массив	Список критериев тестирования.	Yes

ОшибкаEvalApi

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

Имя.	Тип	Описание	Обязательный	По умолчанию
код	string	Код ошибки.	Yes
сообщение	string	Сообщение об ошибке.	Yes

EvalCustomDataSourceConfig

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

Имя.	Тип	Описание	Обязательный	По умолчанию
schema	object	Схема json для элементов исходных данных запуска. Узнайте, как строить JSON-схемы здесь.	Yes
type	перечисление	Тип источника данных. Всегда custom. Возможные значения: custom	Yes

EvalFileRunDataSource

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

Имя.	Тип	Описание	Обязательный	По умолчанию
идентификатор_файла	string	Идентификатор файла.	Yes
type	перечисление	Тип источника данных. Всегда file. Возможные значения: file	Yes

ЭвалАйтем

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

Имя.	Тип	Описание	Обязательный	По умолчанию
содержимое	object	Текстовый ввод в модель.	Yes
Текст └️	string	Текст, выходящий из модели.	Нет
└─ Тип	перечисление	Тип выходного текста. Всегда output_text. Возможные значения: output_text	Нет
Роль	перечисление	Роль ввода сообщения. Один из user, assistant, system, или developer. Возможные значения: user, assistant, system, developer	Yes
type	перечисление	Тип ввода сообщения. Всегда message. Возможные значения: message	Нет

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

Имя.	Тип	Описание	Обязательный	По умолчанию
содержимое	массив	Содержимое файла jsonl.	Yes
type	перечисление	Тип jsonl-источника. Всегда file_content. Возможные значения: file_content	Yes

EvalJsonlFileIdSource

Имя.	Тип	Описание	Обязательный	По умолчанию
id	string	Идентификатор файла.	Yes
type	перечисление	Тип jsonl-источника. Всегда file_id. Возможные значения: file_id	Yes

EvalLabelModelGrader

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

Имя.	Тип	Описание	Обязательный	По умолчанию
Ввод	массив		Yes
labels	массив	Метки, которые нужно присваивать каждому элементу в оценке.	Yes
model	string	Модель, которую использовать для оценки. Должны поддерживать структурированные выходы.	Yes
name	string	Имя оценщика.	Yes
передача_меток	массив	Ярлыки, указывающие на проходящий результат. Должно быть, это подмножество меток.	Yes
type	перечисление	Тип объекта, который всегда label_modelравен . Возможные значения: label_model	Yes

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

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

Имя.	Тип	Описание	Обязательный	По умолчанию
Данные	массив	Множество объектов для оценки.	Yes
первый_идентификатор	string	Идентификатор первой оценки в массиве данных.	Yes
есть_еще	boolean	Указывает, есть ли ещё оценки.	Yes
last_id	string	Идентификатор последней оценки в массиве данных.	Yes
object	перечисление	Тип этого предмета. Он всегда настроен на «список». Возможные значения: list	Yes

EvalRun

Схема, представляющая запуск оценки.

Имя.	Тип	Описание	Обязательный	По умолчанию
создано_в	целое число	Временная метка Unix (в секундах) при создании запуска оценки.	Yes
источник данных	object	Объект JsonlRunDataSource с этим задаёт JSONL-файл, совпадающий с eval	Yes
└input_messages	object		Нет
└─ ссылка_на_элемент	string	Ссылка на переменную в пространстве имён 'item', например, 'item.name'.	Нет
└─ Шаблон	массив	Список сообщений в чате, формирующих подсказку или контекст. Может содержать переменные ссылки на пространство имён 'item', например, {{item.name}}.	Нет
└─ Тип	перечисление	Тип вводных сообщений. Либо другое template , либо item_reference. Возможные значения: template, item_reference	Нет
└─ Модель	string	Название модели для генерации завершений (например, 'o3-mini').	Нет
└─sampling_params	object		Нет
└─max_completion_tokens	целое число	Максимальное количество токенов в генерируемом выходе.	Нет
Начальное значение └️	целое число	Начальное значение для инициализации случайности во время выборки.	Нет	42
└─ Температура	number	Более высокая температура увеличивает случайность выходов.	Нет	1
└️ top_p	number	Альтернатива температуре для отбора пробы ядра; Версия 1.0 включает все жетоны.	Нет	1
└─ Источник	object		Нет
└─ Тип	перечисление	Тип источника. Может быть одним из EvalJsonlFileContentSource, EvalJsonlFileIdSourceили EvalStoredCompletionsSource. Возможные значения: EvalJsonlFileContentSource, EvalJsonlFileIdSource, EvalStoredCompletionsSource	Нет
└─ Тип	перечисление	Тип запущенного источника данных. Всегда completions. Возможные значения: completions	Нет
error	EvalApiError	Объект, представляющий ответ на ошибку из Eval API.	Yes
eval_id	string	Идентификатор соответствующей оценки.	Yes
id	string	Уникальный идентификатор для оценочного запуска.	Yes
metadata	Metadata	Набор из 16 пар ключ-значение, которые можно прикрепить к объекту. Это может быть полезно для хранения дополнительной информации об объекте в структурированном формате и для запроса объектов через API или панель управления. Клавиши — это строки с максимальной длиной 64 символа. Значения — это строки с максимальной длиной 512 символов.	Yes
model	string	Модель, которая оценивается, если применимо.	Yes
name	string	Название оценочного забега.	Yes
object	перечисление	Тип объекта. Всегда "eval.run". Возможные значения: eval.run	Yes
использование_на_модель	массив	Статистика использования каждой модели во время запуска оценки.	Yes
результаты_по_критериям_тестирования	массив	Результаты соответствуют критериям тестирования, применяемым во время оценки.	Yes
report_url	string	URL отчёта для отрисованной оценки запускается на панели управления интерфейса.	Yes
количество_результатов	object	Счетчики, обобщающие результаты оценки.	Yes
Ошибка	целое число	Количество выходных элементов, приводящих к ошибке.	Нет
└─ Ошибка	целое число	Количество выходных элементов, не прошедших оценку.	Нет
├─ прошло	целое число	Количество выходных элементов, прошедших оценку.	Нет
└─ всего	целое число	Общее количество выполненных выходных элементов.	Нет
статус	string	Статус оценочного запуска.	Yes

EvalRunList

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

Имя.	Тип	Описание	Обязательный	По умолчанию
Данные	массив	Массив объектов, запущенных в оценке.	Yes
первый_идентификатор	string	Идентификатор первого запуска оценки в массиве данных.	Yes
есть_еще	boolean	Указывает, есть ли ещё оценки.	Yes
last_id	string	Идентификатор последней оценки запускается в массиве данных.	Yes
object	перечисление	Тип этого предмета. Он всегда настроен на «список». Возможные значения: list	Yes

EvalRunOutputItem

Схема, представляющая выходной элемент для выполнения оценки.

Имя.	Тип	Описание	Обязательный	По умолчанию
создано_в	целое число	Временная метка Unix (в секундах) при создании запуска оценки.	Yes
элемент источника данных	object	Детали элемента входного источника данных.	Yes
идентификатор_элемента_источника_данных	целое число	Идентификатор элемента источника данных.	Yes
eval_id	string	Идентификатор оценочной группы.	Yes
id	string	Уникальный идентификатор для выходного элемента оценочного запуска.	Yes
object	перечисление	Тип объекта. Всегда "eval.run.output_item". Возможные значения: eval.run.output_item	Yes
results	массив	Список результатов оценочного запуска.	Yes
run_id	string	Идентификатор вычислительного запуска, связанного с этим выходным элементом.	Yes
образец	object	Образец, содержащий входные и выходные данные результата оценки.	Yes
└─ Ошибка	EvalApiError	Объект, представляющий ответ на ошибку из Eval API.	Нет
└️ причина_завершения	string	Причина, по которой генерация выборок была завершена.	Нет
└─ Входные данные	массив	Массив вводных сообщений.	Нет
└─max_completion_tokens	целое число	Максимальное количество жетонов, разрешенных для завершения.	Нет
└─ Модель	string	Модель, используемая для генерации образца.	Нет
вывод └─	массив	Массив выходных сообщений.	Нет
Начальное значение └️	целое число	Семя, используемое для генерации образца.	Нет
└─ Температура	number	Используемая температура пробы.	Нет
└️ top_p	number	Значение top_p, используемое для выборки.	Нет
└─ использование	object	Детали использования токена для примера.	Нет
└ cached_tokens	целое число	Количество токенов, полученных из кэша.	Нет
└─ токены завершения	целое число	Количество генерируемых токенов завершения.	Нет
└─ токены_запроса	целое число	Количество используемых токенов запросов.	Нет
└️ всего_токенов	целое число	Общее количество использованных жетонов.	Нет
статус	string	Статус оценочного запуска.	Yes

Список выходных элементов выполнения оценки

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

Имя.	Тип	Описание	Обязательный	По умолчанию
Данные	массив	Массив объектов вывода элементов eval.	Yes
первый_идентификатор	string	Идентификатор первого выходного элемента eval run в массиве данных.	Yes
есть_еще	boolean	Указывает, есть ли дополнительные выходные элементы для оценки забегов.	Yes
last_id	string	Идентификатор последнего выходного элемента eval run в массиве данных.	Yes
object	перечисление	Тип этого предмета. Он всегда настроен на «список». Возможные значения: list	Yes

EvalScoreModelGrader

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

Имя.	Тип	Описание	Обязательный	По умолчанию
Ввод	массив	Вводный текст. Это может включать строки шаблонов.	Yes
model	string	Модель, которую использовать для оценки.	Yes
name	string	Имя оценщика.	Yes
порог_прохода	number	Порог для получения результата.	Нет
range	массив	Диапазон партитуры. По умолчанию — .[0, 1]	Нет
параметры выборки	object	Параметры выборки для модели.	Нет
type	перечисление	Тип объекта, который всегда score_modelравен . Возможные значения: score_model	Yes

Конфигурация источника данных для хранения завершенных вычислений

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

Имя.	Тип	Описание	Обязательный	По умолчанию
metadata	Metadata	Набор из 16 пар ключ-значение, которые можно прикрепить к объекту. Это может быть полезно для хранения дополнительной информации об объекте в структурированном формате и для запроса объектов через API или панель управления. Клавиши — это строки с максимальной длиной 64 символа. Значения — это строки с максимальной длиной 512 символов.	Нет
schema	object	Схема json для элементов исходных данных запуска. Узнайте, как строить JSON-схемы здесь.	Yes
type	перечисление	Тип источника данных. Всегда stored_completions. Возможные значения: stored_completions	Yes

EvalStoredCompletionsSource

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

Имя.	Тип	Описание	Обязательный	По умолчанию
создано после	целое число	Опциональная Unix-метка времени для фильтрации элементов, созданных после этого времени.	Нет
создано до	целое число	Необязательная временная метка Unix для фильтрации элементов, созданных до этого времени.	Нет
limit	целое число	Опциональное максимальное количество предметов для возврата.	Нет
metadata	Metadata	Набор из 16 пар ключ-значение, которые можно прикрепить к объекту. Это может быть полезно для хранения дополнительной информации об объекте в структурированном формате и для запроса объектов через API или панель управления. Клавиши — это строки с максимальной длиной 64 символа. Значения — это строки с максимальной длиной 512 символов.	Нет
model	string	Необязательная модель для фильтрации (например, 'gpt-4o').	Нет
type	перечисление	Тип источника. Всегда stored_completions. Возможные значения: stored_completions	Yes

ЭвалСтрингЧекГрейдер

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

Имя.	Тип	Описание	Обязательный	По умолчанию
Ввод	string	Вводный текст. Это может включать строки шаблонов.	Yes
name	string	Имя оценщика.	Yes
Операция	перечисление	Операция проверки строк, которую нужно выполнить. Один из eq, ne, like, или ilike. Возможные значения: eq, ne, like, ilike	Yes
ссылка	string	Справочник. Это может включать строки шаблонов.	Yes
type	перечисление	Тип объекта, который всегда string_checkравен . Возможные значения: string_check	Yes

EvalTextSimilarityGrader

Объект TextSimilarityGrader, который оценивает текст на основе метрик сходства.

Имя.	Тип	Описание	Обязательный	По умолчанию
метрика оценки	перечисление	Метрика оценки, которую стоит использовать. Один из fuzzy_match, bleu, gleu, meteorrouge_1, rouge_2rouge_3rouge_4rouge_5или .rouge_l Возможные значения: , , , , , , fuzzy_matchbleugleumeteorrouge_1rouge_2rouge_3rouge_4rouge_5rouge_l	Yes
Ввод	string	Текст оценивается.	Yes
name	string	Имя оценщика.	Нет
порог_прохода	number	Плавающий балл, при котором значение больше или равное указывает на проходную оценку.	Yes
ссылка	string	По тексту, по которому оценивают.	Yes
type	перечисление	Тип оценщика. Возможные значения: text_similarity	Yes

Тип события

Определяет степень серьёзности результата фильтра контента.

Недвижимость	Ценность
Description	Определяет степень серьёзности результата фильтра контента.
Тип	string
Значения	message metrics

Файл

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

Имя.	Тип	Описание	Обязательный	По умолчанию
байт	целое число	Размер этого файла, когда он доступен (может быть нулевым). Размеры файлов больше 2^53-1 не поддерживаются для обеспечения совместимости с целыми числами JavaScript.	Нет
создано_в	целое число	Временная метка, когда это задание или элемент был создан (в эпохах Unix).	Нет
срок_действия_до	целое число	Метка времени Unix (количество секунд, прошедших с 1 января 1970 года) в момент истечения срока действия файла.	Нет
filename	string	Название файла.	Yes
id	string	Идентичность этого предмета.	Нет
object	TypeDiscriminator	Определяет тип объекта.	Нет
purpose	Целевые назначения	Предназначение загруженных документов. Используйте «fine-tune» для тонкой настройки. Это позволяет нам проверить формат загруженного файла.	Yes
статус	FileState	Состояние файла.	Нет
подробности_статуса	string	Сообщение об ошибке с деталями, если обработка этого файла не удалась. Deprecated.	Нет

СозданиеФайла

Определяет документ для импорта из внешнего URL контента, чтобы использовать его с Azure OpenAI.

Имя.	Тип	Описание	Обязательный	По умолчанию
content_url	string	URL для скачивания документа (может быть SAS-url blob или любой другой внешний URL, доступный через GET-запрос).	Yes
purpose	Целевые назначения	Предназначение загруженных документов. Используйте «fine-tune» для тонкой настройки. Это позволяет нам проверить формат загруженного файла.	Yes

УдалениеФайла

Определяет ответ для удаления файла.

Имя.	Тип	Описание	Обязательный	По умолчанию
удалено	boolean	Значение, показывающее, получится, если файл был удалён.	Yes
id	string	Удалённый ID файла.	Yes
object	string	Если файл был удалён.	Yes

Детали файла

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

Имя.	Тип	Описание	Обязательный	По умолчанию
filename	string	Название файла.	Yes
id	string	Идентичность этого предмета.	Нет
path	string	Относительный путь к файлу внутри контейнера.	Нет
purpose	Целевые назначения	Предназначение загруженных документов. Используйте «fine-tune» для тонкой настройки. Это позволяет нам проверить формат загруженного файла.	Yes
uri_аккаунта_хранилища	string	URL аккаунта хранения этого файла.	Нет
имя_контейнера_хранилища	string	Название контейнера хранения этого файлового blob.	Нет

FileExpiresAfter

Определяет срок действия файла.

Имя.	Тип	Описание	Обязательный	По умолчанию
Якорь	FileExpiryAnchor	Определяет якорь относительно того, с какого времени должен быть сгенерирован абсолютный срок действия.	Нет
Секунд	целое число	Относительное время истечения — секунды. Дальность: [1209600 - 2592000].	Нет

FileExpiryAnchor

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

Недвижимость	Ценность
Description	Определяет якорь относительно того, с какого времени должен быть сгенерирован абсолютный срок действия.
Тип	string
Значения	created_at

Импорт файла

Определяет документ для импорта из внешнего URL контента, чтобы использовать его с Azure OpenAI.

Имя.	Тип	Описание	Обязательный	По умолчанию
content_url	string	URL для скачивания документа (может быть SAS-url blob или любой другой внешний URL, доступный через GET-запрос).	Yes
истекает через	FileExpiresAfter	Определяет срок действия файла.	Нет
filename	string	Название файла JSON Lines, который будет загружен. Если purpose настройка настроена на «fine-tune», каждая строка — это запись JSON, где поля «prompt» и «completeion» представляют ваши обучающие примеры.	Yes
purpose	Целевые назначения	Предназначение загруженных документов. Используйте «fine-tune» для тонкой настройки. Это позволяет нам проверить формат загруженного файла.	Yes

СписокФайлов

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

Имя.	Тип	Описание	Обязательный	По умолчанию
Данные	массив	Список пунктов.	Нет
object	TypeDiscriminator	Определяет тип объекта.	Нет

Состояние файла

Состояние файла.

Недвижимость	Ценность
Description	Состояние файла.
Тип	string
Значения	uploaded pending running processed error deleting deleted

FineTuneMethod

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

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

Значение типа	Схема

Имя.	Тип	Описание	Обязательный	По умолчанию
type	FineTuningMethodType		Yes

Запрос метода точной настройки

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

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

Значение типа	Схема

Имя.	Тип	Описание	Обязательный	По умолчанию
type	FineTuningMethodType		Yes

Настройка гиперпараметров

Настройки гиперпараметров, используемые при тонкой настройке.

Имя.	Тип	Описание	Обязательный	По умолчанию
размер пакета	целое число	Размер пакета, используемый для обучения. Размер пакета — это количество примеров обучения, используемых для обучения одного и обратного прохода. В целом мы обнаружили, что большие пакеты лучше работают для больших наборов данных. Значение по умолчанию и максимальное значение этого свойства специфичны для базовой модели.	Нет
множитель скорости обучения	number	Умножение скорости обучения, используемое для обучения. Скорость тонкой настройки обучения — это исходная скорость обучения, используемая для предварительного обучения, умноженная на это значение. Более крупные показатели обучения, как правило, лучше работают с большими размерами пакетов. Рекомендуем экспериментировать со значениями в диапазоне от 0,02 до 0,2, чтобы увидеть, что даёт наилучшие результаты.	Нет
количество эпох	целое число	Количество эпох для обучения модели. Эпоха относится к одному полному циклу через обучающий набор данных.	Нет

FineTuningJob

Определяет значения работы по тонкой настройке.

Имя.	Тип	Описание	Обязательный	По умолчанию
создано_в	целое число	Временная метка, когда это задание или элемент был создан (в эпохах Unix).	Нет
error	FineTuningJobError	Для неудачных заданий будет добавлена дополнительная информация о причине отказа.	Нет
предполагаемое завершение	целое число	Временная метка Unix (в секундах) для того, когда предполагается завершение работы по тонкой настройке. Значение будет нулевым, если задание тонкой настройки не выполняется.	Нет
fine_tuned_model	string	Идентификатор (model-id) полученной тонкой модели. Это свойство заполняется только для успешно завершенных пробегов тонкой настройки. Используйте этот идентификатор для создания развертывания для вывода.	Нет
завершено_в	целое число	Временная метка, когда задание или предмет успешно завершены (в эпохах unix).	Нет
гиперпараметры	FineTuningHyperParameters	Настройки гиперпараметров, используемые при тонкой настройке.	Нет
id	string	Идентичность этого предмета.	Нет
Интеграции	массив	Список конфигураций интеграций, поддерживающих задачу тонкой настройки. Планируется множество интеграций, поэтому обязательно проверьте и реагуйте на тип интеграции.	Нет
method	object	Метод, используемый для контролируемой тонкой настройки	Нет
└─ Тип	FineTuningMethodType		Нет
model	string	Идентификатор (model-id) базовой модели, используемой для тонкой настройки.	Yes
object	TypeDiscriminator	Определяет тип объекта.	Нет
идентификатор_организации	string	Организация этого тонкого ремонта. Не используется на Azure OpenAI; совместимость только с OpenAI.	Нет
файлы_результатов	массив	Идентификаторы файлов результатов (file-id), содержащие метрики обучения и оценки в формате csv. Файл доступен только для успешно завершенных тонкой настройки.	Нет
seed	целое число	Семя, используемое для работы по тонкой настройке.	Нет
статус	FineTuningState	Состояние объекта тонкой настройки или работы по тонкой настройке.	Нет
Суффикс	string	Суффикс, используемый для обозначения тонко настроенной модели. Суффикс может содержать до 40 символов (a-z, A-Z, 0-9,- и _), которые будут добавлены к вашему тонко настроенному названию модели.	Нет
обученные_токены	целое число	Общее количество оплачиваемых токенов, обработанных в ходе этой тонкой настройки.	Нет
файл_обучения	string	Файл, который используется для обучения.	Yes
Файл_валидации	string	Файл, который используется для оценки тонкой настройки модели во время обучения.	Нет

Контрольная точка задания настройки

Имя.	Тип	Описание	Обязательный	По умолчанию
создано_в	целое число	Отметка времени Unix (в секундах) для момента создания контрольной точки.	Yes
контрольная точка тонко настроенной модели	string	Название тонкой настройки модели контрольных точек, которая создаётся.	Yes
идентификатор_задания_тончайшей_настройки	string	Название задачи тонкой настройки, из которой был создан этот контрольный пункт.	Yes
id	string	Идентификация этого контрольно-пропускного пункта.	Нет
metrics	object	Метрики на номере шага во время работы по тонкой настройке.	Yes
object	TypeDiscriminator	Определяет тип объекта.	Нет
номер_шага	целое число	Номер шага, на котором был создан контрольный пункт.	Yes

Список контрольных точек работы по тонкой настройке

Представляет собой список контрольных точек.

Имя.	Тип	Описание	Обязательный	По умолчанию
Данные	массив	Список пунктов.	Нет
есть_еще	boolean	Значение, указывающее, содержит ли список больше элементов, чем возвращённо.	Нет
object	TypeDiscriminator	Определяет тип объекта.	Нет

FineTuningJobCreation

Определяет значения работы по тонкой настройке.

Имя.	Тип	Описание	Обязательный	По умолчанию
гиперпараметры	FineTuningHyperParameters	Настройки гиперпараметров, используемые при тонкой настройке.	Нет
Интеграции	массив	Список конфигураций интеграций, поддерживающих задачу тонкой настройки. Планируется множество интеграций, поэтому обязательно проверьте и реагуйте на тип интеграции.	Нет
method	object	Метод, используемый для контролируемой тонкой настройки	Нет
└─ Тип	FineTuningMethodType		Нет
model	string	Идентификатор (model-id) базовой модели, используемый для этой тонкой настройки.	Yes
seed	целое число	Семя, используемое для работы по тонкой настройке. Передача одинаковых параметров seed и заданий должна давать одинаковые результаты, но может отличаться в редких случаях. Если seed не указан, он будет сгенерирован для вас.	Нет
Суффикс	string	Суффикс, используемый для обозначения тонко настроенной модели. Суффикс может содержать до 40 символов (a-z, A-Z, 0-9,- и _), которые будут добавлены к вашему тонко настроенному названию модели.	Нет
файл_обучения	string	Идентификатор файла (file-id), используемый для обучения этой тонко настроенной модели.	Yes
Файл_валидации	string	Идентификатор файла (file-id), который используется для оценки тонкой настройки модели во время обучения.	Нет

Ошибка задачи точной настройки

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

Имя.	Тип	Описание	Обязательный	По умолчанию
код	string	Машиночитаемый код ошибки.	Нет
сообщение	string	Сообщение об ошибке, читаемом человеком.	Нет
параметр	string	Параметр, который был неверен, обычно training_file или validation_file. Это поле будет нулевым, если сбой не был специфичен для параметра.	Нет

FineTuningJobEvent

Имя.	Тип	Описание	Обязательный	По умолчанию
создано_в	целое число	Временная метка, когда это событие было создано (в эпохах unix).	Yes
Данные		Машиночитаемые данные об этом событии.	Нет
id	string	Идентичность этого события.	Нет
Уровень	Уровень логирования	Уровень многословности события.	Yes
сообщение	string	Сообщение, описывающее событие. Это может быть смена состояния, например, заставка в очередь, запуск, неудача или завершение, либо другие события, например, загруженные результаты.	Yes
object	TypeDiscriminator	Определяет тип объекта.	Нет
type	EventType	Определяет степень серьёзности результата фильтра контента.	Yes

Список событий задания по тонкой настройке

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

Имя.	Тип	Описание	Обязательный	По умолчанию
Данные	массив	Список пунктов.	Нет
есть_еще	boolean	Значение, указывающее, содержит ли список больше элементов, чем возвращённо.	Нет
object	TypeDiscriminator	Определяет тип объекта.	Нет

FineTuningJobList (список задач для тонкой настройки)

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

Имя.	Тип	Описание	Обязательный	По умолчанию
Данные	массив	Список пунктов.	Нет
есть_еще	boolean	Значение, указывающее, содержит ли список больше элементов, чем возвращённо.	Нет
object	TypeDiscriminator	Определяет тип объекта.	Нет

ТипМетодаТочнойНастройки

Недвижимость	Ценность
Тип	string
Значения	dpo supervised

FineTuningState

Состояние объекта тонкой настройки или работы по тонкой настройке.

Недвижимость	Ценность
Description	Состояние объекта тонкой настройки или работы по тонкой настройке.
Тип	string
Значения	created pending running pausing paused resuming succeeded cancelled failed

FunctionCallFunction

Имя.	Тип	Описание	Обязательный	По умолчанию
arguments	string	Аргументы, которые модель ожидает передать функции.	Нет
name	string	Название функции.	Нет

Определение функции

Имя.	Тип	Описание	Обязательный	По умолчанию
описание	string	Описание того, что делает функция, используемое моделью для выбора, когда и как вызывать функцию.	Нет
name	string	Название функции, которую нужно вызвать.	Нет
parameters		Параметры, которые принимают функции, описываются как объект схемы JSON.	Нет

НастройкиОбщегоВстраивания

Настройки встраивания соединения

Имя.	Тип	Описание	Обязательный	По умолчанию
connection	BaseConnection	Связь с ресурсом.	Нет
имя_развертывания	string		Нет
modelName	string		Нет

ОшибкаПриема

Детали ошибки при поглощении

Имя.	Тип	Описание	Обязательный	По умолчанию
innerErrors	массив		Нет
сообщение	string		Нет

Прием заданий

Отражает детали работы.

Дискриминатор по поглощению. Работа

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

Значение типа	Схема

Имя.	Тип	Описание	Обязательный	По умолчанию
jobId	string		Нет
добрый	ТипЗадачиПоПриемуДанных	Тип работы.	Yes

Прием заданийJobList

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

Имя.	Тип	Описание	Обязательный	По умолчанию
nextLink	string	Ссылка на следующую страницу.	Нет
value	массив	Список пунктов.	Нет

Прием заданийJobProgress

Имя.	Тип	Описание	Обязательный	По умолчанию
stageProgres	массив		Yes

Прием заданийJobRun

Детали выполнения работы

Имя.	Тип	Описание	Обязательный	По умолчанию
error	Ошибка поглощения	Детали ошибки при поглощении	Нет
jobId	string		Нет
progress	Прогресс загрузки заданий		Нет
runId	string		Нет
статус	OperationState	Состояние работы или предмета.	Нет
Предупреждения	массив		Нет

Прием заданийJobRunList

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

Имя.	Тип	Описание	Обязательный	По умолчанию
nextLink	string	Ссылка на следующую страницу.	Нет
value	массив	Список пунктов.	Нет

Прием заданийJobStageProgress

Имя.	Тип	Описание	Обязательный	По умолчанию
name	string		Нет
обработанные элементы	целое число		Нет
state	OperationState	Состояние работы или предмета.	Нет
прогресс подпроцесса	массив		Нет
общееКоличествоЭлементов	целое число		Нет

Прием заданийJobSystemCompute

Имя.	Тип	Описание	Обязательный	По умолчанию
завершениеДействие	ЗавершениеAction	Действие завершения.	Нет
интервалОбновленияДанныхВЧасах	целое число		Нет
Datasource	SystemComputeDatasource		Нет
jobId	string		Нет
добрый	ТипЗадачиПоПриемуДанных	Тип работы.	Yes
подключение к поисковому сервису	BaseConnection	Связь с ресурсом.	Нет

ТипЗадачиПогрузки

Тип работы.

Недвижимость	Ценность
Description	Тип работы.
Тип	string
Значения	SystemCompute UserCompute

Прием заданийJobUserCompute

Имя.	Тип	Описание	Обязательный	По умолчанию
compute	JobCompute	Вычислительные настройки работы.	Нет
интервалОбновленияДанныхВЧасах	целое число		Нет
Datasource	UserComputeDatasource		Нет
jobId	string		Нет
добрый	ТипЗадачиПоПриемуДанных	Тип работы.	Yes
target	TargetIndex	Информация о индексе, который будет создан.	Нет
workspaceId	string		Нет

InnerError

Внутренняя ошибка, определенная в Microsoft REST-рекомендациях.

Имя.	Тип	Описание	Обязательный	По умолчанию
код	InnerErrorCode	Внутренние коды ошибок, определённые в Microsoft REST.	Нет
innererror	ВнутренняяОшибка	Внутренняя ошибка, определенная в Microsoft REST-рекомендациях.	Нет

КодВнутреннейОшибки

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

Недвижимость	Ценность
Description	Внутренние коды ошибок, определённые в Microsoft REST.
Тип	string
Значения	invalidPayload

ВходящееСообщение

Имя.	Тип	Описание	Обязательный	По умолчанию
содержимое	string	Содержание сообщения.	Нет
id	string	Идентичность сообщения.	Нет
name	string	Необязательное имя для участника. Предоставляет информацию о модели для различия участников одной и той же роли.	Нет
Роль	string	Роль сущности, которая создаёт сообщение.	Нет

InputTextContent

Текстовый ввод в модель.

Имя.	Тип	Описание	Обязательный	По умолчанию
text	string	Ввод текста в модель.	Yes
type	перечисление	Тип входного элемента. Всегда input_text. Возможные значения: input_text	Yes

Типы интеграции

Список доступных интеграций тонкой настройки.

Недвижимость	Ценность
Description	Список доступных интеграций тонкой настройки.
Тип	string
Значения	wandb

JobCompute

Вычислительные настройки работы.

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

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

Значение типа	Схема

Имя.	Тип	Описание	Обязательный	По умолчанию
добрый	ComputeType	Тип вычисления.	Yes

LifeCycleStatus

Статус жизненного цикла модели.

Примечание: модель может быть продвинута из preview в generally-available, но никогда не из generally-available в preview.

Недвижимость	Ценность
Description	Статус жизненного цикла модели. Примечание: модель может быть продвинута из preview в generally-available, но никогда не из generally-available в preview.
Тип	string
Значения	preview generally-available deprecating deprecated

LogLevel

Уровень многословности события.

Недвижимость	Ценность
Description	Уровень многословности события.
Тип	string
Значения	info warning error

Logprob

Имя.	Тип	Описание	Обязательный	По умолчанию
logprob	number	Логарифмическая вероятность этого токена, если он входит в топ-20 наиболее вероятных токенов. В противном случае значение -9999.0 используется для обозначения того, что токен крайне маловероятен.	Нет
Токен	string	Токен.	Нет

Метаданные

Набор из 16 пар ключ-значение, которые можно прикрепить к объекту. Это может быть полезно для хранения дополнительной информации об объекте в структурированном формате и для запроса объектов через API или панель управления. Клавиши — это строки с максимальной длиной 64 символа. Значения — это строки с максимальной длиной 512 символов.

Для этого компонента не определённых свойств.

Модель

Модель — это либо базовая модель, либо результат успешной доработки.

Имя.	Тип	Описание	Обязательный	По умолчанию
capabilities	возможности	Возможности базовой или тонкой настройки модели.	Yes
создано_в	целое число	Временная метка, когда это задание или элемент был создан (в эпохах Unix).	Нет
Исключения	Устаревание	Определяет даты устаревания для различных сценариев использования модели. Обычно базовые модели поддерживают 1 год тонкой настройки после создания. Вывод обычно поддерживается через 2 года после создания базовых или тонко настроенных моделей. Точные даты указаны в объектах.	Yes
fine_tune	string	Тождественность работы тонкой настройки (fine-tune-id), если это модель тонкой настройки; в противном nullслучае .	Нет
id	string	Идентичность этого предмета.	Нет
статус жизненного цикла	LifeCycleStatus	Статус жизненного цикла модели. Примечание: модель может быть продвинута с «предпросмотра» в generally-available, но никогда не с generally-available «предпросмотра».	Yes
model	string	Идентичность базовой модели (model-id), если это модель тонкой настройки; в противном nullслучае .	Нет
object	TypeDiscriminator	Определяет тип объекта.	Нет
статус	FineTuningState	Состояние объекта тонкой настройки или работы по тонкой настройке.	Нет

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

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

Имя.	Тип	Описание	Обязательный	По умолчанию
Данные	массив	Список пунктов.	Нет
object	TypeDiscriminator	Определяет тип объекта.	Нет

OperationState

Состояние работы или предмета.

Недвижимость	Ценность
Description	Состояние работы или предмета.
Тип	string
Значения	notRunning running succeeded failed

Заказ

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

Недвижимость	Ценность
Description	Определяет назначение файла.
Тип	string
Значения	desc asc

УпорядочитьПоПорядку

Недвижимость	Ценность
Тип	string
Значения	asc desc

PineconeIndex

Индекс Pinecone.

Имя.	Тип	Описание	Обязательный	По умолчанию
connectionId	string	ID соединения, указывающего на шишку.	Нет
добрый	ТипЦели	Целевой тип.	Yes

Purpose

Предназначение загруженных документов. Используйте «fine-tune» для тонкой настройки. Это позволяет нам проверить формат загруженного файла.

Недвижимость	Ценность
Description	Предназначение загруженных документов. Используйте «fine-tune» для тонкой настройки. Это позволяет нам проверить формат загруженного файла.
Тип	string
Значения	fine-tune fine-tune-results assistants assistants_output batch batch_output evals evals_output

Бессерверные вычисления

Бессерверные вычисления.

Имя.	Тип	Описание	Обязательный	По умолчанию
instanceCount	целое число	Количество экземпляров для запуска работы.	Нет
добрый	ComputeType	Тип вычисления.	Yes
sku	string	Уровень SKU	Нет

Хранимая компиляция

Имя.	Тип	Описание	Обязательный	По умолчанию
Выбор	массив	Список вариантов завершения чата. Может быть несколько, если n больше 1.	Нет
создано	целое число	Временная метка Unix (в секундах) момента создания чата.	Нет
частота_штрафа	number	Число от -2,0 до 2,0. Положительные значения наказывают новые токены в зависимости от их существующей частоты в тексте, снижая вероятность повторения одной и той же строки дословно.	Нет
id	string	Идентичность сохранённого завершения.	Нет
ввод_пользователя	string	Вводный пользователь для этого запроса.	Нет
metadata	object	Произвольные пары ключ-значение для дополнительной информации.	Нет
model	string	ID модели для использования.	Нет
штраф_за_присутствие	number	Число от -2,0 до 2,0. Положительные значения наказывают новые токены в зависимости от того, появляются ли они в тексте на данный момент, увеличивая вероятность обсуждения новых тем.	Нет
идентификатор запроса	string	Уникальный идентификатор для запроса API OpenAI. Пожалуйста, укажите этот идентификатор запроса при обращении в службу поддержки.	Нет
seed	целое число	Если указано, наша система приложит максимум усилий для выборки детерминированно, чтобы повторяющиеся запросы с одинаковыми seed параметрами возвращали тот же результат. Детерминизм не гарантирован, и вам следует обратиться к
system_fingerprint Параметр отклика для мониторинга изменений в бэкенде.	Нет
уровень обслуживания	string	Указывает уровень задержки для обработки запроса.	Нет
системный отпечаток	string	Этот отпечаток отпечатка отражает конфигурацию бэкенда, с которой работает модель. Может использоваться вместе с параметром seed запроса для понимания, когда были внесены изменения в бэкенде, которые могут повлиять на детерминизм.	Нет
Температура	number	Какую температуру использовать — от 0 до 2. Более высокие значения, например 0.8, делают выход более случайным, а низкие, например 0.2, делают его более сфокусированным и детерминированным. Обычно мы рекомендуем менять это или top_p не делать и то, и другое.	Нет
выбор инструмента	string	Управляет, который (если вообще есть) называется моделью.	Нет
tools	массив	Список инструментов, которые может вызывать модель. В настоящее время поддерживаются только функции как инструменты. Используйте это, чтобы предоставить список функций, для которых модель может генерировать JSON-входы. Поддерживается максимум 128 функций.	Нет
top_p	number	Альтернатива выборке с температурой, называемая ядреной выборкой, при которой модель учитывает результаты токенов с top_p вероятностной массой. Таким образом, 0.1 означает, что учитываются только токены, составляющие топ-10% массу вероятности. Обычно мы рекомендуем менять это или temperature не делать и то, и другое.	Нет
использование	Usage		Нет

Удаление сохраненного завершения

Имя.	Тип	Описание	Обязательный	По умолчанию
удалено	boolean	Значение, показывающее, получится, если сохраненное завершение было удалено.	Нет
id	string	Сохранённый идентификатор завершения, который был удалён.	Нет
object	string	Если сохраненное завершение было удалено.	Yes

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

Имя.	Тип	Описание	Обязательный	По умолчанию
Данные	массив	Список найденных объектов.	Нет
первый_идентификатор	string	Первый идентификатор в извлеченом list	Нет
есть_еще	boolean	Это has_more свойство используется для пагинации, чтобы обозначить наличие дополнительных результатов.	Нет
last_id	string	Последний идентификатор в полученном list	Нет
object	string	Тип объекта, который всегда равен list	Нет
Общая	целое число	Общее количество товаров.	Нет

Сохранённые сообщения о завершении

Имя.	Тип	Описание	Обязательный	По умолчанию
Данные	массив	Список найденных объектов.	Нет
первый_идентификатор	string	Первый идентификатор в извлеченом list	Нет
есть_еще	boolean	Это has_more свойство используется для пагинации, чтобы обозначить наличие дополнительных результатов.	Нет
last_id	string	Последний идентификатор в полученном list	Нет
object	string	Тип объекта, который всегда равен list	Нет
Общая	целое число	Общее количество товаров.	Нет

ЗаписанныйОтветНаЗавершение

Имя.	Тип	Описание	Обязательный	По умолчанию
Выбор	массив	Список вариантов завершения чата. Может быть несколько, если n больше 1.	Нет
создано	целое число	Временная метка Unix (в секундах) момента создания чата.	Нет
частота_штрафа	number	Число от -2,0 до 2,0. Положительные значения наказывают новые токены в зависимости от их существующей частоты в тексте, снижая вероятность повторения одной и той же строки дословно.	Нет
id	string	Идентичность сохранённого завершения.	Нет
ввод_пользователя	string	Вводный пользователь для этого запроса.	Нет
metadata	object	Произвольные пары ключ-значение для дополнительной информации.	Нет
model	string	ID модели для использования.	Нет
object	string	Тип этого предмета.	Нет
штраф_за_присутствие	number	Число от -2,0 до 2,0. Положительные значения наказывают новые токены в зависимости от того, появляются ли они в тексте на данный момент, увеличивая вероятность обсуждения новых тем.	Нет
идентификатор запроса	string	Уникальный идентификатор для запроса API OpenAI. Пожалуйста, укажите этот идентификатор запроса при обращении в службу поддержки.	Нет
seed	целое число	Если указано, наша система приложит максимум усилий для выборки детерминированно, чтобы повторяющиеся запросы с одинаковыми seedпараметрами возвращали тот же результат. Детерминизм не гарантирован, и вам следует обращаться к system_fingerprint параметру отклика для отслеживания изменений в бэкенде.	Нет
уровень обслуживания	string	Указывает уровень задержки для обработки запроса.	Нет
системный отпечаток	string	Этот отпечаток отпечатка отражает конфигурацию бэкенда, с которой работает модель. Может использоваться вместе с параметром seed запроса для понимания, когда были внесены изменения в бэкенде, которые могут повлиять на детерминизм.	Нет
Температура	number	Какую температуру использовать — от 0 до 2. Более высокие значения, например 0.8, делают выход более случайным, а низкие значения, например 0.2, делают его более сфокусированным и детерминированным. Обычно мы рекомендуем менять это или top_p не делать и то, и другое.	Нет
выбор инструмента	string	Управляет, который (если вообще есть) называется моделью.	Нет
tools	массив	Список инструментов, которые может вызывать модель. В настоящее время поддерживаются только функции как инструменты. Используйте это, чтобы предоставить список функций, для которых модель может генерировать JSON-входы. Поддерживается максимум 128 функций.	Нет
top_p	number	Альтернатива выборке с температурой, называемая ядреной выборкой, при которой модель учитывает результаты токенов с top_p вероятностной массой. Таким образом, 0.1 означает, что учитываются только токены, составляющие топ-10% массу вероятности. Обычно мы рекомендуем менять это или temperature не делать и то, и другое.	Нет
использование	Usage		Нет

КонтролируемыйMethod

Метод, используемый для контролируемой тонкой настройки

Имя.	Тип	Описание	Обязательный	По умолчанию
type	FineTuningMethodType		Yes

ЗащищенныйMethodRequest

Метод, используемый для контролируемой тонкой настройки

Имя.	Тип	Описание	Обязательный	По умолчанию
type	FineTuningMethodType		Yes

SystemComputeDatasource

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

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

Значение типа	Схема

Имя.	Тип	Описание	Обязательный	По умолчанию
добрый	Тип источника данных вычислительной системы	Тип источника данных.	Yes

ТипИсточникДанныхВычислительнойСистемы

Тип источника данных.

Недвижимость	Ценность
Description	Тип источника данных.
Тип	string
Значения	Storage Urls

SystemComputeStorage

учетная запись хранения

Имя.	Тип	Описание	Обязательный	По умолчанию
разбиение на части	Настройки сегментации	Параметры блокирования	Нет
connection	BaseConnection	Связь с ресурсом.	Нет
containerName	string	имя контейнера	Нет
эмбеддинги	массив		Нет
добрый	Тип источника данных вычислительной системы	Тип источника данных.	Yes

SystemComputeUrl

URL-адреса

Имя.	Тип	Описание	Обязательный	По умолчанию
разбиение на части	Настройки сегментации	Параметры блокирования	Нет
connection	BaseConnection	Связь с ресурсом.	Нет
containerName	string	имя контейнера	Нет
ползком	Обход контентаSettings	Параметры обхода контента	Нет
эмбеддинги	массив		Нет
добрый	Тип источника данных вычислительной системы	Тип источника данных.	Yes
Url	массив		Нет

Целевой индекс

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

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

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

Значение типа	Схема

Имя.	Тип	Описание	Обязательный	По умолчанию
добрый	ТипЦели	Целевой тип.	Yes

Тип Цели

Целевой тип.

Недвижимость	Ценность
Description	Целевой тип.
Тип	string
Значения	AzureAISearch CosmosDB Pinecone

инструмент

Имя.	Тип	Описание	Обязательный	По умолчанию
function	FunctionDefinition		Нет
type	string	Тип вызова инструментов. Это всегда будет function для такого рода вызова инструментов.	Нет

ТулКолл

Имя.	Тип	Описание	Обязательный	По умолчанию
function	FunctionCallFunction		Нет
id	string	ID вызова инструмента.	Нет
type	string	Тип вызова инструмента, для которого требуется вывод. Пока что это всегда function.	Нет

Тип_Определитель

Определяет тип объекта.

Недвижимость	Ценность
Description	Определяет тип объекта.
Тип	string
Значения	list fine_tuning.job file fine_tuning.job.event fine_tuning.job.checkpoint model upload upload.part batch wandb

ЗапросОбновленияСохраненногоЗавершения

Имя.	Тип	Описание	Обязательный	По умолчанию
metadata	object	Произвольные пары ключ-значение для дополнительной информации.	Нет

UploadFileCompleteBody

Имя.	Тип	Описание	Обязательный	По умолчанию
md5	string		Нет
идентификаторы деталей	массив		Yes

UploadFileStartBody

Имя.	Тип	Описание	Обязательный	По умолчанию
байт	целое число		Yes
filename	string		Yes
тип MIME	string		Yes
purpose	Целевые назначения	Предназначение загруженных документов. Используйте «fine-tune» для тонкой настройки. Это позволяет нам проверить формат загруженного файла.	Yes

UploadPartResource

Имя.	Тип	Описание	Обязательный	По умолчанию
azure_block_id	string		Нет
создано_в	целое число	Временная метка, когда это задание или элемент был создан (в эпохах Unix).	Нет
id	string	Идентичность этого предмета.	Нет
object	TypeDiscriminator	Определяет тип объекта.	Нет
идентификатор_загрузки	string		Нет

UploadResource

Имя.	Тип	Описание	Обязательный	По умолчанию
байт	целое число		Нет
создано_в	целое число	Временная метка, когда это задание или элемент был создан (в эпохах Unix).	Нет
срок_действия_до	целое число		Нет
file	Файл	Файл — это документ, который можно использовать для обучения и валидации. Это также может быть сервис-сгенерированный документ с деталями результатов.	Нет
filename	string		Нет
id	string	Идентичность этого предмета.	Нет
object	TypeDiscriminator	Определяет тип объекта.	Нет
purpose	Целевые назначения	Предназначение загруженных документов. Используйте «fine-tune» для тонкой настройки. Это позволяет нам проверить формат загруженного файла.	Нет
статус	UploadStatus		Нет

Статус загрузки

Недвижимость	Ценность
Тип	string
Значения	pending expired completed cancelled

Usage

Имя.	Тип	Описание	Обязательный	По умолчанию
токены завершения	целое число	Количество токенов в сгенерированном завершении.	Нет
подсказывающие токены	целое число	Количество токенов в запросе.	Нет
общее количество токенов	целое число	Общее количество токенов, использованных в запросе (запрос + завершение).	Нет

Пользовательский вычислительный набор данных

учетная запись хранения

Имя.	Тип	Описание	Обязательный	По умолчанию
разбиение на части	Настройки сегментации	Параметры блокирования	Нет
ID набора данных	string		Нет
тип набора данных	string		Нет
эмбеддинги	массив		Нет
добрый	Тип источника данных UserCompute	Тип источника данных.	Yes

ИсточникДанныхПользовательскихВычислений

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

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

Значение типа	Схема

Имя.	Тип	Описание	Обязательный	По умолчанию
добрый	Тип источника данных UserCompute	Тип источника данных.	Yes

ТипИсточникДанныхПользователяВычислений

Тип источника данных.

Недвижимость	Ценность
Description	Тип источника данных.
Тип	string
Значения	Dataset Urls

UserComputeUrl

URL-адреса

Имя.	Тип	Описание	Обязательный	По умолчанию
разбиение на части	Настройки сегментации	Параметры блокирования	Нет
ползком	Обход контентаSettings	Параметры обхода контента	Нет
эмбеддинги	массив		Нет
добрый	Тип источника данных UserCompute	Тип источника данных.	Yes
Url	массив		Нет

WandBIntegrationRequest

Имя.	Тип	Описание	Обязательный	По умолчанию
Объект	string		Нет
name	string		Нет
project	string		Yes
tags	массив		Нет

Обёртка запроса интеграции WandB

Имя.	Тип	Описание	Обязательный	По умолчанию
type	IntegrationTypes	Список доступных интеграций тонкой настройки.	Yes
wandb	ЗапросНаИнтеграциюWandB		Yes

WorkspaceConnection

Подключение к AML Workspace.

Имя.	Тип	Описание	Обязательный	По умолчанию
connectionId	string	ConnectionId	Нет
добрый	Тип подключения	Тип соединения.	Yes

Настройки встраивания подключения рабочего пространства

Идентификатор соединения с моделью вложения

Имя.	Тип	Описание	Обязательный	По умолчанию
connectionId	string		Нет
имя_развертывания	string		Нет
modelName	string		Нет

Дальнейшие действия

Узнайте о моделях и тонкой настройке с помощью REST API. Узнайте больше о недоумение моделей, которые Azure OpenAI.