Models - List

Tjänst:

Azure AI Services

API-version:

2023-04-01-preview

Hämta en lista över tillgängliga modeller.

Statuskoder som returneras:

• 200: Åtgärden har slutförts.
• 400: Begäran var felaktig.

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

Med valfria parametrar:

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
api-version	query	True	string	Begärd API-version.
skip	query		integer int32	Antal modeller som ska hoppas över.
top	query		integer int32	Antal modeller som ska returneras efter att ha hoppat över. Det högsta tillåtna värdet är 30.

Svar

Name	Typ	Description
200 OK	ModelApiModelCollectionApiModel	Klart
Other Status Codes	ErrorResponse	Fel Sidhuvuden x-ms-error-code: string

Exempel

Models_List

Exempelbegäran

HTTP

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

Exempelsvar

Statuskod:

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

Definitioner

Name	Description
ErrorResponse	Svar som returneras när ett fel inträffar.
ErrorResponseDetails	Felinformation.
ErrorResponseInnerError	Detaljerat fel.
Model	Beskriver en träningskörning för träning av en anpassad modell.
ModelApiModelCollectionApiModel	Innehåller en matris med resultat som kan vara sidnumrerade.
ModelEvaluationParameters	Parametrar för att ange hur en modell utvärderas.
ModelKind	Modelltyp.
ModelPerformance	Prestandamått för en anpassad tränad modell.
ModelState	Skrivskyddad. Träningskörningens aktuella tillstånd.
ModelTagPerformance	Prestandamått för varje tagg som identifieras av en anpassad tränad modell.
TrainingParameters	Parametrar för att ange hur en träningskörning tränar en anpassad modell.

ErrorResponse

Svar som returneras när ett fel inträffar.

Name	Typ	Description
error	ErrorResponseDetails	Felinformation.

ErrorResponseDetails

Felinformation.

Name	Typ	Description
code	string	Felkod.
details	ErrorResponseDetails[]	Lista över detaljerade fel.
innererror	ErrorResponseInnerError	Detaljerat fel.
message	string	Felmeddelande.
target	string	Målet för felet.

ErrorResponseInnerError

Detaljerat fel.

Name	Typ	Description
code	string	Felkod.
innererror	ErrorResponseInnerError	Detaljerat fel.
message	string	Felmeddelande.

Model

Beskriver en träningskörning för träning av en anpassad modell.

Name	Typ	Description
createdDateTime	string	Skrivskyddad. Datum och tid då träningskörningen först skapades, i UTC.
error	ErrorResponseDetails	Felinformation.
evaluationParameters	ModelEvaluationParameters	Parametrar för att ange hur en modell utvärderas.
modelPerformance	ModelPerformance	Prestandamått för en anpassad tränad modell.
name	string	Skrivskyddad. Det namn som används för att unikt identifiera träningskörningen.
status	ModelState	Skrivskyddad. Träningskörningens aktuella tillstånd.
trainingCostInMinutes	integer	Skrivskyddad. Faktisk träningskostnad förbrukad, i minuter. Presentera endast om träningen körs som slutförd.
trainingParameters	TrainingParameters	Parametrar för att ange hur en träningskörning tränar en anpassad modell.
updatedDateTime	string	Skrivskyddad. Datum och tid då träningskörningen senast uppdaterades, i UTC.

ModelApiModelCollectionApiModel

Innehåller en matris med resultat som kan vara sidnumrerade.

Name	Typ	Description
nextLink	string	En länk till nästa uppsättning sidnumrerade resultat, om det finns fler tillgängliga resultat. inte presentera något annat.
value	Model[]	Matrisen med resultat.

ModelEvaluationParameters

Parametrar för att ange hur en modell utvärderas.

Name	Typ	Description
testDatasetName	string	Det datauppsättningsnamn som används för testning.

ModelKind

Modelltyp.

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

ModelPerformance

Prestandamått för en anpassad tränad modell.

Name	Typ	Description
accuracyTop1	number	Skrivskyddad. För klassificeringsmodeller med flera klasser. Andelen testexempel där klassen ground truth matchar den förutsagda klassen.
accuracyTop5	number	Skrivskyddad. För klassificeringsmodeller med flera klasser. Andelen testexempel där klassen ground truth finns bland de fem främsta förutsagda klasserna.
averagePrecision	number	Skrivskyddad. Ett mått på modellens prestanda och sammanfattar precisionen och träffsäkerheten vid olika tröskelvärden för konfidens.
calibrationECE	number	Skrivskyddad. För klassificeringsmodeller med flera klasser. Förväntat kalibreringsfel.
meanAveragePrecision30	number	Skrivskyddad. För objektidentifieringsmodeller. Genomsnittlig genomsnittlig precision vid ett tröskelvärde på 30 %.
meanAveragePrecision50	number	Skrivskyddad. För objektidentifieringsmodeller. Genomsnittlig genomsnittlig precision vid ett tröskelvärde på 50 %.
meanAveragePrecision75	number	Skrivskyddad. För objektidentifieringsmodeller. Genomsnittlig genomsnittlig precision vid ett tröskelvärde på 75 %.
tagPerformance	<string,  ModelTagPerformance>	Skrivskyddad. Prestandamått för varje tagg som identifieras av modellen.

ModelState

Skrivskyddad. Träningskörningens aktuella tillstånd.

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

ModelTagPerformance

Prestandamått för varje tagg som identifieras av en anpassad tränad modell.

Name	Typ	Description
accuracy	number	Skrivskyddad. För modeller med flera klasser. Taggnoggrannhet.
averagePrecision50	number	Skrivskyddad. För objektidentifieringsmodeller. Genomsnittlig precision vid ett tröskelvärde på 50 %.

TrainingParameters

Parametrar för att ange hur en träningskörning tränar en anpassad modell.

Name	Typ	Description
modelKind	ModelKind	Modelltyp.
timeBudgetInHours	integer	Tidsbudget för träning, i timmar. Det minsta tillåtna värdet är 1 och det högsta tillåtna värdet är 336 timmar för GenericClassifier, 1 344 timmar för GenericDetector. Det här är den maximala beräkningstiden som ska användas för att träna modellen.
trainingDatasetName	string	Det datauppsättningsnamn som används för träning.