Document Models - Get Model

Referens

Tjänst:: Azure AI Services

API-version:: 2024-07-31-preview

Hämtar detaljerad dokumentmodellinformation.

GET {endpoint}/documentintelligence/documentModels/{modelId}?api-version=2024-07-31-preview

URI-parametrar

Name I Obligatorisk Typ Description

Name	I	Obligatorisk	Typ	Description
endpoint	path	True	string uri	Slutpunkten för document intelligence-tjänsten.
modelId	path	True	string	Unikt dokumentmodellnamn. Reguljärt uttrycksmönster: `^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$`
api-version	query	True	string	DEN API-version som ska användas för den här åtgärden.

endpoint

path

True

string

uri

Slutpunkten för document intelligence-tjänsten.

modelId

path

True

string

Unikt dokumentmodellnamn.

Reguljärt uttrycksmönster: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$

api-version

query

True

string

DEN API-version som ska användas för den här åtgärden.

Begärandehuvud

Name	Obligatorisk	Typ	Description
x-ms-client-request-id		string uuid	En ogenomskinlig, globalt unik, klientgenererad strängidentifierare för begäran.

Svar

Name	Typ	Description
200 OK	DocumentModelDetails	Begäran har slutförts. Sidhuvuden x-ms-client-request-id: string
Other Status Codes	ErrorResponse	Ett oväntat felsvar.

Name

Typ

Description

200 OK

DocumentModelDetails

Begäran har slutförts.

Sidhuvuden

x-ms-client-request-id: string

Other Status Codes

ErrorResponse

Ett oväntat felsvar.

Säkerhet

Ocp-Apim-Subscription-Key

Typ: apiKey
I: header

OAuth2Auth

Typ: oauth2
Flow: accessCode
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize
Token-webbadress: https://login.microsoftonline.com/common/oauth2/token

Omfattningar

Name	Description
https://cognitiveservices.azure.com/.default

Exempel

Get Custom Document Model

Get Prebuilt Document Model

Get Custom Document Model

Exempelbegäran

HTTP

GET https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/myCustomModel?api-version=2024-07-31-preview

Exempelsvar

Statuskod:: 200

{
  "modelId": "myCustomModel",
  "description": "Custom model description",
  "createdDateTime": "2021-09-24T12:54:35Z",
  "expirationDateTime": "2023-01-01T00:00:00Z",
  "apiVersion": "2024-07-31-preview",
  "docTypes": {
    "myForm": {
      "fieldSchema": {
        "Name": {
          "type": "string"
        },
        "Date": {
          "type": "date"
        },
        "Amount": {
          "type": "number"
        }
      },
      "buildMode": "template",
      "fieldConfidence": {
        "Name": 0.9,
        "Date": 0.95,
        "Amount": 0.93
      }
    }
  },
  "tags": {
    "createdBy": "myUserId"
  }
}

Get Prebuilt Document Model

Exempelbegäran

HTTP

GET https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/prebuilt-invoice?api-version=2024-07-31-preview

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": "2024-07-31-preview",
  "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
AzureBlobContentSource	Azure Blob Storage-innehåll.
AzureBlobFileListContentSource	Fillista i Azure Blob Storage.
DocumentAnalysisFeature	Funktioner för dokumentanalys som ska aktiveras.
DocumentBuildMode	Genereringslä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	Felobjektet.
ErrorResponse	Felsvarsobjekt.
InnerError	Ett objekt som innehåller mer specifik information om felet.
SplitMode	Beteende för fildelning.
Warning	Felobjektet.

AzureBlobContentSource

Azure Blob Storage-innehåll.

Name	Typ	Description
containerUrl	string	Url för Azure Blob Storage-container.
prefix	string	Prefix för blobnamn.

AzureBlobFileListContentSource

Fillista i Azure Blob Storage.

Name	Typ	Description
containerUrl	string	Url för Azure Blob Storage-container.
fileList	string	Sökväg till en JSONL-fil i containern som anger en delmängd av dokument.

DocumentAnalysisFeature

Funktioner för dokumentanalys som ska aktiveras.

Name	Typ	Description
barcodes	string	Aktivera identifiering av streckkoder i dokumentet.
formulas	string	Aktivera identifiering av matematiska uttryck i dokumentet.
keyValuePairs	string	Aktivera identifiering av allmänna nyckelvärdepar (formulärfält) i dokumentet.
languages	string	Aktivera identifiering av textinnehållsspråket.
ocrHighResolution	string	Utför OCR med högre upplösning för att hantera dokument med finstilt.
queryFields	string	Aktivera extrahering av ytterligare fält via frågeparametern queryFields.
styleFont	string	Aktivera igenkänning av olika teckensnittsformat.

DocumentBuildMode

Genereringsläge för anpassad dokumentmodell.

