Справочник по разработке REST API для Azure OpenAI в моделях Azure AI Foundry

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

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

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

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

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

Аутентификация

Azure OpenAI предоставляет два метода проверки подлинности. Вы можете использовать ключи API или идентификатор Microsoft Entra.

• Проверка подлинности ключа API. Для этого типа проверки подлинности все запросы API должны содержать Ключ API в заголовке HTTP api-key. В кратком руководстве показано, как выполнять вызовы с помощью этого типа проверки подлинности.

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

Управление версиями REST API

Управление версиями API служб осуществляется с использованием параметра запроса api-version. Все версии имеют структуру даты ГГГГ-ММ-ДД. Рассмотрим пример.

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

Разработка плоскости данных

В остальной части статьи рассматривается последняя предварительная версия спецификации 2025-04-01-previewвывода плоскости данных Azure OpenAI.

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

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

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

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

Параметры URI

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

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

Ответы

Код состояния: 200

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

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

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

Примеры

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

Ответы: код состояния: 200

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

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

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

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

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

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

Параметры URI

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

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

Тело запроса

Content-Type: application/json

Ответы

Код состояния: 201

Описание. Пакет успешно создан.

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

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

Примеры

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

Ответы: Код состояния: 201

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

Пакет — получить

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

Возвращает сведения для одного пакета, указанного заданным идентификатором пакета.

Параметры URI

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

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

Ответы

Код состояния: 200

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

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

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

Примеры

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

Ответы: код состояния: 200

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

Пакет — отмена

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

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

Параметры URI

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

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

Ответы

Код состояния: 200

Описание. Пакет успешно отменен.

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

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

Примеры

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

Ответы: код состояния: 200

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

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

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

Возвращает список сохраненных завершений.

Параметры URI

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

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

Ответы

Код состояния: 200

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

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

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

Примеры

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

Ответы: код состояния: 200

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

Хранящееся завершение — получение

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

Возвращает хранящееся завершение заданным хранимым идентификатором завершения.

Параметры URI

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

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

Ответы

Код состояния: 200

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

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

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

Примеры

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

Ответы: код состояния: 200

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

Обновление хранимого завершения

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

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

Параметры URI

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

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

Тело запроса

Content-Type: application/json

Ответы

Код состояния: 200

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

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

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

Примеры

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

Ответы: код состояния: 200

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

Хранящееся завершение — удаление

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

Удалите хранящееся завершение заданным хранимым идентификатором завершения.

Параметры URI

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

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

Ответы

Код состояния: 200

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

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

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

Примеры

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

Ответы: код состояния: 200

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

Хранение завершаемых задач — Getmessages

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

Возвращает сохраненные сообщения о завершении по указанному хранящейся идентификатору завершения.

Параметры URI

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

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

Ответы

Код состояния: 200

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

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

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

Примеры

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

Ответы: код состояния: 200

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

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

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

Создайте список оценок для проекта.

Параметры URI

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

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

Ответы

Код состояния: 200

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

Примеры

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

Ответы: код состояния: 200

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

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

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

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

Параметры URI

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

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

Ответы

Код состояния: 201

Описание: ОК

Примеры

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

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

Ответы: Код состояния: 201

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

Оценивание - Удалить

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

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

Параметры URI

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

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

Ответы

Код состояния: 200

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

Код состояния: 404

Описание: оценка не найдена.

Примеры

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

Ответы: код состояния: 200

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

Код состояния: 404

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

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

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

Получите оценку по идентификатору.

Параметры URI

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

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

Ответы

Код состояния: 200

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

Примеры

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

Ответы: код состояния: 200

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

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

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

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

Параметры URI

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

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

Ответы

Код состояния: 200

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

Примеры

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

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

Ответы: код состояния: 200

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

Оценка — Getrunlist

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

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

Параметры URI

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

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

Ответы

Код состояния: 200

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

Примеры

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

Ответы: код состояния: 200

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

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

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

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

Параметры URI

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

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

Ответы

Код состояния: 201

Описание: успешно создан запуск для оценки

Код состояния: 400

Описание: недопустимый запрос (например, отсутствующий объект eval)

Примеры

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

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

