Document Models - Get Model

Reference

Služba:: Azure AI Services

Verze rozhraní API:: 2024-07-31-preview

Získá podrobné informace o modelu dokumentu.

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

Parametry identifikátoru URI

Name V Vyžadováno Typ Description

Name	V	Vyžadováno	Typ	Description
endpoint	path	True	string uri	Koncový bod služby Document Intelligence
modelId	path	True	string	Jedinečný název modelu dokumentu Vzor regulárního výrazu: `^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$`
api-version	query	True	string	Verze rozhraní API, která se má použít pro tuto operaci.

endpoint

path

True

string

uri

Koncový bod služby Document Intelligence

modelId

path

True

string

Jedinečný název modelu dokumentu

Vzor regulárního výrazu: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$

api-version

query

True

string

Verze rozhraní API, která se má použít pro tuto operaci.

Hlavička požadavku

Name	Vyžadováno	Typ	Description
x-ms-client-request-id		string uuid	Neprůzrný globálně jedinečný identifikátor řetězce vygenerovaný klientem pro požadavek.

Odpovědi

Name	Typ	Description
200 OK	DocumentModelDetails	Požadavek byl úspěšný. Hlavičky x-ms-client-request-id: string
Other Status Codes	ErrorResponse	Neočekávaná chybová odpověď

Name

Typ

Description

200 OK

DocumentModelDetails

Požadavek byl úspěšný.

Hlavičky

x-ms-client-request-id: string

Other Status Codes

ErrorResponse

Neočekávaná chybová odpověď

Zabezpečení

Ocp-Apim-Subscription-Key

Typ: apiKey
V: header

OAuth2Auth

Typ: oauth2
Tok: accessCode
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize
URL tokenu: https://login.microsoftonline.com/common/oauth2/token

Rozsahy

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

Příklady

Get Custom Document Model

Get Prebuilt Document Model

Get Custom Document Model

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kód:: 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

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kód:: 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": {}
}

Definice

Name	Description
AzureBlobContentSource	Obsah služby Azure Blob Storage
AzureBlobFileListContentSource	Seznam souborů ve službě Azure Blob Storage
DocumentAnalysisFeature	Funkce analýzy dokumentů, které chcete povolit.
DocumentBuildMode	Režim sestavení vlastního modelu dokumentu
DocumentFieldSchema	Popis sémantického schématu pole pomocí syntaxe stylu schématu JSON
DocumentFieldType	Sémantický datový typ hodnoty pole
DocumentModelDetails	Informace o modelu dokumentu
DocumentTypeDetails	Informace o typu dokumentu
Error	Objekt chyby.
ErrorResponse	Objekt odpovědi na chybu
InnerError	Objekt obsahující konkrétnější informace o chybě.
SplitMode	Chování rozdělení souboru
Warning	Objekt chyby.

AzureBlobContentSource

Obsah služby Azure Blob Storage

Name	Typ	Description
containerUrl	string	Adresa URL kontejneru služby Azure Blob Storage
prefix	string	Předpona názvu objektu blob

AzureBlobFileListContentSource

Seznam souborů ve službě Azure Blob Storage

Name	Typ	Description
containerUrl	string	Adresa URL kontejneru služby Azure Blob Storage
fileList	string	Cesta k souboru JSONL v kontejneru určujícím podmnožinu dokumentů

DocumentAnalysisFeature

Funkce analýzy dokumentů, které chcete povolit.

Name	Typ	Description
barcodes	string	Povolte detekci čárových kódů v dokumentu.
formulas	string	Povolte detekci matematických výrazů v dokumentu.
keyValuePairs	string	Povolte detekci obecných párů klíč-hodnota (pole formulářů) v dokumentu.
languages	string	Povolte detekci jazyka textového obsahu.
ocrHighResolution	string	Pokud chcete zpracovávat dokumenty s jemným tiskem, proveďte OCR s vyšším rozlišením.
queryFields	string	Povolte extrakci dalších polí pomocí parametru dotazu queryFields.
styleFont	string	Povolte rozpoznávání různých stylů písem.

DocumentBuildMode

Režim sestavení vlastního modelu dokumentu

Name	Typ	Description
generative	string	Povolte dokumenty všech typů pomocí technik generující umělé inteligence.
neural	string	Podpora dokumentů s různými vizuálními šablonami
template	string	Cílové dokumenty s podobnými šablonami vizuálů

DocumentFieldSchema

Popis sémantického schématu pole pomocí syntaxe stylu schématu JSON

Name	Typ	Description
description	string	Popis pole
example	string	Příklad obsahu pole
items	DocumentFieldSchema	Schéma typu pole každého prvku pole
properties	<string, DocumentFieldSchema>	Pojmenovaná dílčí pole pole objektu
type	DocumentFieldType	Sémantický datový typ hodnoty pole

DocumentFieldType

Sémantický datový typ hodnoty pole

