Sdílet prostřednictvím


Custom Models - List

Získání informací o všech vlastních modelech

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

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
endpoint
path True

string

Podporované koncové body služeb Cognitive Services (protokol a název hostitele, například: https://westus2.api.cognitive.microsoft.com).

op
query True

string

Určete, jestli se má vrátit souhrn nebo úplný seznam modelů.

Hlavička požadavku

Name Vyžadováno Typ Description
Ocp-Apim-Subscription-Key True

string

Odpovědi

Name Typ Description
200 OK

Models

Success

Other Status Codes

ErrorResponse

Entita odpovědi doprovázející neúspěšné odpovědi obsahující další podrobnosti o chybě.

Zabezpečení

Ocp-Apim-Subscription-Key

Typ: apiKey
V: header

Příklady

List custom models

Ukázkový požadavek

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

Ukázková odpověď

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

Definice

Name Description
Attributes

Volitelné atributy modelu

ErrorInformation
ErrorResponse
ModelInfo

Základní informace o vlastním modelu

Models

Odpověď na operaci výpisu vlastních modelů

ModelStatus

Stav modelu.

Summary

Souhrn všech natrénovaných vlastních modelů

Attributes

Volitelné atributy modelu

Name Typ Default value Description
isComposed

boolean

False

Je tento model složený? (výchozí hodnota: false).

ErrorInformation

Name Typ Description
code

string

message

string

ErrorResponse

Name Typ Description
error

ErrorInformation

ModelInfo

Základní informace o vlastním modelu

Name Typ Description
attributes

Attributes

Volitelné atributy modelu

createdDateTime

string

Datum a čas (UTC) vytvoření modelu

lastUpdatedDateTime

string

Datum a čas (UTC), kdy byl stav naposledy aktualizován.

modelId

string

Identifikátor modelu.

modelName

string

Volitelný název modelu definovaný uživatelem (maximální délka: 1024)

status

ModelStatus

Stav modelu.

Models

Odpověď na operaci výpisu vlastních modelů

Name Typ Description
modelList

ModelInfo[]

Kolekce natrénovaných vlastních modelů

nextLink

string

Odkaz na další stránku vlastních modelů

summary

Summary

Souhrn všech natrénovaných vlastních modelů

ModelStatus

Stav modelu.

Name Typ Description
creating

string

invalid

string

ready

string

Summary

Souhrn všech natrénovaných vlastních modelů

Name Typ Description
count

integer

Aktuální počet vytrénovaných vlastních modelů

lastUpdatedDateTime

string

Datum a čas (UTC), kdy byl souhrn naposledy aktualizován.

limit

integer

Maximální počet modelů, které lze pro tento účet vytrénovat.