Models - List

Referenz

Dienst:: Azure AI Services

API-Version:: 2023-04-01-preview

Rufen Sie eine Liste der verfügbaren Modelle ab.

Zurückgegebene Statuscodes:

200: Vorgang erfolgreich abgeschlossen.
400: Die Anforderung wurde falsch formatiert.

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

Mit optionalen Parametern:

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
api-version	query	True	string	Angeforderte API-Version.
skip	query		integer int32	Anzahl der modelle, die übersprungen werden sollen.
top	query		integer int32	Anzahl der Modelle, die nach dem Überspringen zurückgegeben werden sollen. Der maximal zulässige Wert ist 30.

Antworten

Name	Typ	Beschreibung
200 OK	ModelApiModelCollectionApiModel	Erfolg
Other Status Codes	ErrorResponse	Fehler Header x-ms-error-code: string

Name

Typ

Beschreibung

200 OK

ModelApiModelCollectionApiModel

Erfolg

Other Status Codes

ErrorResponse

Fehler

Header

x-ms-error-code: string

Beispiele

Models_List

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:: 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"
      }
    }
  ]
}

Definitionen

Name	Beschreibung
ErrorResponse	Die Antwort wird zurückgegeben, wenn ein Fehler auftritt.
ErrorResponseDetails	Fehlerinformationen.
ErrorResponseInnerError	Detaillierter Fehler.
Model	Beschreibt eine Trainingsausführung zum Trainieren eines benutzerdefinierten Modells.
ModelApiModelCollectionApiModel	Enthält ein Array von Ergebnissen, die paginiert werden können.
ModelEvaluationParameters	Parameter zum Angeben der Auswertung eines Modells.
ModelKind	Modellart.
ModelPerformance	Leistungsmetriken für ein benutzerdefiniertes trainiertes Modell.
ModelState	Schreibgeschützt. Der aktuelle Status der Trainingsausführung.
ModelTagPerformance	Leistungsmetriken für jedes Tag, das von einem benutzerdefinierten trainierten Modell erkannt wird.
TrainingParameters	Parameter zum Angeben, wie eine Trainingsausführung ein benutzerdefiniertes Modell trainiert.

ErrorResponse

Die Antwort wird zurückgegeben, wenn ein Fehler auftritt.

Name	Typ	Beschreibung
error	ErrorResponseDetails	Fehlerinformationen.

ErrorResponseDetails

Fehlerinformationen.

Name	Typ	Beschreibung
code	string	Fehlercode
details	ErrorResponseDetails[]	Liste der detaillierten Fehler.
innererror	ErrorResponseInnerError	Detaillierter Fehler.
message	string	Fehlermeldung.
target	string	Ziel des Fehlers.

ErrorResponseInnerError

Detaillierter Fehler.

Name	Typ	Beschreibung
code	string	Fehlercode
innererror	ErrorResponseInnerError	Detaillierter Fehler.
message	string	Fehlermeldung.

Model

Beschreibt eine Trainingsausführung zum Trainieren eines benutzerdefinierten Modells.

Name	Typ	Beschreibung
createdDateTime	string	Schreibgeschützt. Das Datum und die Uhrzeit der ersten Erstellung der Trainingsausführung in UTC.
error	ErrorResponseDetails	Fehlerinformationen.
evaluationParameters	ModelEvaluationParameters	Parameter zum Angeben der Auswertung eines Modells.
modelPerformance	ModelPerformance	Leistungsmetriken für ein benutzerdefiniertes trainiertes Modell.
name	string	Schreibgeschützt. Der Name, der verwendet wird, um die Trainingsausführung eindeutig zu identifizieren.
status	ModelState	Schreibgeschützt. Der aktuelle Status der Trainingsausführung.
trainingCostInMinutes	integer	Schreibgeschützt. Die tatsächlich verbrauchten Trainingskosten in Minuten. Nur vorhanden, wenn das Training als abgeschlossen ausgeführt wird.
trainingParameters	TrainingParameters	Parameter zum Angeben, wie eine Trainingsausführung ein benutzerdefiniertes Modell trainiert.
updatedDateTime	string	Schreibgeschützt. Datum und Uhrzeit der letzten Aktualisierung der Trainingsausführung in UTC.

