Document Models - Get Model

Referencia

Service:: Azure AI Services

API Version:: 2024-02-29-preview

Lekéri a részletes dokumentummodell-információkat.

GET {endpoint}/documentintelligence/documentModels/{modelId}?api-version=2024-02-29-preview

URI-paraméterek

Name In Kötelező Típus Description

Name	In	Kötelező	Típus	Description
endpoint	path	True	string	A Document Intelligence szolgáltatás végpontja.
modelId	path	True	string	Egyedi dokumentummodell neve. Regex pattern: `^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$`
api-version	query	True	string	A művelethez használandó API-verzió.

endpoint

path

True

string

A Document Intelligence szolgáltatás végpontja.

modelId

path

True

string

Egyedi dokumentummodell neve.

Regex pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$

api-version

query

True

string

A művelethez használandó API-verzió.

Kérelem fejléce

Name	Kötelező	Típus	Description
x-ms-client-request-id		string uuid	A kérés átlátszatlan, globálisan egyedi, ügyfél által létrehozott sztringazonosítója.

Válaszok

Name	Típus	Description
200 OK	DocumentModelDetails	A kérés sikeres volt. Headers x-ms-client-request-id: string
Other Status Codes	ErrorResponse	Váratlan hibaválasz.

Name

Típus

Description

200 OK

DocumentModelDetails

A kérés sikeres volt.

Headers

x-ms-client-request-id: string

Other Status Codes

ErrorResponse

Váratlan hibaválasz.

Biztonság

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

OAuth2Auth

Type: oauth2
Flow: accessCode
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize
Token URL: https://login.microsoftonline.com/common/oauth2/token

Scopes

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

Példák

Get Custom Document Model

Get Prebuilt Document Model

Get Custom Document Model

Sample Request

HTTP

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

Sample Response

Status code:: 200

{
  "modelId": "myCustomModel",
  "description": "Custom model description",
  "createdDateTime": "2021-09-24T12:54:35Z",
  "expirationDateTime": "2023-01-01T00:00:00Z",
  "apiVersion": "2024-02-29-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

Sample Request

HTTP

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

Sample Response

Status code:: 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-02-29-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": {}
}

Definíciók

Name	Description
AzureBlobContentSource	Azure Blob Storage tartalmat.
AzureBlobFileListContentSource	Fájllista Azure Blob Storage.
DocumentBuildMode	Egyéni dokumentummodell összeállítási módja.
DocumentFieldSchema	A mező szemantikai sémájának leírása JSON sémastílus-szintaxissal.
DocumentFieldType	A mezőérték szemantikai adattípusa.
DocumentModelDetails	Dokumentummodell adatai.
DocumentTypeDetails	Dokumentumtípus adatai.
Error	A hibaobjektum.
ErrorResponse	Hibaválasz-objektum.
InnerError	Egy objektum, amely pontosabb információkat tartalmaz a hibáról.
Warning	A hibaobjektum.

AzureBlobContentSource

Azure Blob Storage tartalmat.

Name	Típus	Description
containerUrl	string	Azure Blob Storage tároló URL-címe.
prefix	string	Blobnév előtagja.

AzureBlobFileListContentSource

Fájllista Azure Blob Storage.

Name	Típus	Description
containerUrl	string	Azure Blob Storage tároló URL-címe.
fileList	string	Egy JSONL-fájl elérési útja a tárolóban, amely a dokumentumok egy részhalmazát adja meg.

DocumentBuildMode

Egyéni dokumentummodell összeállítási módja.

Name	Típus	Description
neural	string	Különböző vizualizációs sablonokat tartalmazó dokumentumok támogatása.
template	string	Céldokumentumok hasonló vizualizációs sablonokkal.

DocumentFieldSchema

A mező szemantikai sémájának leírása JSON sémastílus-szintaxissal.

Name	Típus	Description
description	string	Mező leírása.
example	string	Példamező tartalma.
items	DocumentFieldSchema	Az egyes tömbelemek mezőtípus-sémája.
properties	<string, DocumentFieldSchema>	Az objektummező elnevezett almezői.
type	DocumentFieldType	A mezőérték szemantikai adattípusa.

DocumentFieldType

A mezőérték szemantikai adattípusa.

