Document Models - Compose Model

Service:

Azure AI Services

API-versie:

2024-07-31-preview

Hiermee maakt u een nieuw documentmodel op basis van documenttypen van bestaande documentmodellen.

POST {endpoint}/documentintelligence/documentModels:compose?api-version=2024-07-31-preview

URI-parameters

Name	In	Vereist	Type	Description
endpoint	path	True	string uri	Het Eindpunt van de Document Intelligence-service.
api-version	query	True	string	De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagbody

Name	Vereist	Type	Description
classifierId	True	string	Aangepaste classificatie voor het splitsen en classificeren van het invoerbestand.
docTypes	True	<string,  DocumentTypeDetails>	Woordenboektoewijzing ondersteunde docTypes aan de bijbehorende documentmodellen.
modelId	True	string	Unieke documentmodelnaam.
description		string	Beschrijving van documentmodel.
split		SplitMode	Gedrag voor het splitsen van bestanden.
tags		object	Lijst met kenmerken van sleutel-waardetags die zijn gekoppeld aan het documentmodel.

Antwoorden

Name	Type	Description
202 Accepted		De aanvraag is geaccepteerd voor verwerking, maar de verwerking is nog niet voltooid. Kopteksten Operation-Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Een onverwachte foutreactie.

Beveiliging

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

OAuth2Auth

Type: oauth2
Stroom: accessCode
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize
Token-URL: https://login.microsoftonline.com/common/oauth2/token

Bereiken

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

Voorbeelden

Compose Document Model

Voorbeeldaanvraag

HTTP

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

{
  "modelId": "composedModel",
  "description": "Composed model description",
  "classifierId": "customClassifier",
  "docTypes": {
    "formA": {
      "modelId": "model1"
    },
    "formB": {
      "modelId": "model2"
    }
  }
}

Voorbeeldrespons

Statuscode:

202

Operation-Location: https://myendpoint.cognitiveservices.azure.com/documentintelligence/operations/b704bb00-d130-4f3f-a1d8-ca96de3eabb4?api-version=2024-07-31-preview

Definities

Name	Description
ComposeDocumentModelRequest	Aanvraagtekst voor het maken van een samengesteld documentmodel op basis van documentmodellen van onderdelen.
DocumentAnalysisFeature	Documentanalysefuncties die u wilt inschakelen.
DocumentBuildMode	De buildmodus voor het aangepaste documentmodel.
DocumentFieldSchema	Beschrijving van het semantische veldschema met behulp van een syntaxis van de JSON-schemastijl.
DocumentFieldType	Semantisch gegevenstype van de veldwaarde.
DocumentTypeDetails	Informatie over documenttype.
Error	Het foutobject.
ErrorResponse	Foutantwoordobject.
InnerError	Een object met meer specifieke informatie over de fout.
SplitMode	Gedrag voor het splitsen van bestanden.

ComposeDocumentModelRequest

Aanvraagtekst voor het maken van een samengesteld documentmodel op basis van documentmodellen van onderdelen.

Name	Type	Default value	Description
classifierId	string		Aangepaste classificatie voor het splitsen en classificeren van het invoerbestand.
description	string		Beschrijving van documentmodel.
docTypes	<string,  DocumentTypeDetails>		Woordenboektoewijzing ondersteunde docTypes aan de bijbehorende documentmodellen.
modelId	string		Unieke documentmodelnaam.
split	SplitMode	none	Gedrag voor het splitsen van bestanden.
tags	object		Lijst met kenmerken van sleutel-waardetags die zijn gekoppeld aan het documentmodel.

DocumentAnalysisFeature

Documentanalysefuncties die u wilt inschakelen.

Name	Type	Description
barcodes	string	Schakel de detectie van streepjescodes in het document in.
formulas	string	Schakel de detectie van wiskundige expressies in het document in.
keyValuePairs	string	Schakel de detectie van algemene sleutelwaardeparen (formuliervelden) in het document in.
languages	string	Schakel de detectie van de tekstinhoudstaal in.
ocrHighResolution	string	Voer OCR uit met een hogere resolutie om documenten met een kleine afdruk af te handelen.
queryFields	string	Schakel de extractie van extra velden in via de queryveld-queryparameter.
styleFont	string	Schakel de herkenning van verschillende lettertypestijlen in.

