Models - Create

Ссылка

Служба:: Azure AI Services

Версия API:: 2023-04-01-preview

Начните обучение пользовательской модели.

Возвращенные коды состояния:

201: операция успешно завершена.
400: запрос был неправильно сформирован.
409: модель с указанным именем уже существует.

PUT /models/{name}?api-version=2023-04-01-preview

Параметры URI

Имя В Обязательно Тип Описание

Имя	В	Обязательно	Тип	Описание
name	path	True	string	Имя, которое можно использовать для уникальной идентификации модели после ее создания. Шаблон регулярного выражения: `^[a-zA-Z0-9][a-zA-Z0-9._-]*$`
api-version	query	True	string	Запрошенная версия API.

name

path

True

string

Имя, которое можно использовать для уникальной идентификации модели после ее создания.

Шаблон регулярного выражения: ^[a-zA-Z0-9][a-zA-Z0-9._-]*$

api-version

query

True

string

Запрошенная версия API.

Текст запроса

Media Types: "application/json-patch+json"

Имя	Обязательно	Тип	Описание
trainingParameters	True	TrainingParameters	Параметры для указания способа обучения обучения для пользовательской модели.
createdDateTime		string	Только для чтения. Дата и время первого создания обучаемого запуска в формате UTC.
error		ErrorResponseDetails	Сведения об ошибке.
evaluationParameters		ModelEvaluationParameters	Параметры для указания способа оценки модели.
modelPerformance		ModelPerformance	Метрики производительности для пользовательской обученной модели.
name		string	Только для чтения. Имя, которое используется для уникальной идентификации обучающего запуска.
status		ModelState	Только для чтения. Текущее состояние выполнения обучения.
updatedDateTime		string	Только для чтения. Дата и время последнего обновления обучаемого запуска в формате UTC.

Ответы

Имя	Тип	Описание
201 Created	Model	Создание
Other Status Codes	ErrorResponse	Ошибка Заголовки x-ms-error-code: string

Имя

Тип

Описание

201 Created

Model

Создание

Other Status Codes

ErrorResponse

Ошибка

Заголовки

x-ms-error-code: string

Примеры

Models_Create

Образец запроса

HTTP

PUT /models/model_name?api-version=2023-04-01-preview

{
  "trainingParameters": {
    "timeBudgetInHours": 100,
    "trainingDatasetName": "my_dataset_name"
  }
}

Пример ответа

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

{
  "name": "model_name",
  "createdDateTime": "2023-01-13T20:46:21.210Z",
  "updatedDateTime": "2023-01-13T20:46:21.210Z",
  "status": "notStarted",
  "trainingParameters": {
    "timeBudgetInHours": 100,
    "trainingDatasetName": "my_dataset_name"
  }
}

Определения

Имя	Описание
ErrorResponse	Ответ возвращается при возникновении ошибки.
ErrorResponseDetails	Сведения об ошибке.
ErrorResponseInnerError	Подробная ошибка.
Model	Описывает обучающий запуск для обучения пользовательской модели.
ModelEvaluationParameters	Параметры для указания способа оценки модели.
ModelKind	Тип модели.
ModelPerformance	Метрики производительности для пользовательской обученной модели.
ModelState	Только для чтения. Текущее состояние выполнения обучения.
ModelTagPerformance	Метрики производительности для каждого тега, распознаваемого пользовательской обученной моделью.
TrainingParameters	Параметры для указания способа обучения обучения для пользовательской модели.

ErrorResponse

Ответ возвращается при возникновении ошибки.

Имя	Тип	Описание
error	ErrorResponseDetails	Сведения об ошибке.

ErrorResponseDetails

Сведения об ошибке.

Имя	Тип	Описание
code	string	Код ошибки.
details	ErrorResponseDetails[]	Список подробных ошибок.
innererror	ErrorResponseInnerError	Подробная ошибка.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorResponseInnerError

Подробная ошибка.