Ответы: Код состояния: 201

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

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

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

Удаление запуска процесса оценки.

Параметры URI

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

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

Ответы

Код состояния: 200

Описание: Успешно удален тестовый запуск

Код состояния: 404

Описание: запуск не найден

Примеры

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

Ответы: код состояния: 200

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

Код состояния: 404

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

Оценка — запуск выполнения

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

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

Параметры URI

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

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

Ответы

Код состояния: 200

Описание: выполнение оценки

Примеры

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

Ответы: код состояния: 200

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

Оценка — отмена запуска

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

Отмена текущего выполнения оценки.

Параметры URI

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

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

Ответы

Код состояния: 200

Описание: отмененный объект выполнения Eval

Примеры

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

Ответы: код состояния: 200

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

Оценка — Getrunoutputitems

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

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

Параметры URI

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

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

Ответы

Код состояния: 200

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

Примеры

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

Ответы: код состояния: 200

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

Оценка — Getrunoutputitem

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

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

Параметры URI

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

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

Ответы

Код состояния: 200

Описание: выходной элемент выполнения оценки

Примеры

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

Ответы: код состояния: 200

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

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

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

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

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

Параметры URI

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

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

Ответы

Код состояния: 200

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

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

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

Примеры

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

Ответы: код состояния: 200

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

Файлы — отправка

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

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

Параметры URI

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

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

Тело запроса

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

Ответы

Код состояния: 201

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

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

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

Примеры

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

Ответы: Код состояния: 201

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

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

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

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

Параметры URI

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

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

Тело запроса

Content-Type: application/json

Ответы

Код состояния: 201

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

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

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

Примеры

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

Ответы: Код состояния: 201

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

Файлы — получить

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

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

Параметры URI

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

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

Ответы

Код состояния: 200

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

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

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

Примеры

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

Ответы: код состояния: 200

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

Файлы — удаление

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

Удаляет файл с заданным идентификатором файла.

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

Параметры URI

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

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

Ответы

Код состояния: 200

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

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

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

Примеры

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

Ответы: код состояния: 200

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

Файлы — Получить содержимое

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

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

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

Параметры URI

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

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

Ответы

Код состояния: 200

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

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

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

Примеры

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

Ответы: код состояния: 200

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

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

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

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

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

Параметры URI

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

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

Ответы

Код состояния: 200

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

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

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

Примеры

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

Ответы: код состояния: 200

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

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

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

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

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

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

Параметры URI

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

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

Тело запроса

Content-Type: application/json

Ответы

Код состояния: 201

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

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

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

Примеры

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

Ответы: Код состояния: 201

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

Тонкая настройка — Получить

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

Возвращает сведения об одном задании точной настройки, заданном заданным идентификатором точной настройки.

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

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

Параметры URI

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

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

Ответы

Код состояния: 200

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

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

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

Примеры

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

Ответы: код состояния: 200

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

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

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

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

Параметры URI

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

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

Ответы

Код состояния: 204

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

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

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

Примеры

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

Ответы: Код состояния: 204

{
  "headers": {}
}

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

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

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

Параметры URI

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

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

Ответы

Код состояния: 200

Описание: Настройка успешно отменена

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

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

Примеры

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

Ответы: код состояния: 200

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

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

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

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

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

Параметры URI

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

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

Ответы

Код состояния: 200

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

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

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

Примеры

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

Ответы: код состояния: 200

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

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

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

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

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

Параметры URI

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

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

Ответы

Код состояния: 200

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

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

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

Примеры

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

Ответы: код состояния: 200

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

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

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

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

Параметры URI

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

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

Ответы

Код состояния: 200

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

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

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

Примеры

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

Ответы: код состояния: 200

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

Тонкое настройка — возобновление работы

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

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

Параметры URI

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

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

Ответы

Код состояния: 200

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

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

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

Примеры

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

Ответы: код состояния: 200

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

Задания приема — список

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

Выводит список заданий приема.

Параметры URI

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

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

Ответы

Код состояния: 200

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

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

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

Примеры

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

Ответы: код состояния: 200

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

Задания приема — создание

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

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

Параметры URI

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

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

Тело запроса

