Models - Get

Usługa:

Azure AI Services

Wersja interfejsu API:

2023-04-01-preview

Uzyskaj informacje o określonym modelu.

Zwrócone kody stanu:

• 200: Operacja została ukończona pomyślnie.
• 400: Żądanie zostało źle sformułowane.
• 404: Nie można odnaleźć modelu o określonej nazwie.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
name	path	True	string	Nazwa modelu do pobrania. Wzorzec wyrażenia regularnego: ^[a-zA-Z0-9][a-zA-Z0-9._-]*$
api-version	query	True	string	Żądana wersja interfejsu API.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	Model	Powodzenie
Other Status Codes	ErrorResponse	Błąd Nagłówki x-ms-error-code: string

Przykłady

Models_Get

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:

200

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

Definicje

Nazwa	Opis
ErrorResponse	Odpowiedź zwrócona po wystąpieniu błędu.
ErrorResponseDetails	Informacje o błędzie.
ErrorResponseInnerError	Szczegółowy błąd.
Model	Opisuje przebieg trenowania na potrzeby trenowania modelu niestandardowego.
ModelEvaluationParameters	Parametry określania sposobu oceniania modelu.
ModelKind	Rodzaj modelu.
ModelPerformance	Metryki wydajności dla niestandardowego wytrenowanego modelu.
ModelState	Tylko do odczytu. Bieżący stan przebiegu trenowania.
ModelTagPerformance	Metryki wydajności dla każdego tagu rozpoznawanego przez niestandardowy wytrenowany model.
TrainingParameters	Parametry służące do określania sposobu trenowania trenowania trenuje model niestandardowy.

ErrorResponse

Odpowiedź zwrócona po wystąpieniu błędu.

Nazwa	Typ	Opis
error	ErrorResponseDetails	Informacje o błędzie.

ErrorResponseDetails

Informacje o błędzie.

Nazwa	Typ	Opis
code	string	Kod błędu.
details	ErrorResponseDetails[]	Lista szczegółowych błędów.
innererror	ErrorResponseInnerError	Szczegółowy błąd.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ErrorResponseInnerError

Szczegółowy błąd.

Nazwa	Typ	Opis
code	string	Kod błędu.
innererror	ErrorResponseInnerError	Szczegółowy błąd.
message	string	Komunikat o błędzie.

Model

Opisuje przebieg trenowania na potrzeby trenowania modelu niestandardowego.

Nazwa	Typ	Opis
createdDateTime	string	Tylko do odczytu. Data i godzina pierwszego utworzenia przebiegu trenowania w formacie UTC.
error	ErrorResponseDetails	Informacje o błędzie.
evaluationParameters	ModelEvaluationParameters	Parametry określania sposobu oceniania modelu.
modelPerformance	ModelPerformance	Metryki wydajności dla niestandardowego wytrenowanego modelu.
name	string	Tylko do odczytu. Nazwa używana do unikatowego identyfikowania przebiegu trenowania.
status	ModelState	Tylko do odczytu. Bieżący stan przebiegu trenowania.
trainingCostInMinutes	integer	Tylko do odczytu. Rzeczywisty koszt trenowania zużywany w minutach. Prezentuj tylko wtedy, gdy przebieg trenowania został ukończony.
trainingParameters	TrainingParameters	Parametry służące do określania sposobu trenowania trenowania trenuje model niestandardowy.
updatedDateTime	string	Tylko do odczytu. Data i godzina ostatniej aktualizacji przebiegu trenowania w formacie UTC.

ModelEvaluationParameters

Parametry określania sposobu oceniania modelu.

Nazwa	Typ	Opis
testDatasetName	string	Nazwa zestawu danych używana do testowania.

ModelKind

Rodzaj modelu.

Nazwa	Typ	Opis
Generic-Classifier	string
Generic-Detector	string
Product-Recognizer	string

ModelPerformance

Metryki wydajności dla niestandardowego wytrenowanego modelu.

Nazwa	Typ	Opis
accuracyTop1	number	Tylko do odczytu. W przypadku modeli klasyfikacji wieloklasowej. Proporcja próbek testowych, w których klasa ground truth jest zgodna z przewidywaną klasą.
accuracyTop5	number	Tylko do odczytu. W przypadku modeli klasyfikacji wieloklasowej. Odsetek próbek testowych, w których klasa podstawowej prawdy znajduje się w pięciu pierwszych przewidywanych klasach.
averagePrecision	number	Tylko do odczytu. Miara wydajności modelu zawiera podsumowanie dokładności i kompletności przy różnych progach ufności.
calibrationECE	number	Tylko do odczytu. W przypadku modeli klasyfikacji wieloklasowej. Oczekiwany błąd kalibracji.
meanAveragePrecision30	number	Tylko do odczytu. W przypadku modeli wykrywania obiektów. Średnia precyzja na poziomie progu wynoszącym 30%.
meanAveragePrecision50	number	Tylko do odczytu. W przypadku modeli wykrywania obiektów. Średnia precyzja na poziomie progu wynoszącym 50%.
meanAveragePrecision75	number	Tylko do odczytu. W przypadku modeli wykrywania obiektów. Średnia precyzja na poziomie progu wynoszącym 75%.
tagPerformance	<string,  ModelTagPerformance>	Tylko do odczytu. Metryki wydajności dla każdego tagu rozpoznawane przez model.

ModelState

Tylko do odczytu. Bieżący stan przebiegu trenowania.

Nazwa	Typ	Opis
cancelled	string
cancelling	string
failed	string
notStarted	string
succeeded	string
training	string

ModelTagPerformance

Metryki wydajności dla każdego tagu rozpoznawanego przez niestandardowy wytrenowany model.

Nazwa	Typ	Opis
accuracy	number	Tylko do odczytu. W przypadku modeli wieloklasowych. Dokładność tagów.
averagePrecision50	number	Tylko do odczytu. W przypadku modeli wykrywania obiektów. Średnia precyzja na progu wynoszącym 50%.

TrainingParameters

Parametry służące do określania sposobu trenowania trenowania trenuje model niestandardowy.

Nazwa	Typ	Opis
modelKind	ModelKind	Rodzaj modelu.
timeBudgetInHours	integer	Budżet czasu na szkolenie w godzinach. Minimalna dozwolona wartość to 1, a maksymalna dozwolona wartość to 336 godzin dla genericClassifier, 1344 godziny dla genericDetector. Jest to maksymalny czas obliczeniowy, który zostanie poświęcony na trenowanie modelu.
trainingDatasetName	string	Nazwa zestawu danych używana do trenowania.