Models - Create

Serviço:

Azure AI Services

Versão da API:

2023-04-01-preview

Comece a preparar um modelo personalizado.

Códigos de estado devolvidos:

• 201: Operação concluída com êxito.
• 400: O pedido foi mal formado.
• 409: já existe um modelo com o nome especificado.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
name	path	True	string	Um nome que pode ser utilizado para identificar exclusivamente o modelo depois de ter sido criado. Padrão Regex: ^[a-zA-Z0-9][a-zA-Z0-9._-]*$
api-version	query	True	string	Versão da API pedida.

Corpo do Pedido

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

Name	Necessário	Tipo	Description
trainingParameters	True	TrainingParameters	Parâmetros para especificar como uma execução de preparação prepara um modelo personalizado.
createdDateTime		string	Só de leitura. A data e hora em que a execução de preparação foi criada pela primeira vez, em UTC.
error		ErrorResponseDetails	Informações de erro.
evaluationParameters		ModelEvaluationParameters	Parâmetros para especificar a forma como um modelo é avaliado.
modelPerformance		ModelPerformance	Métricas de desempenho para um modelo preparado personalizado.
name		string	Só de leitura. O nome utilizado para identificar exclusivamente a execução de preparação.
status		ModelState	Só de leitura. O estado atual da execução da preparação.
updatedDateTime		string	Só de leitura. A data e hora em que a execução de preparação foi atualizada pela última vez, em UTC.

Respostas

Name	Tipo	Description
201 Created	Model	Criado
Other Status Codes	ErrorResponse	Erro Cabeçalhos x-ms-error-code: string

Exemplos

Models_Create

Pedido de amostra

HTTP

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

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

Resposta da amostra

Código de estado:

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"
  }
}

Definições

Name	Description
ErrorResponse	Resposta devolvida quando ocorre um erro.
ErrorResponseDetails	Informações de erro.
ErrorResponseInnerError	Erro detalhado.
Model	Descreve uma execução de preparação para preparar um modelo personalizado.
ModelEvaluationParameters	Parâmetros para especificar a forma como um modelo é avaliado.
ModelKind	Tipo de modelo.
ModelPerformance	Métricas de desempenho para um modelo preparado personalizado.
ModelState	Só de leitura. O estado atual da execução da preparação.
ModelTagPerformance	Métricas de desempenho para cada etiqueta reconhecida por um modelo preparado personalizado.
TrainingParameters	Parâmetros para especificar como uma execução de preparação prepara um modelo personalizado.

ErrorResponse

Resposta devolvida quando ocorre um erro.

Name	Tipo	Description
error	ErrorResponseDetails	Informações de erro.

ErrorResponseDetails

Informações de erro.

Name	Tipo	Description
code	string	Código de erro.
details	ErrorResponseDetails[]	Lista de erros detalhados.
innererror	ErrorResponseInnerError	Erro detalhado.
message	string	Mensagem de erro.
target	string	Destino do erro.

ErrorResponseInnerError

Erro detalhado.

Name	Tipo	Description
code	string	Código de erro.
innererror	ErrorResponseInnerError	Erro detalhado.
message	string	Mensagem de erro.

Model

Descreve uma execução de preparação para preparar um modelo personalizado.

Name	Tipo	Description
createdDateTime	string	Só de leitura. A data e hora em que a execução de preparação foi criada pela primeira vez, em UTC.
error	ErrorResponseDetails	Informações de erro.
evaluationParameters	ModelEvaluationParameters	Parâmetros para especificar a forma como um modelo é avaliado.
modelPerformance	ModelPerformance	Métricas de desempenho para um modelo preparado personalizado.
name	string	Só de leitura. O nome utilizado para identificar exclusivamente a execução de preparação.
status	ModelState	Só de leitura. O estado atual da execução da preparação.
trainingCostInMinutes	integer	Só de leitura. Custo real da preparação consumido, em minutos. Apresentar apenas se a preparação for executada como concluída.
trainingParameters	TrainingParameters	Parâmetros para especificar como uma execução de preparação prepara um modelo personalizado.
updatedDateTime	string	Só de leitura. A data e hora em que a execução de preparação foi atualizada pela última vez, em UTC.

ModelEvaluationParameters

Parâmetros para especificar a forma como um modelo é avaliado.

Name	Tipo	Description
testDatasetName	string	O nome do conjunto de dados utilizado para testes.

ModelKind

Tipo de modelo.

Name	Tipo	Description
Generic-Classifier	string
Generic-Detector	string
Product-Recognizer	string

ModelPerformance

Métricas de desempenho para um modelo preparado personalizado.

Name	Tipo	Description
accuracyTop1	number	Só de leitura. Para modelos de classificação de várias classes. A proporção de amostras de teste em que a classe de verdade básica corresponde à classe prevista.
accuracyTop5	number	Só de leitura. Para modelos de classificação de várias classes. A proporção de amostras de teste em que a classe ground truth está nas cinco principais classes previstas.
averagePrecision	number	Só de leitura. Uma medida do desempenho do modelo resume a precisão e a revocação em diferentes limiares de confiança.
calibrationECE	number	Só de leitura. Para modelos de classificação de várias classes. Erro de calibragem esperado.
meanAveragePrecision30	number	Só de leitura. Para modelos de deteção de objetos. Precisão média média num limiar de 30%.
meanAveragePrecision50	number	Só de leitura. Para modelos de deteção de objetos. Precisão média média num limiar de 50%.
meanAveragePrecision75	number	Só de leitura. Para modelos de deteção de objetos. Precisão média média num limiar de 75%.
tagPerformance	<string,  ModelTagPerformance>	Só de leitura. Métricas de desempenho para cada etiqueta reconhecida pelo modelo.

ModelState

Só de leitura. O estado atual da execução da preparação.

Name	Tipo	Description
cancelled	string
cancelling	string
failed	string
notStarted	string
succeeded	string
training	string

ModelTagPerformance

Métricas de desempenho para cada etiqueta reconhecida por um modelo preparado personalizado.

Name	Tipo	Description
accuracy	number	Só de leitura. Para modelos de várias classes. Precisão da etiqueta.
averagePrecision50	number	Só de leitura. Para modelos de deteção de objetos. Precisão média num limiar de 50%.

TrainingParameters

Parâmetros para especificar como uma execução de preparação prepara um modelo personalizado.

Name	Tipo	Description
modelKind	ModelKind	Tipo de modelo.
timeBudgetInHours	integer	Orçamento de tempo para formação, em horas. O valor mínimo permitido é 1 e o valor máximo permitido é 336 horas para GenericClassifier, 1344 horas para GenericDetector. Esta é a quantidade máxima de tempo de computação que será gasto para preparar o modelo.
trainingDatasetName	string	O nome do conjunto de dados utilizado para a preparação.