Document Models - Compose Model
Új dokumentummodellt hoz létre a meglévő dokumentummodellek dokumentumtípusaiból.
POST {endpoint}/formrecognizer/documentModels:compose?api-version=2023-07-31
URI-paraméterek
Name | In | Kötelező | Típus | Description |
---|---|---|---|---|
endpoint
|
path | True |
string url |
Támogatott Cognitive Services-végpontok (protokoll és állomásnév, például: https://westus2.api.cognitive.microsoft.com). |
api-version
|
query | True |
string |
Kért API-verzió. |
Kérelem fejléce
Name | Kötelező | Típus | Description |
---|---|---|---|
Ocp-Apim-Subscription-Key | True |
string |
Az Azure Cognitive Services-előfizetés titkos kulcsa. |
Kérelem törzse
Name | Kötelező | Típus | Description |
---|---|---|---|
componentModels | True |
A összeállítandó összetevő-dokumentummodellek listája. |
|
modelId | True |
string |
Egyedi dokumentummodell neve. |
description |
string |
A dokumentummodell leírása. |
|
tags |
object |
A dokumentummodellhez társított kulcs-érték címkeattribútumok listája. |
Válaszok
Name | Típus | Description |
---|---|---|
202 Accepted |
A kérés várólistára helyezése sikeresen megtörtént. Headers Operation-Location: string |
|
Other Status Codes |
Hiba történt. |
Biztonság
Ocp-Apim-Subscription-Key
Az Azure Cognitive Services-előfizetés titkos kulcsa.
Type:
apiKey
In:
header
Példák
Compose Document Model
Sample Request
POST https://myendpoint.cognitiveservices.azure.com/formrecognizer/documentModels:compose?api-version=2023-07-31
{
"modelId": "composedModel",
"description": "Composed model description",
"componentModels": [
{
"modelId": "model1"
},
{
"modelId": "model2"
}
]
}
Sample Response
Operation-Location: https://myendpoint.cognitiveservices.azure.com/formrecognizer/operations/b704bb00-d130-4f3f-a1d8-ca96de3eabb4?api-version=2023-07-31
Definíciók
Name | Description |
---|---|
Component |
Egy összeállított dokumentummodell összetevője. |
Compose |
Törzs kérése az összetevődokumentum-modellekből álló dokumentummodell létrehozásához. |
Error |
Hibaadatok. |
Error |
Hibaválasz-objektum. |
Inner |
Részletes hiba. |
ComponentDocumentModelDetails
Egy összeállított dokumentummodell összetevője.
Name | Típus | Description |
---|---|---|
modelId |
string |
Egyedi dokumentummodell neve. |
ComposeDocumentModelRequest
Törzs kérése az összetevődokumentum-modellekből álló dokumentummodell létrehozásához.
Name | Típus | Description |
---|---|---|
componentModels |
A összeállítandó összetevő-dokumentummodellek listája. |
|
description |
string |
A dokumentummodell leírása. |
modelId |
string |
Egyedi dokumentummodell neve. |
tags |
object |
A dokumentummodellhez társított kulcs-érték címkeattribútumok listája. |
Error
Hibaadatok.
Name | Típus | Description |
---|---|---|
code |
string |
Hibakód. |
details |
Error[] |
A részletes hibák listája. |
innererror |
Részletes hiba. |
|
message |
string |
Hibaüzenet. |
target |
string |
A hiba célja. |
ErrorResponse
Hibaválasz-objektum.
Name | Típus | Description |
---|---|---|
error |
Hibaadatok. |
InnerError
Részletes hiba.
Name | Típus | Description |
---|---|---|
code |
string |
Hibakód. |
innererror |
Részletes hiba. |
|
message |
string |
Hibaüzenet. |