Models - List

Serviço:

Azure AI Services

Versão da API:

2023-04-01-preview

Obtenha uma lista dos modelos disponíveis.

Códigos de status retornados:

• 200: Operação concluída com êxito.
• 400: A solicitação foi malformada.

GET /models?api-version=2023-04-01-preview

Com parâmetros opcionais:

GET /models?skip={skip}&top={top}&api-version=2023-04-01-preview

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
api-version	query	True	string	Versão da API solicitada.
skip	query		integer int32	Número de modelos a serem ignorados.
top	query		integer int32	Número de modelos a serem retornados após ignorar. O valor máximo permitido é 30.

Respostas

Nome	Tipo	Description
200 OK	ModelApiModelCollectionApiModel	Êxito
Other Status Codes	ErrorResponse	Erro Cabeçalhos x-ms-error-code: string

Exemplos

Models_List

Solicitação de exemplo

HTTP

GET /models?api-version=2023-04-01-preview

Resposta de exemplo

Código de status:

200

{
  "value": [
    {
      "name": "my_model_name",
      "createdDateTime": "2023-01-13T20:46:21.210Z",
      "updatedDateTime": "2023-01-13T20:46:21.210Z",
      "status": "notStarted",
      "trainingParameters": {
        "timeBudgetInHours": 1,
        "trainingDatasetName": "my_dataset_name"
      }
    }
  ]
}

Definições

Nome	Description
ErrorResponse	Resposta retornada quando ocorre um erro.
ErrorResponseDetails	Informações de erro.
ErrorResponseInnerError	Erro detalhado.
Model	Descreve uma execução de treinamento para treinar um modelo personalizado.
ModelApiModelCollectionApiModel	Contém uma matriz de resultados que podem ser paginados.
ModelEvaluationParameters	Parâmetros para especificar como um modelo é avaliado.
ModelKind	Tipo de modelo.
ModelPerformance	Métricas de desempenho para um modelo treinado personalizado.
ModelState	Somente leitura. O estado atual da execução de treinamento.
ModelTagPerformance	Métricas de desempenho para cada marca reconhecida por um modelo treinado personalizado.
TrainingParameters	Parâmetros para especificar como uma execução de treinamento treina um modelo personalizado.

ErrorResponse

Resposta retornada quando ocorre um erro.

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

ErrorResponseDetails

Informações de erro.

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

ErrorResponseInnerError

Erro detalhado.

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

Model

Descreve uma execução de treinamento para treinar um modelo personalizado.

Nome	Tipo	Description
createdDateTime	string	Somente leitura. A data e a hora em que a execução de treinamento foi criada pela primeira vez, em UTC.
error	ErrorResponseDetails	Informações de erro.
evaluationParameters	ModelEvaluationParameters	Parâmetros para especificar como um modelo é avaliado.
modelPerformance	ModelPerformance	Métricas de desempenho para um modelo treinado personalizado.
name	string	Somente leitura. O nome usado para identificar exclusivamente a execução de treinamento.
status	ModelState	Somente leitura. O estado atual da execução de treinamento.
trainingCostInMinutes	integer	Somente leitura. Custo real de treinamento consumido, em minutos. Apresente somente se o treinamento for executado como concluído.
trainingParameters	TrainingParameters	Parâmetros para especificar como uma execução de treinamento treina um modelo personalizado.
updatedDateTime	string	Somente leitura. A data e a hora em que a execução de treinamento foi atualizada pela última vez, em UTC.

ModelApiModelCollectionApiModel

Contém uma matriz de resultados que podem ser paginados.

Nome	Tipo	Description
nextLink	string	Um link para o próximo conjunto de resultados paginados, se houver mais resultados disponíveis; não está presente caso contrário.
value	Model[]	A matriz de resultados.

ModelEvaluationParameters

Parâmetros para especificar como um modelo é avaliado.

Nome	Tipo	Description
testDatasetName	string	O nome do conjunto de dados usado para teste.

ModelKind

Tipo de modelo.

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

ModelPerformance

Métricas de desempenho para um modelo treinado personalizado.

Nome	Tipo	Description
accuracyTop1	number	Somente leitura. Para modelos de classificação multiclasse. A proporção de amostras de teste em que a classe ground truth corresponde à classe prevista.
accuracyTop5	number	Somente leitura. Para modelos de classificação multiclasse. A proporção de exemplos de teste em que a classe ground truth está nas cinco primeiras classes previstas.
averagePrecision	number	Somente leitura. Uma medida do desempenho do modelo resume a precisão e o recall em diferentes limites de confiança.
calibrationECE	number	Somente leitura. Para modelos de classificação multiclasse. Erro de calibragem esperado.
meanAveragePrecision30	number	Somente leitura. Para modelos de detecção de objetos. Precisão média média em um limite de 30%.
meanAveragePrecision50	number	Somente leitura. Para modelos de detecção de objetos. Precisão média média em um limite de 50%.
meanAveragePrecision75	number	Somente leitura. Para modelos de detecção de objetos. Precisão média média em um limite de 75%.
tagPerformance	<string,  ModelTagPerformance>	Somente leitura. Métricas de desempenho para cada marca reconhecida pelo modelo.

ModelState

Somente leitura. O estado atual da execução de treinamento.

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

ModelTagPerformance

Métricas de desempenho para cada marca reconhecida por um modelo treinado personalizado.

Nome	Tipo	Description
accuracy	number	Somente leitura. Para modelos multiclasse. Precisão da marca.
averagePrecision50	number	Somente leitura. Para modelos de detecção de objetos. Precisão média a um limite de 50%.

TrainingParameters

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

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