DocumentBuildMode

De buildmodus voor het aangepaste documentmodel.

Name	Type	Description
generative	string	Documenten van alle typen inschakelen met behulp van generatieve AI-technieken.
neural	string	Ondersteuning voor documenten met diverse visuele sjablonen.
template	string	Doeldocumenten met vergelijkbare visuele sjablonen.

DocumentFieldSchema

Beschrijving van het semantische veldschema met behulp van een syntaxis van de JSON-schemastijl.

Name	Type	Description
description	string	Veldbeschrijving.
example	string	Voorbeeld van veldinhoud.
items	DocumentFieldSchema	Het schema van het veldtype van elk matrixelement.
properties	<string,  DocumentFieldSchema>	Benoemde subvelden van het objectveld.
type	DocumentFieldType	Semantisch gegevenstype van de veldwaarde.

DocumentFieldType

Semantisch gegevenstype van de veldwaarde.

Name	Type	Description
address	string	Geparseerd adres.
array	string	Lijst met subvelden van hetzelfde type.
boolean	string	Booleaanse waarde, genormaliseerd tot waar of onwaar.
countryRegion	string	Land/regio, genormaliseerd naar ISO 3166-1 alfa-3-indeling (bijvoorbeeld VS).
currency	string	Valutabedrag met optioneel valutasymbool en -eenheid.
date	string	Datum, genormaliseerd naar ISO 8601-indeling (JJJJ-MM-DD).
integer	string	Geheel getal, genormaliseerd tot 64-bits ondertekend geheel getal.
number	string	Drijvendekommagetal, genormaliseerd tot drijvende komma met dubbele precisie.
object	string	Benoemde lijst met subvelden van mogelijk verschillende typen.
phoneNumber	string	Telefoonnummer, genormaliseerd naar E.164-indeling (+{CountryCode}{SubscriberNumber}).
selectionGroup	string	Matrix van geselecteerde tekenreekswaarden.
selectionMark	string	Is het veld geselecteerd?
signature	string	Is de handtekening aanwezig?
string	string	Tekst zonder opmaak.
time	string	Tijd, genormaliseerd naar ISO 8601-indeling (uu:mm:ss).

DocumentTypeDetails

Informatie over documenttype.

Name	Type	Description
buildMode	DocumentBuildMode	De buildmodus voor het aangepaste documentmodel.
confidenceThreshold	number	Voer alleen een analyse uit als de betrouwbaarheid van docType hoger is dan de drempelwaarde.
description	string	Beschrijving van documentmodel.
features	DocumentAnalysisFeature[]	Lijst met optionele analysefuncties.
fieldConfidence	object	Geschatte betrouwbaarheid voor elk veld.
fieldSchema	<string,  DocumentFieldSchema>	Beschrijving van het semantische documentschema met behulp van een syntaxis van de JSON-schemastijl.
maxDocumentsToAnalyze	integer	Maximum aantal documenten van het opgegeven type dat moet worden geanalyseerd. Default=all.
modelId	string	Documentmodel dat moet worden gebruikt voor het analyseren van documenten met een opgegeven type.
queryFields	string[]	Lijst met extra velden die moeten worden geëxtraheerd. Ex. "NumberOfGuests,StoreNumber"

Error

Het foutobject.

Name	Type	Description
code	string	Een van een door de server gedefinieerde set foutcodes.
details	Error[]	Een matrix met details over specifieke fouten die hebben geleid tot deze gemelde fout.
innererror	InnerError	Een object met meer specifieke informatie dan het huidige object over de fout.
message	string	Een leesbare weergave van de fout.
target	string	Het doel van de fout.

ErrorResponse

Foutantwoordobject.

Name	Type	Description
error	Error	Foutinformatie.

InnerError

Een object met meer specifieke informatie over de fout.

Name	Type	Description
code	string	Een van een door de server gedefinieerde set foutcodes.
innererror	InnerError	Interne fout.
message	string	Een leesbare weergave van de fout.

SplitMode

Gedrag voor het splitsen van bestanden.

Name	Type	Description
auto	string	Bestand automatisch splitsen in documenten.
none	string	Het hele bestand behandelen als één document.
perPage	string	Elke pagina in het bestand behandelen als een afzonderlijk document.