Content-Type: application/json

Ответы

Код состояния: 200

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

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

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

Примеры

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

Ответы: код состояния: 200

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

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

Ответы: код состояния: 200

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

Задания приема — Получение

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

Возвращает сведения о указанном идентификаторе задания.

Параметры URI

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

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

Ответы

Код состояния: 200

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

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

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

Примеры

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

Ответы: код состояния: 200

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

Список ingestionjobruns

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

Выводит список запусков указанного идентификатора задания.

Параметры URI

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

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

Ответы

Код состояния: 200

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

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

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

Примеры

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

Ответы: код состояния: 200

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

Ingestionjobruns - Получить

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

Возвращает сведения о указанном идентификаторе выполнения в рамках указанного идентификатора задания.

Параметры URI

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

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

Ответы

Код состояния: 200

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

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

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

Примеры

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

Ответы: код состояния: 200

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

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

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

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

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

Параметры URI

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

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

Ответы

Код состояния: 200

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

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

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

Примеры

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

Ответы: код состояния: 200

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

Модели — получить

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

Возвращает сведения о модели, указанной заданным идентификатором modelId.

Параметры URI

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

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

Ответы

Код состояния: 200

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

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

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

Примеры

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

Ответы: код состояния: 200

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

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

Ответы: код состояния: 200

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

Отправка файла — запуск

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

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

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

Параметры URI

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

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

Тело запроса

Content-Type: application/json

Тело запроса

Content-Type: text/json

Тело запроса

Content-Type: application/*+json

Ответы

Код состояния: 200

Описание. Отправка успешно создана.

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

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

Примеры

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

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

Ответы: код состояния: 200

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

Отправка файла — отмена

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

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

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

Параметры URI

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

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

Ответы

Код состояния: 200

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

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

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

Примеры

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

Ответы: код состояния: 200

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

Отправка файла — завершено

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

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

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

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

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

Параметры URI

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

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

Тело запроса

Content-Type: application/json

Тело запроса

Content-Type: text/json

Тело запроса

Content-Type: application/*+json

Ответы

Код состояния: 200

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

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

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

Примеры

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

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

Ответы: код состояния: 200

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

Отправка файла — часть

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

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

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

Параметры URI

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

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

Тело запроса

Content-Type: multipart/form-data

Ответы

Код состояния: 200

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

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

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

Примеры

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

Ответы: код состояния: 200

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

Компоненты

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

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

BaseConnection

Подключение к ресурсу.

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

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

Партия

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

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

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

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

Сведения об ошибке для сбоя в пакете.

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

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

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

Количество запросов для различных состояний в пакете.

BatchOutputReference

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

BatchStatus

Состояние пакета.

BatchesList

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

Возможности

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

Выбор

ChoiceMessage

ChunkingSettings

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

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

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

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

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

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

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

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

Тип подключения.

CosmosDBIndex

Индекс CosmosDB.

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

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

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

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

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

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

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

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

CreateEvalJsonlRunDataSource

Объект JsonlRunDataSource, указывающий JSONL-файл, соответствующий оценке.

CreateEvalLabelModelGrader

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

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

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

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

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

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

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

CustomCompute

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

DeploymentConnection

Относительное подключение к развертыванию.

Исключения

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

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

DpoHyperparamsRequest

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

DpoMethod

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

DpoMethodConfigRequest

Настройка метода dpo тонкой настройки. Включает определенные гиперпараметры DPO

DpoMethodRequest

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

EndpointKeyConnection

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

EndpointMIConnection

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

Ошибка

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

Код ошибки

Коды ошибок, определенные в рекомендациях Microsoft REST.

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

Ответ на ошибки, определенный в рекомендациях Microsoft REST.

Оценка

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

• Улучшение качества чат-бота
• Узнайте, как хорошо мой чат-бот обрабатывает поддержку клиентов
• Проверьте, лучше ли o3-mini в моем варианте использования, чем gpt-4o

ОшибкаEvalApi

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

EvalCustomDataSourceConfig

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

EvalFileRunDataSource

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

ЭвалАйтем

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

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

EvalJsonlFileIdSource

EvalLabelModelGrader

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