Document Models - Compose Model

Service:

Azure AI Services

Version d'API:

2022-08-31

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=2022-08-31

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
endpoint	path	True	string	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	ApiVersion	Version de l’API demandée.

En-tête de la demande

Nom	Obligatoire	Type	Description
Ocp-Apim-Subscription-Key	True	string

Corps de la demande

Nom	Obligatoire	Type	Description
componentModels	True	ComponentDocumentModelDetails[]	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. En-têtes Operation-Location: string
Other Status Codes	ErrorResponse	Erreur rencontrée.

Sécurité

Ocp-Apim-Subscription-Key

Type: apiKey
Dans: header

Exemples

ComposeDocumentModel

Exemple de requête

HTTP

POST {endpoint}/formrecognizer/documentModels:compose?api-version=2022-08-31

{
  "modelId": "{composedModelId}",
  "description": "{composedModelDescription}",
  "componentModels": [
    {
      "modelId": "{modelId1}"
    },
    {
      "modelId": "{modelId2}"
    }
  ]
}

Exemple de réponse

Code d’état:

202

Operation-Location: {endpoint}/formrecognizer/operations/{operationId}?api-version=2022-08-31

Définitions

Nom	Description
ApiVersion	Version de l’API.
ComponentDocumentModelDetails	Composant d’un modèle de document composé.
ComposeDocumentModelRequest	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.
ErrorResponse	Objet de réponse d’erreur.
InnerError	Erreur détaillée.

ApiVersion

Version de l’API.

Nom	Type	Description
2022-08-31	string

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	ComponentDocumentModelDetails[]	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	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	Error	Informations d’erreur.

InnerError

Erreur détaillée.

Nom	Type	Description
code	string	Code d’erreur.
innererror	InnerError	Erreur détaillée.
message	string	Message d’erreur.