Custom Models - Get

Referens

Tjänst:: Azure AI Services

API-version:: 2.1

Få detaljerad information om en anpassad modell.

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

Med valfria parametrar:

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
endpoint	path	True	string	Cognitive Services-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://westus2.api.cognitive.microsoft.com).
modelId	path	True	string uuid	Modellidentifierare.
includeKeys	query		boolean	Ta med en lista över extraherade nycklar i modellinformationen.

Begärandehuvud

Name	Obligatorisk	Typ	Description
Ocp-Apim-Subscription-Key	True	string

Svar

Name	Typ	Description
200 OK	Model	Klart
Other Status Codes	ErrorResponse	Svarsentitet som medföljer icke-lyckade svar som innehåller ytterligare information om felet.

Säkerhet

Ocp-Apim-Subscription-Key

Typ: apiKey
I: header

Exempel

Get custom model

Exempelbegäran

HTTP

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

Exempelsvar

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

Definitioner

Name	Description
Attributes	Valfria modellattribut.
ErrorInformation
ErrorResponse
FormFieldsReport	Rapport för ett anpassat modellträningsfält.
KeysResult	Nycklar som extraheras av den anpassade modellen.
Model	Svar på åtgärden hämta anpassad modell.
ModelInfo	Grundläggande information om anpassade modeller.
ModelStatus	Status för modellen.
TrainingDocumentInfo	Rapport för ett träningsdokument för anpassad modell.
TrainResult	Träningsresultat för anpassad modell.
TrainStatus	Status för träningsåtgärden.

Attributes

Valfria modellattribut.

Name	Typ	Standardvärde	Description
isComposed	boolean	False	Består den här modellen? (standard: false).

ErrorInformation

Name	Typ	Description
code	string
message	string

ErrorResponse

Name	Typ	Description
error	ErrorInformation

FormFieldsReport

Rapport för ett anpassat modellträningsfält.

Name	Typ	Description
accuracy	number	Uppskattad noggrannhet för extrahering för det här fältet.
fieldName	string	Namn på träningsfält.

KeysResult

Nycklar som extraheras av den anpassade modellen.

Name	Typ	Description
clusters	object	Objektmappning av clusterIds till en lista med nycklar.

Model

Svar på åtgärden hämta anpassad modell.

Name	Typ	Description
composedTrainResults	TrainResult[]	Träningsresultat för sammansatt modell.
keys	KeysResult	Nycklar som extraheras av den anpassade modellen.
modelInfo	ModelInfo	Grundläggande information om anpassade modeller.
trainResult	TrainResult	Träningsresultat för anpassad modell.

ModelInfo

Grundläggande information om anpassade modeller.

Name	Typ	Description
attributes	Attributes	Valfria modellattribut.
createdDateTime	string	Datum och tid (UTC) när modellen skapades.
lastUpdatedDateTime	string	Datum och tid (UTC) när statusen senast uppdaterades.
modelId	string	Modellidentifierare.
modelName	string	Valfritt användardefinierat modellnamn (maxlängd: 1024).
status	ModelStatus	Status för modellen.

ModelStatus

Status för modellen.

Name	Typ	Description
creating	string
invalid	string
ready	string

TrainingDocumentInfo

Rapport för ett träningsdokument för anpassad modell.

Name	Typ	Description
documentName	string	Namn på träningsdokument.
errors	ErrorInformation[]	Lista över fel.
pages	integer	Totalt antal sidor som tränats.
status	TrainStatus	Status för träningsåtgärden.

TrainResult

Träningsresultat för anpassad modell.

Name	Typ	Description
averageModelAccuracy	number	Genomsnittlig noggrannhet.
errors	ErrorInformation[]	Fel som returnerades under träningsåtgärden.
fields	FormFieldsReport[]	Lista över fält som används för att träna modellen och träningsåtgärdsfelet som rapporterats av var och en.
modelId	string	Modellidentifierare.
trainingDocuments	TrainingDocumentInfo[]	Lista över dokument som används för att träna modellen och eventuella fel som rapporteras i varje dokument.

TrainStatus

Status för träningsåtgärden.

Name	Typ	Description
failed	string
partiallySucceeded	string
succeeded	string

Dela via