Document Models - Compose Model
Hiermee maakt u een nieuw documentmodel op basis van documenttypen van bestaande documentmodellen.
POST {endpoint}/formrecognizer/documentModels:compose?api-version=2022-08-31
URI-parameters
Name | In | Vereist | Type | Description |
---|---|---|---|---|
endpoint
|
path | True |
string |
Ondersteunde Cognitive Services-eindpunten (protocol en hostnaam, bijvoorbeeld: https://westus2.api.cognitive.microsoft.com). |
api-version
|
query | True |
Aangevraagde API-versie. |
Aanvraagkoptekst
Name | Vereist | Type | Description |
---|---|---|---|
Ocp-Apim-Subscription-Key | True |
string |
Aanvraagbody
Name | Vereist | Type | Description |
---|---|---|---|
componentModels | True |
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 in de wachtrij geplaatst. Headers Operation-Location: string |
|
Other Status Codes |
Er is een fout opgetreden. |
Beveiliging
Ocp-Apim-Subscription-Key
Type:
apiKey
In:
header
Voorbeelden
ComposeDocumentModel
Sample Request
POST {endpoint}/formrecognizer/documentModels:compose?api-version=2022-08-31
{
"modelId": "{composedModelId}",
"description": "{composedModelDescription}",
"componentModels": [
{
"modelId": "{modelId1}"
},
{
"modelId": "{modelId2}"
}
]
}
Sample Response
Operation-Location: {endpoint}/formrecognizer/operations/{operationId}?api-version=2022-08-31
Definities
Name | Description |
---|---|
Api |
API-versie. |
Component |
Een onderdeel van een samengesteld documentmodel. |
Compose |
Aanvraagtekst om een samengesteld documentmodel te maken op basis van onderdeeldocumentmodellen. |
Error |
Foutgegevens. |
Error |
Foutreactieobject. |
Inner |
Gedetailleerde fout. |
ApiVersion
API-versie.
Name | Type | Description |
---|---|---|
2022-08-31 |
string |
ComponentDocumentModelDetails
Een onderdeel van een samengesteld documentmodel.
Name | Type | Description |
---|---|---|
modelId |
string |
Unieke documentmodelnaam. |
ComposeDocumentModelRequest
Aanvraagtekst om een samengesteld documentmodel te maken op basis van onderdeeldocumentmodellen.
Name | Type | Description |
---|---|---|
componentModels |
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
Foutgegevens.
Name | Type | Description |
---|---|---|
code |
string |
Foutcode. |
details |
Error[] |
Lijst met gedetailleerde fouten. |
innererror |
Gedetailleerde fout. |
|
message |
string |
Foutbericht. |
target |
string |
Doel van de fout. |
ErrorResponse
Foutreactieobject.
Name | Type | Description |
---|---|---|
error |
Foutgegevens. |
InnerError
Gedetailleerde fout.
Name | Type | Description |
---|---|---|
code |
string |
Foutcode. |
innererror |
Gedetailleerde fout. |
|
message |
string |
Foutbericht. |