ModelApiModelCollectionApiModel

Enthält ein Array von Ergebnissen, die paginiert werden können.

Name	Typ	Beschreibung
nextLink	string	Ein Link zum nächsten Satz paginierter Ergebnisse, wenn weitere Ergebnisse verfügbar sind; andernfalls nicht vorhanden.
value	Model[]	Das Array der Ergebnisse.

ModelEvaluationParameters

Parameter zum Angeben der Auswertung eines Modells.

Name	Typ	Beschreibung
testDatasetName	string	Der für Tests verwendete Datasetname.

ModelKind

Modellart.

Name	Typ	Beschreibung
Generic-Classifier	string
Generic-Detector	string
Product-Recognizer	string

ModelPerformance

Leistungsmetriken für ein benutzerdefiniertes trainiertes Modell.

Name	Typ	Beschreibung
accuracyTop1	number	Schreibgeschützt. Für Multiklassenklassifizierungsmodelle. Der Anteil der Testbeispiele, bei denen die Ground Truth-Klasse mit der vorhergesagten Klasse übereinstimmt.
accuracyTop5	number	Schreibgeschützt. Für Multiklassenklassifizierungsmodelle. Der Anteil der Testbeispiele, bei denen sich die Bodenwahrheitsklasse in den fünf obersten vorhergesagten Klassen befindet.
averagePrecision	number	Schreibgeschützt. Es ist ein Maß für die Modellleistung und fasst die Genauigkeit und den Rückruf an verschiedenen Konfidenzschwellenwerten zusammen.
calibrationECE	number	Schreibgeschützt. Für Multiklassenklassifizierungsmodelle. Erwarteter Kalibrierungsfehler.
meanAveragePrecision30	number	Schreibgeschützt. Für Objekterkennungsmodelle. Mittlere durchschnittliche Genauigkeit bei einem Schwellenwert von 30 %.
meanAveragePrecision50	number	Schreibgeschützt. Für Objekterkennungsmodelle. Durchschnittliche Genauigkeit bei einem Schwellenwert von 50 %.
meanAveragePrecision75	number	Schreibgeschützt. Für Objekterkennungsmodelle. Durchschnittliche Genauigkeit bei einem Schwellenwert von 75 %.
tagPerformance	<string, ModelTagPerformance>	Schreibgeschützt. Leistungsmetriken für jedes Tag, das vom Modell erkannt wird.

ModelState

Schreibgeschützt. Der aktuelle Status der Trainingsausführung.

Name	Typ	Beschreibung
cancelled	string
cancelling	string
failed	string
notStarted	string
succeeded	string
training	string

ModelTagPerformance

Leistungsmetriken für jedes Tag, das von einem benutzerdefinierten trainierten Modell erkannt wird.

Name	Typ	Beschreibung
accuracy	number	Schreibgeschützt. Für Multiklassenmodelle. Taggenauigkeit.
averagePrecision50	number	Schreibgeschützt. Für Objekterkennungsmodelle. Durchschnittliche Genauigkeit bei einem Schwellenwert von 50 %.

TrainingParameters

Parameter zum Angeben, wie eine Trainingsausführung ein benutzerdefiniertes Modell trainiert.

Name	Typ	Beschreibung
modelKind	ModelKind	Modellart.
timeBudgetInHours	integer	Zeitbudget für die Schulung in Stunden. Der minimal zulässige Wert ist 1, und der maximal zulässige Wert beträgt 336 Stunden für GenericClassifier und 1344 Stunden für GenericDetector. Dies ist die maximale Computezeit, die zum Trainieren des Modells aufgewendet wird.
trainingDatasetName	string	Der für das Training verwendete Datasetname.

Freigeben über

Models - List

URI-Parameter

Antworten

Beispiele

Models_List

Beispielanforderung

Beispiel für eine Antwort

Definitionen

ErrorResponse

ErrorResponseDetails

ErrorResponseInnerError

Model

ModelApiModelCollectionApiModel

ModelEvaluationParameters

ModelKind

ModelPerformance

ModelState

ModelTagPerformance

TrainingParameters

Zusätzliche Ressourcen