Custom Models - Get

Reference

Služba:: Azure AI Services

Verze rozhraní API:: 2.1

Získejte podrobné informace o vlastním modelu.

GET {endpoint}/formrecognizer/v2.1/custom/models/{modelId}

S volitelnými parametry:

GET {endpoint}/formrecognizer/v2.1/custom/models/{modelId}?includeKeys={includeKeys}

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).
modelId	path	True	string uuid	Identifikátor modelu.
includeKeys	query		boolean	Zahrnout seznam extrahovaných klíčů do informací o modelu.

Hlavička požadavku

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

Odpovědi

Name	Typ	Description
200 OK	Model	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

Get custom model

Ukázkový požadavek

HTTP

GET {endpoint}/formrecognizer/v2.1/custom/models/f973e3c1-1148-43bb-bea8-49d0603ab3a8

Ukázková odpověď

Stavový kód:: 200

{
  "modelInfo": {
    "modelId": "f973e3c1-1148-43bb-bea8-49d0603ab3a8",
    "modelName": "my composed model",
    "status": "ready",
    "createdDateTime": "2019-05-01T10:53:21Z",
    "lastUpdatedDateTime": "2019-05-01T10:53:23Z",
    "attributes": {
      "isComposed": true
    }
  },
  "keys": {
    "clusters": {
      "0": [
        "Invoice",
        "123112313"
      ],
      "1": [
        "Please remit payment to:",
        "Microsoft"
      ]
    }
  },
  "trainResult": {
    "trainingDocuments": [],
    "fields": [],
    "averageModelAccuracy": 0,
    "errors": []
  },
  "composedTrainResults": [
    {
      "modelId": "4afb20d6-3ed0-4cde-ba40-dbd6207268dd",
      "trainingDocuments": [],
      "fields": [],
      "averageModelAccuracy": 0,
      "errors": []
    },
    {
      "modelId": "6f841356-aa32-42c9-a739-2182c47b79c9",
      "trainingDocuments": [],
      "fields": [],
      "averageModelAccuracy": 0,
      "errors": []
    }
  ]
}

Definice

Name	Description
Attributes	Volitelné atributy modelu
ErrorInformation
ErrorResponse
FormFieldsReport	Sestava pro vlastní trénovací pole modelu
KeysResult	Klíče extrahované vlastním modelem.
Model	Odpověď na operaci získání vlastního modelu.
ModelInfo	Základní informace o vlastním modelu
ModelStatus	Stav modelu.
TrainingDocumentInfo	Sestava pro trénovací dokument vlastního modelu
TrainResult	Výsledek trénování vlastního modelu
TrainStatus	Stav trénovací operace.

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

FormFieldsReport

Sestava pro vlastní trénovací pole modelu

Name	Typ	Description
accuracy	number	Odhadovaná přesnost extrakce pro toto pole
fieldName	string	Název trénovacího pole.

KeysResult

Klíče extrahované vlastním modelem.

Name	Typ	Description
clusters	object	Id clusteru mapování objektů na seznam klíčů.

Model

Odpověď na operaci získání vlastního modelu.

Name	Typ	Description
composedTrainResults	TrainResult[]	Trénovací výsledek pro složený model.
keys	KeysResult	Klíče extrahované vlastním modelem.
modelInfo	ModelInfo	Základní informace o vlastním modelu
trainResult	TrainResult	Trénovací výsledek pro vlastní model.

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.

ModelStatus

Stav modelu.

Name	Typ	Description
creating	string
invalid	string
ready	string

TrainingDocumentInfo

Sestava pro trénovací dokument vlastního modelu

Name	Typ	Description
documentName	string	Název trénovacího dokumentu.
errors	ErrorInformation[]	Seznam chyb
pages	integer	Celkový počet vytrénovaných stránek.
status	TrainStatus	Stav trénovací operace.

TrainResult

Výsledek trénování vlastního modelu

Name	Typ	Description
averageModelAccuracy	number	Průměrná přesnost.
errors	ErrorInformation[]	Chyby vrácené během operace trénování
fields	FormFieldsReport[]	Seznam polí použitých k trénování modelu a chyby operace trénování, které hlásí.
modelId	string	Identifikátor modelu.
trainingDocuments	TrainingDocumentInfo[]	Seznam dokumentů použitých k trénování modelu a všech chyb hlášených v jednotlivých dokumentech

TrainStatus

Stav trénovací operace.

Name	Typ	Description
failed	string
partiallySucceeded	string
succeeded	string

Sdílet prostřednictvím