Name	Típus	Description
address	string	Elemzett cím.
array	string	Az azonos típusú almezők listája.
boolean	string	Logikai érték, igaz vagy hamis értékre normalizálva.
countryRegion	string	Ország/régió, iso 3166-1 alfa-3 formátumra normalizálva (pl. USA).
currency	string	Pénznem összege választható pénznemszimbólummal és egységgel.
date	string	Dátum, iso 8601 (YYYY-MM-DD) formátumra normalizálva.
integer	string	Egész szám, normalizálva 64 bites aláírt egész számra.
number	string	Lebegőpontos szám, normalizálva dupla pontosságú lebegőpontosra.
object	string	A potenciálisan különböző típusú almezők nevesített listája.
phoneNumber	string	E.164-es (+{CountryCode}{SubscriberNumber}) formátumú telefonszám.
selectionGroup	string	A kijelölt sztringértékek tömbje.
selectionMark	string	Ki van jelölve a mező?
signature	string	Jelen van aláírás?
string	string	Egyszerű szöveg.
time	string	Iso 8601 (óó:mm:ss) formátumra normalizált idő.

DocumentModelDetails

Dokumentummodell adatai.

Name	Típus	Description
apiVersion	string	A dokumentummodell létrehozásához használt API-verzió.
azureBlobFileListSource	AzureBlobFileListContentSource	Azure Blob Storage betanítási adatokat tartalmazó fájllista. Meg kell adni az azureBlobSource vagy az azureBlobFileListSource értéket.
azureBlobSource	AzureBlobContentSource	Azure Blob Storage betanítási adatokat tartalmazó helyet. Meg kell adni az azureBlobSource vagy az azureBlobFileListSource értéket.
buildMode	DocumentBuildMode	Egyéni dokumentummodell összeállítási módja.
createdDateTime	string	A dokumentummodell létrehozásának dátuma és időpontja (UTC).
description	string	A dokumentummodell leírása.
docTypes	<string, DocumentTypeDetails>	Támogatott dokumentumtípusok.
expirationDateTime	string	A dokumentummodell lejáratának dátuma és időpontja (UTC).
modelId	string	Egyedi dokumentummodell neve.
tags	object	A dokumentummodellhez társított kulcs-érték címkeattribútumok listája.
warnings	Warning[]	A modell létrehozása során észlelt figyelmeztetések listája.

DocumentTypeDetails

Dokumentumtípus adatai.

Name	Típus	Description
buildMode	DocumentBuildMode	Egyéni dokumentummodell összeállítási módja.
description	string	A dokumentummodell leírása.
fieldConfidence	object	Az egyes mezők becsült megbízhatósága.
fieldSchema	<string, DocumentFieldSchema>	A dokumentum szemantikai sémájának leírása JSON sémastílus-szintaxissal.

Error

A hibaobjektum.

Name	Típus	Description
code	string	A kiszolgáló által definiált hibakódok egyike.
details	Error[]	A jelentett hibához vezető konkrét hibák részleteinek tömbje.
innererror	InnerError	Egy objektum, amely az aktuális objektumnál pontosabb információt tartalmaz a hibáról.
message	string	A hiba emberi olvasásra alkalmas ábrázolása.
target	string	A hiba célja.

ErrorResponse

Hibaválasz-objektum.

Name	Típus	Description
error	Error	Hibaadatok.

InnerError

Egy objektum, amely pontosabb információkat tartalmaz a hibáról.

Name	Típus	Description
code	string	A kiszolgáló által definiált hibakódok egyike.
innererror	InnerError	Belső hiba.
message	string	A hiba emberi olvasásra alkalmas ábrázolása.

Warning

A hibaobjektum.

Name	Típus	Description
code	string	A kiszolgáló által definiált figyelmeztető kódok egyike.
message	string	A figyelmeztetés emberi olvasásra alkalmas ábrázolása.
target	string	A hiba célja.

Megosztás a következőn keresztül:

Document Models - Get Model

URI-paraméterek

Kérelem fejléce

Válaszok

Biztonság

Ocp-Apim-Subscription-Key

OAuth2Auth

Scopes

Példák

Get Custom Document Model

Sample Request

Sample Response

Get Prebuilt Document Model

Sample Request

Sample Response

Definíciók

AzureBlobContentSource

AzureBlobFileListContentSource

DocumentBuildMode

DocumentFieldSchema

DocumentFieldType

DocumentModelDetails

DocumentTypeDetails

Error

ErrorResponse

InnerError

Warning

További források