Document Models - Compose Model
Crée un modèle de document à partir de types de documents de modèles de document existants.
POST {endpoint}/formrecognizer/documentModels:compose?api-version=2023-07-31
Paramètres URI
Nom | Dans | Obligatoire | Type | Description |
---|---|---|---|---|
endpoint
|
path | True |
string url |
Points de terminaison Cognitive Services pris en charge (protocole et nom d’hôte, par exemple : https://westus2.api.cognitive.microsoft.com). |
api-version
|
query | True |
string |
Version de l’API demandée. |
En-tête de la demande
Nom | Obligatoire | Type | Description |
---|---|---|---|
Ocp-Apim-Subscription-Key | True |
string |
Clé secrète de votre abonnement Azure Cognitive Services. |
Corps de la demande
Nom | Obligatoire | Type | Description |
---|---|---|---|
componentModels | True |
Liste des modèles de documents de composant à composer. |
|
modelId | True |
string |
Nom du modèle de document unique. |
description |
string |
Description du modèle de document. |
|
tags |
object |
Liste des attributs de balise clé-valeur associés au modèle de document. |
Réponses
Nom | Type | Description |
---|---|---|
202 Accepted |
La demande est mise en file d’attente. Headers Operation-Location: string |
|
Other Status Codes |
Erreur rencontrée. |
Sécurité
Ocp-Apim-Subscription-Key
Clé secrète de votre abonnement Azure Cognitive Services.
Type:
apiKey
In:
header
Exemples
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
Définitions
Nom | Description |
---|---|
Component |
Composant d’un modèle de document composé. |
Compose |
Corps de la demande pour créer un modèle de document composé à partir de modèles de document de composant. |
Error |
Informations d’erreur. |
Error |
Objet de réponse d’erreur. |
Inner |
Erreur détaillée. |
ComponentDocumentModelDetails
Composant d’un modèle de document composé.
Nom | Type | Description |
---|---|---|
modelId |
string |
Nom du modèle de document unique. |
ComposeDocumentModelRequest
Corps de la demande pour créer un modèle de document composé à partir de modèles de document de composant.
Nom | Type | Description |
---|---|---|
componentModels |
Liste des modèles de documents de composant à composer. |
|
description |
string |
Description du modèle de document. |
modelId |
string |
Nom du modèle de document unique. |
tags |
object |
Liste des attributs de balise clé-valeur associés au modèle de document. |
Error
Informations d’erreur.
Nom | Type | Description |
---|---|---|
code |
string |
Code d’erreur. |
details |
Error[] |
Liste des erreurs détaillées. |
innererror |
Erreur détaillée. |
|
message |
string |
Message d’erreur. |
target |
string |
Cible de l’erreur. |
ErrorResponse
Objet de réponse d’erreur.
Nom | Type | Description |
---|---|---|
error |
Informations d’erreur. |
InnerError
Erreur détaillée.
Nom | Type | Description |
---|---|---|
code |
string |
Code d’erreur. |
innererror |
Erreur détaillée. |
|
message |
string |
Message d’erreur. |