Document Models - Compose Model

Service:

Azure AI Services

API Version:

2024-02-29-preview

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

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

URI-parameters

Name	In	Vereist	Type	Description
endpoint	path	True	string	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
componentModels	True	ComponentDocumentModelDetails[]	Lijst met documentmodellen voor onderdelen die moeten worden opgesteld.
modelId	True	string	Unieke documentmodelnaam.
description		string	Beschrijving van documentmodel.
tags		object	Lijst met sleutel-waardetagkenmerken 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. Headers Operation-Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Een onverwacht foutbericht.

Beveiliging

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

Voorbeelden

Compose Document Model

Sample Request

HTTP

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

{
  "modelId": "composedModel",
  "description": "Composed model description",
  "componentModels": [
    {
      "modelId": "model1"
    },
    {
      "modelId": "model2"
    }
  ]
}

Sample Response

Status code:

202

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

Definities

Name	Description
ComponentDocumentModelDetails	Een onderdeel van een samengesteld documentmodel.
ComposeDocumentModelRequest	Aanvraagbody om een samengesteld documentmodel te maken op basis van onderdeeldocumentmodellen.
Error	Het foutobject.
ErrorResponse	Foutreactieobject.
InnerError	Een object met specifiekere informatie over de fout.

ComponentDocumentModelDetails

Een onderdeel van een samengesteld documentmodel.

Name	Type	Description
modelId	string	Unieke documentmodelnaam.

ComposeDocumentModelRequest

Aanvraagbody om een samengesteld documentmodel te maken op basis van onderdeeldocumentmodellen.

Name	Type	Description
componentModels	ComponentDocumentModelDetails[]	Lijst met documentmodellen voor onderdelen die moeten worden opgesteld.
description	string	Beschrijving van documentmodel.
modelId	string	Unieke documentmodelnaam.
tags	object	Lijst met sleutel-waardetagkenmerken die zijn gekoppeld aan het documentmodel.

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 tot deze gerapporteerde fout hebben geleid.
innererror	InnerError	Een object met specifiekere informatie dan het huidige object over de fout.
message	string	Een door mensen leesbare weergave van de fout.
target	string	Het doel van de fout.

ErrorResponse

Foutreactieobject.

Name	Type	Description
error	Error	Foutinformatie.

InnerError

Een object met specifiekere 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 door mensen leesbare weergave van de fout.