Имя	Тип	Описание
code	string	Код ошибки.
innererror	ErrorResponseInnerError	Подробная ошибка.
message	string	Сообщение об ошибке.

Model

Описывает обучающий запуск для обучения пользовательской модели.

Имя	Тип	Описание
createdDateTime	string	Только для чтения. Дата и время первого создания обучаемого запуска в формате UTC.
error	ErrorResponseDetails	Сведения об ошибке.
evaluationParameters	ModelEvaluationParameters	Параметры для указания способа оценки модели.
modelPerformance	ModelPerformance	Метрики производительности для пользовательской обученной модели.
name	string	Только для чтения. Имя, которое используется для уникальной идентификации обучающего запуска.
status	ModelState	Только для чтения. Текущее состояние выполнения обучения.
trainingCostInMinutes	integer	Только для чтения. Фактические затраты на обучение в минутах. Отображается, только если обучение выполняется как завершенное.
trainingParameters	TrainingParameters	Параметры для указания способа обучения обучения для пользовательской модели.
updatedDateTime	string	Только для чтения. Дата и время последнего обновления обучаемого запуска в формате UTC.

ModelEvaluationParameters

Параметры для указания способа оценки модели.

Имя	Тип	Описание
testDatasetName	string	Имя набора данных, используемого для тестирования.

ModelKind

Тип модели.

Имя	Тип	Описание
Generic-Classifier	string
Generic-Detector	string
Product-Recognizer	string

ModelPerformance

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

Имя	Тип	Описание
accuracyTop1	number	Только для чтения. Для моделей многоклассовой классификации. Доля тестовых выборок, в которых класс истинности земли соответствует прогнозируемму классу.
accuracyTop5	number	Только для чтения. Для моделей многоклассовой классификации. Доля тестовых выборок, в которых основной класс истина входит в пятерку прогнозируемых классов.
averagePrecision	number	Только для чтения. Мера производительности модели, она суммирует точность и полноту при различных пороговых значениях достоверности.
calibrationECE	number	Только для чтения. Для моделей многоклассовой классификации. Ожидаемая ошибка калибровки.
meanAveragePrecision30	number	Только для чтения. Для моделей обнаружения объектов. Средняя точность при пороговом значении 30 %.
meanAveragePrecision50	number	Только для чтения. Для моделей обнаружения объектов. Средняя средняя точность при пороговом значении 50 %.
meanAveragePrecision75	number	Только для чтения. Для моделей обнаружения объектов. Средняя точность при пороговом значении 75 %.
tagPerformance	<string, ModelTagPerformance>	Только для чтения. Метрики производительности для каждого тега, распознаваемого моделью.

ModelState

Только для чтения. Текущее состояние выполнения обучения.

Имя	Тип	Описание
cancelled	string
cancelling	string
failed	string
notStarted	string
succeeded	string
training	string

ModelTagPerformance

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

Имя	Тип	Описание
accuracy	number	Только для чтения. Для многоклассовых моделей. Точность тегов.
averagePrecision50	number	Только для чтения. Для моделей обнаружения объектов. Средняя точность при пороговом значении 50 %.

TrainingParameters

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

Имя	Тип	Описание
modelKind	ModelKind	Тип модели.
timeBudgetInHours	integer	Бюджет времени для обучения в часах. Минимальное допустимое значение — 1, максимальное допустимое значение — 336 часов для GenericClassifier, 1344 часа для GenericDetector. Это максимальное время вычислений, которое будет потрачено на обучение модели.
trainingDatasetName	string	Имя набора данных, используемого для обучения.

Поделиться через

Models - Create

Параметры URI

Текст запроса

Ответы

Примеры

Models_Create

Образец запроса

Пример ответа

Определения

ErrorResponse

ErrorResponseDetails

ErrorResponseInnerError

Model

ModelEvaluationParameters

ModelKind

ModelPerformance

ModelState

ModelTagPerformance

TrainingParameters

Дополнительные ресурсы