Document Models - Get Model

Tjänst:

Azure AI Services

API-version:

2022-08-31

Hämtar detaljerad dokumentmodellinformation.

GET {endpoint}/formrecognizer/documentModels/{modelId}?api-version=2022-08-31

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	Unikt namn på dokumentmodell. Reguljärt uttrycksmönster: [a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}
api-version	query	True	ApiVersion	Begärd API-version.

Begärandehuvud

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

Svar

Name	Typ	Description
200 OK	DocumentModelDetails	OK.
Other Status Codes	ErrorResponse	Ett fel påträffades.

Säkerhet

Ocp-Apim-Subscription-Key

Typ: apiKey
I: header

Exempel

GetDocumentModel_Custom

GetDocumentModel_Prebuilt

GetDocumentModel_Custom

Exempelbegäran

HTTP

GET {endpoint}/formrecognizer/documentModels/{customModelId}?api-version=2022-08-31

Exempelsvar

Statuskod:

200

{
  "modelId": "{customModelId}",
  "description": "{customModelDescription}",
  "createdDateTime": "2021-09-24T12:54:35Z",
  "apiVersion": "2022-08-31",
  "docTypes": {
    "{docType}": {
      "fieldSchema": {
        "Name": {
          "type": "string"
        },
        "Date": {
          "type": "date"
        },
        "Amount": {
          "type": "number"
        }
      },
      "buildMode": "template",
      "fieldConfidence": {
        "Name": 0.9,
        "Date": 0.95,
        "Amount": 0.93
      }
    }
  },
  "tags": {
    "createdBy": "{userId}"
  }
}

GetDocumentModel_Prebuilt

Exempelbegäran

HTTP

GET {endpoint}/formrecognizer/documentModels/prebuilt-invoice?api-version=2022-08-31

Exempelsvar

Statuskod:

200

{
  "modelId": "prebuilt-invoice",
  "description": "Prebuilt model to extract key information from English invoices, including customer, vendor, invoice ID, due date, total, and more.",
  "createdDateTime": "2021-07-30T00:00:00Z",
  "apiVersion": "2022-08-31",
  "docTypes": {
    "prebuilt:invoice": {
      "fieldSchema": {
        "CustomerName": {
          "type": "string"
        },
        "CustomerId": {
          "type": "string"
        },
        "PurchaseOrder": {
          "type": "string"
        },
        "InvoiceId": {
          "type": "string"
        },
        "InvoiceDate": {
          "type": "date"
        },
        "DueDate": {
          "type": "date"
        },
        "VendorName": {
          "type": "string"
        },
        "VendorAddress": {
          "type": "string"
        },
        "VendorAddressRecipient": {
          "type": "string"
        },
        "CustomerAddress": {
          "type": "string"
        },
        "CustomerAddressRecipient": {
          "type": "string"
        },
        "BillingAddress": {
          "type": "string"
        },
        "BillingAddressRecipient": {
          "type": "string"
        },
        "ShippingAddress": {
          "type": "string"
        },
        "ShippingAddressRecipient": {
          "type": "string"
        },
        "SubTotal": {
          "type": "number"
        },
        "TotalTax": {
          "type": "number"
        },
        "InvoiceTotal": {
          "type": "number"
        },
        "AmountDue": {
          "type": "number"
        },
        "PreviousUnpaidBalance": {
          "type": "number"
        },
        "RemittanceAddress": {
          "type": "string"
        },
        "RemittanceAddressRecipient": {
          "type": "string"
        },
        "ServiceAddress": {
          "type": "string"
        },
        "ServiceAddressRecipient": {
          "type": "string"
        },
        "ServiceStartDate": {
          "type": "date"
        },
        "ServiceEndDate": {
          "type": "date"
        },
        "Items": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "Amount": {
                "type": "number"
              },
              "Date": {
                "type": "date"
              },
              "Description": {
                "type": "string"
              },
              "Quantity": {
                "type": "number"
              },
              "ProductCode": {
                "type": "string"
              },
              "Tax": {
                "type": "number"
              },
              "Unit": {
                "type": "string"
              },
              "UnitPrice": {
                "type": "number"
              }
            }
          }
        }
      }
    }
  },
  "tags": {}
}

Definitioner

Name	Description
ApiVersion	API-version.
DocumentBuildMode	Byggläge för anpassad dokumentmodell.
DocumentFieldSchema	Beskrivning av fältets semantiska schema med hjälp av en syntax för JSON-schemaformat.
DocumentFieldType	Semantisk datatyp för fältvärdet.
DocumentModelDetails	Dokumentmodellinformation.
DocumentTypeDetails	Information om dokumenttyp.
Error	Felinformation.
ErrorResponse	Felsvarsobjekt.
InnerError	Detaljerat fel.

ApiVersion

API-version.

Name	Typ	Description
2022-08-31	string

DocumentBuildMode

Byggläge för anpassad dokumentmodell.

Name	Typ	Description
neural	string
template	string

DocumentFieldSchema

Beskrivning av fältets semantiska schema med hjälp av en syntax för JSON-schemaformat.

Name	Typ	Description
description	string	Fältbeskrivning.
example	string	Exempelfältinnehåll.
items	DocumentFieldSchema	Schema för fälttyp för varje matriselement.
properties	<string,  DocumentFieldSchema>	Namngivna underfält i objektfältet.
type	DocumentFieldType	Semantisk datatyp för fältvärdet.

DocumentFieldType

Semantisk datatyp för fältvärdet.

Name	Typ	Description
address	string
array	string
countryRegion	string
currency	string
date	string
integer	string
number	string
object	string
phoneNumber	string
selectionMark	string
signature	string
string	string
time	string

DocumentModelDetails

Dokumentmodellinformation.

Name	Typ	Description
apiVersion	string	API-version som används för att skapa den här dokumentmodellen.
createdDateTime	string	Datum och tid (UTC) när dokumentmodellen skapades.
description	string	Beskrivning av dokumentmodell.
docTypes	<string,  DocumentTypeDetails>	Dokumenttyper som stöds.
modelId	string	Unikt namn på dokumentmodell.
tags	object	Lista över nyckel/värde-taggattribut som är associerade med dokumentmodellen.

DocumentTypeDetails

Information om dokumenttyp.

Name	Typ	Description
buildMode	DocumentBuildMode	Byggläge för anpassad dokumentmodell.
description	string	Beskrivning av dokumentmodell.
fieldConfidence	object	Uppskattad konfidens för varje fält.
fieldSchema	<string,  DocumentFieldSchema>	Beskrivning av dokumentets semantiska schema med en syntax för JSON-schemaformat.

Error

Felinformation.

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

ErrorResponse

Felsvarsobjekt.

Name	Typ	Description
error	Error	Felinformation.

InnerError

Detaljerat fel.

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