Freigeben über


Custom Models - List

Ruft Informationen zu allen benutzerdefinierten Modellen ab

GET {endpoint}/formrecognizer/v2.1/custom/models?op=full

URI-Parameter

Name In Erforderlich Typ Beschreibung
endpoint
path True

string

Unterstützte Cognitive Services-Endpunkte (Protokoll und Hostname, z. B. ). https://westus2.api.cognitive.microsoft.com

op
query True

string

Geben Sie an, ob eine Zusammenfassung oder eine vollständige Liste der Modelle zurückgegeben werden soll.

Anforderungsheader

Name Erforderlich Typ Beschreibung
Ocp-Apim-Subscription-Key True

string

Antworten

Name Typ Beschreibung
200 OK

Models

Erfolg

Other Status Codes

ErrorResponse

Antwortentität, die nicht erfolgreiche Antworten begleitet, die zusätzliche Details zum Fehler enthält.

Sicherheit

Ocp-Apim-Subscription-Key

Typ: apiKey
In: header

Beispiele

List custom models

Beispielanforderung

GET {endpoint}/formrecognizer/v2.1/custom/models?op=full

Beispiel für eine Antwort

{
  "summary": {
    "count": 2,
    "limit": 5000,
    "lastUpdatedDateTime": "2019-05-01T10:53:21Z"
  },
  "modelList": [
    {
      "modelId": "f973e3c1-1148-43bb-bea8-49d0603ab3a8",
      "modelName": "test model 1",
      "status": "ready",
      "createdDateTime": "2019-05-01T10:53:21Z",
      "lastUpdatedDateTime": "2019-05-01T10:53:23Z",
      "attributes": {
        "isComposed": false
      }
    },
    {
      "modelId": "f973e3c1-0001-43bb-bea8-49d0603ab3a8",
      "modelName": "test model 2",
      "status": "ready",
      "createdDateTime": "2019-05-01T10:53:21Z",
      "lastUpdatedDateTime": "2019-05-01T10:53:23Z",
      "attributes": {
        "isComposed": true
      }
    }
  ],
  "nextLink": ""
}

Definitionen

Name Beschreibung
Attributes

Optionale Modellattribute.

ErrorInformation
ErrorResponse
ModelInfo

Grundlegende Informationen zum benutzerdefinierten Modell.

Models

Antwort auf den Listenvorgang für benutzerdefinierte Modelle.

ModelStatus

Status des Modells.

Summary

Zusammenfassung aller trainierten benutzerdefinierten Modelle.

Attributes

Optionale Modellattribute.

Name Typ Standardwert Beschreibung
isComposed

boolean

False

Ist dieses Modell zusammengesetzt? (Standard: false).

ErrorInformation

Name Typ Beschreibung
code

string

message

string

ErrorResponse

Name Typ Beschreibung
error

ErrorInformation

ModelInfo

Grundlegende Informationen zum benutzerdefinierten Modell.

Name Typ Beschreibung
attributes

Attributes

Optionale Modellattribute.

createdDateTime

string

Datum und Uhrzeit (UTC) zum Zeitpunkt der Erstellung des Modells.

lastUpdatedDateTime

string

Datum und Uhrzeit (UTC), zu dem die status zuletzt aktualisiert wurde.

modelId

string

Modellbezeichner.

modelName

string

Optionaler benutzerdefinierter Modellname (maximale Länge: 1024).

status

ModelStatus

Status des Modells.

Models

Antwort auf den Listenvorgang für benutzerdefinierte Modelle.

Name Typ Beschreibung
modelList

ModelInfo[]

Sammlung trainierter benutzerdefinierter Modelle.

nextLink

string

Link zur nächsten Seite mit benutzerdefinierten Modellen.

summary

Summary

Zusammenfassung aller trainierten benutzerdefinierten Modelle.

ModelStatus

Status des Modells.

Name Typ Beschreibung
creating

string

invalid

string

ready

string

Summary

Zusammenfassung aller trainierten benutzerdefinierten Modelle.

Name Typ Beschreibung
count

integer

Aktuelle Anzahl trainierter benutzerdefinierter Modelle.

lastUpdatedDateTime

string

Datum und Uhrzeit (UTC), wann die Zusammenfassung zuletzt aktualisiert wurde.

limit

integer

Maximale Anzahl von Modellen, die für dieses Konto trainiert werden können.