Name	Typ	Description
generative	string	Aktivera dokument av alla typer med generativa AI-tekniker.
neural	string	Stöd för dokument med olika visuella mallar.
template	string	Måldokument med liknande visuella mallar.

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	Parsad adress.
array	string	Lista över underfält av samma typ.
boolean	string	Booleskt värde, normaliserat till sant eller falskt.
countryRegion	string	Land/region, normaliserat till ISO 3166-1 alfa-3-format (till exempel USA).
currency	string	Valutabelopp med valfri valutasymbol och enhet.
date	string	Datum, normaliserat till FORMATET ISO 8601 (ÅÅÅÅ-MM-DD).
integer	string	Heltalsnummer, normaliserat till 64-bitars signerat heltal.
number	string	Flyttalsnummer, normaliserat till flyttal med dubbel precision.
object	string	Namngiven lista över underfält av potentiellt olika typer.
phoneNumber	string	Telefonnummer, normaliserat till formatet E.164 (+{CountryCode}{SubscriberNumber}).
selectionGroup	string	Matris med markerade strängvärden.
selectionMark	string	Är fältet markerat?
signature	string	Finns signaturen?
string	string	Klartext.
time	string	Tid, normaliserat till ISO 8601-format (hh:mm:ss).

DocumentModelDetails

Dokumentmodellinformation.

Name	Typ	Standardvärde	Description
apiVersion	string		API-version som används för att skapa den här dokumentmodellen.
azureBlobFileListSource	AzureBlobFileListContentSource		Azure Blob Storage-fillista som anger träningsdata. Antingen azureBlobSource eller azureBlobFileListSource måste anges.
azureBlobSource	AzureBlobContentSource		Azure Blob Storage-plats som innehåller träningsdata. Antingen azureBlobSource eller azureBlobFileListSource måste anges.
buildMode	DocumentBuildMode		Genereringsläge för anpassad dokumentmodell.
classifierId	string		För sammansatta modeller ska den anpassade klassificeraren dela upp och klassificera indatafilen.
createdDateTime	string		Datum och tid (UTC) när dokumentmodellen skapades.
description	string		Beskrivning av dokumentmodell.
docTypes	<string, DocumentTypeDetails>		Dokumenttyper som stöds.
expirationDateTime	string		Datum och tid (UTC) när dokumentmodellen upphör att gälla.
modelId	string		Unikt dokumentmodellnamn.
split	SplitMode	none	För sammansatta modeller fungerar fildelningen.
tags	object		Lista över taggattribut för nyckel/värde som är associerade med dokumentmodellen.
trainingHours	number		Antal V100-motsvarande GPU-timmar som förbrukats för modellträning.
warnings	Warning[]		Lista över varningar som påträffades när modellen byggdes.

DocumentTypeDetails

Information om dokumenttyp.

Name	Typ	Description
buildMode	DocumentBuildMode	Genereringsläge för anpassad dokumentmodell.
confidenceThreshold	number	Utför endast analys om docType-konfidensen är över tröskelvärdet.
description	string	Beskrivning av dokumentmodell.
features	DocumentAnalysisFeature[]	Lista över valfria analysfunktioner.
fieldConfidence	object	Uppskattad konfidens för varje fält.
fieldSchema	<string, DocumentFieldSchema>	Beskrivning av dokumentets semantiska schema med hjälp av en syntax för JSON-schemaformat.
maxDocumentsToAnalyze	integer	Maximalt antal dokument av den angivna typen som ska analyseras. Default=all.
modelId	string	Dokumentmodell som ska användas för att analysera dokument med angiven typ.
queryFields	string[]	Lista över ytterligare fält som ska extraheras. Ex. "NumberOfGuests,StoreNumber"

Error

Felobjektet.

Name	Typ	Description
code	string	En av en serverdefinierad uppsättning felkoder.
details	Error[]	En matris med information om specifika fel som ledde till det rapporterade felet.
innererror	InnerError	Ett objekt som innehåller mer specifik information än det aktuella objektet om felet.
message	string	En mänsklig läsbar representation av felet.
target	string	Målet för felet.

ErrorResponse

Felsvarsobjekt.

Name	Typ	Description
error	Error	Felinformation.

InnerError

Ett objekt som innehåller mer specifik information om felet.

Name	Typ	Description
code	string	En av en serverdefinierad uppsättning felkoder.
innererror	InnerError	Inre fel.
message	string	En mänsklig läsbar representation av felet.

SplitMode

Beteende för fildelning.

Name	Typ	Description
auto	string	Dela automatiskt upp filen i dokument.
none	string	Behandla hela filen som ett enda dokument.
perPage	string	Behandla varje sida i filen som ett separat dokument.

Warning

Felobjektet.

Name	Typ	Description
code	string	En av en serverdefinierad uppsättning varningskoder.
message	string	En mänsklig läsbar representation av varningen.
target	string	Målet för felet.

Dela via

Document Models - Get Model

URI-parametrar

Begärandehuvud

Svar

Säkerhet

Ocp-Apim-Subscription-Key

OAuth2Auth

Omfattningar

Exempel

Get Custom Document Model

Exempelbegäran

Exempelsvar

Get Prebuilt Document Model

Exempelbegäran

Exempelsvar

Definitioner

AzureBlobContentSource

AzureBlobFileListContentSource

DocumentAnalysisFeature

DocumentBuildMode

DocumentFieldSchema

DocumentFieldType

DocumentModelDetails

DocumentTypeDetails

Error

ErrorResponse

InnerError

SplitMode

Warning

Ytterligare resurser