Name	Typ	Description
address	string	Parsovaná adresa.
array	string	Seznam dílčích polí stejného typu
boolean	string	Logická hodnota, normalizovaná na hodnotu true nebo false.
countryRegion	string	Země/oblast, normalizovaná na formát ISO 3166-1 alfa-3 (např. USA).
currency	string	Částka měny s volitelným symbolem měny a jednotkou
date	string	Datum, normalizované ve formátu ISO 8601 (RRRR-MM-DD)
integer	string	Celočíselné číslo, normalizované na 64bitové celé číslo se signedem.
number	string	Číslo s plovoucí desetinnou čárkou, normalizované na dvojitou přesnost s plovoucí desetinnou čárkou.
object	string	Pojmenovaný seznam dílčích polí potenciálně různých typů
phoneNumber	string	Telefonní číslo, normalizované na formát E.164 (+{CountryCode}{SubscriberNumber}).
selectionGroup	string	Pole vybraných řetězcových hodnot
selectionMark	string	Je pole vybrané?
signature	string	Existuje podpis?
string	string	Prostý text.
time	string	Čas normalizovaný do formátu ISO 8601 (hh:mm:ss).

DocumentModelDetails

Informace o modelu dokumentu

Name	Typ	Default value	Description
apiVersion	string		Verze rozhraní API používaná k vytvoření tohoto modelu dokumentu.
azureBlobFileListSource	AzureBlobFileListContentSource		Seznam souborů Azure Blob Storage určující trénovací data Je nutné zadat azureBlobSource nebo azureBlobFileListSource.
azureBlobSource	AzureBlobContentSource		Umístění služby Azure Blob Storage obsahující trénovací data Je nutné zadat azureBlobSource nebo azureBlobFileListSource.
buildMode	DocumentBuildMode		Režim sestavení vlastního modelu dokumentu
classifierId	string		U složených modelů se vlastní klasifikátor rozděluje a klasifikuje vstupní soubor.
createdDateTime	string		Datum a čas (UTC) při vytvoření modelu dokumentu
description	string		Popis modelu dokumentu
docTypes	<string, DocumentTypeDetails>		Podporované typy dokumentů
expirationDateTime	string		Datum a čas (UTC), kdy vyprší platnost modelu dokumentu.
modelId	string		Jedinečný název modelu dokumentu
split	SplitMode	none	U složených modelů chování rozdělení souboru.
tags	object		Seznam atributů značky klíč-hodnota přidružených k modelu dokumentu
trainingHours	number		Počet hodin GPU ekvivalentních v100 spotřebovaných pro trénování modelu
warnings	Warning[]		Seznam upozornění, ke kterým došlo při sestavování modelu

DocumentTypeDetails

Informace o typu dokumentu

Name	Typ	Description
buildMode	DocumentBuildMode	Režim sestavení vlastního modelu dokumentu
confidenceThreshold	number	Analýzu proveďte pouze v případě, že spolehlivost docType překračuje prahovou hodnotu.
description	string	Popis modelu dokumentu
features	DocumentAnalysisFeature[]	Seznam volitelných analytických funkcí
fieldConfidence	object	Odhadovaná spolehlivost pro každé pole
fieldSchema	<string, DocumentFieldSchema>	Popis sémantického schématu dokumentu pomocí syntaxe stylu schématu JSON
maxDocumentsToAnalyze	integer	Maximální početdokumentůchch Default=all.
modelId	string	Model dokumentů, který se má použít k analýze dokumentů se zadaným typem
queryFields	string[]	Seznam dalších polí k extrakci Ex. "NumberOfGuests,StoreNumber"

Error

Objekt chyby.

Name	Typ	Description
code	string	Jedna ze serverově definovaných kódů chyb.
details	Error[]	Pole podrobností o konkrétních chybách, které vedly k této nahlášené chybě.
innererror	InnerError	Objekt obsahující konkrétnější informace, než je aktuální objekt o chybě.
message	string	Čitelné znázornění chyby člověkem.
target	string	Cíl chyby.

ErrorResponse

Objekt odpovědi na chybu

Name	Typ	Description
error	Error	Informace o chybě

InnerError

Objekt obsahující konkrétnější informace o chybě.

Name	Typ	Description
code	string	Jedna ze serverově definovaných kódů chyb.
innererror	InnerError	Vnitřní chyba.
message	string	Čitelné znázornění chyby člověkem.

SplitMode

Chování rozdělení souboru

Name	Typ	Description
auto	string	Automaticky rozdělte soubor na dokumenty.
none	string	Považovat celý soubor za jeden dokument.
perPage	string	Každou stránku v souboru můžete považovat za samostatný dokument.

Warning

Objekt chyby.

Name	Typ	Description
code	string	Jedna ze serverově definovaných kódů upozornění.
message	string	Čitelné znázornění varování člověkem.
target	string	Cíl chyby.

Sdílet prostřednictvím

Document Models - Get Model

Parametry identifikátoru URI

Hlavička požadavku

Odpovědi

Zabezpečení

Ocp-Apim-Subscription-Key

OAuth2Auth

Rozsahy

Příklady

Get Custom Document Model

Ukázkový požadavek

Ukázková odpověď

Get Prebuilt Document Model

Ukázkový požadavek

Ukázková odpověď

Definice

AzureBlobContentSource

AzureBlobFileListContentSource

DocumentAnalysisFeature

DocumentBuildMode

DocumentFieldSchema

DocumentFieldType

DocumentModelDetails

DocumentTypeDetails

Error

ErrorResponse

InnerError

SplitMode

Warning

Další materiály