Document Models - Compose Model

Service:

Azure AI Services

API Version:

2024-02-29-preview

Crée un modèle de document à partir de types de documents de modèles de documents existants.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
endpoint	path	True	string	Point de terminaison du service Document Intelligence.
api-version	query	True	string	Version de l’API à utiliser pour cette opération.

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 a été acceptée pour traitement, mais le traitement n’est pas encore terminé. Headers Operation-Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Réponse d’erreur inattendue.

Sécurité

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

Nom	Description
https://cognitiveservices.azure.com/.default

Exemples

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

Définitions

Nom	Description
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	Objet error.
ErrorResponse	Objet de réponse d’erreur.
InnerError	Objet contenant des informations plus spécifiques sur l’erreur.

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

Objet error.

Nom	Type	Description
code	string	Un des ensembles de codes d’erreur définis par le serveur.
details	Error[]	Tableau de détails sur les erreurs spécifiques qui ont conduit à cette erreur signalée.
innererror	InnerError	Objet contenant des informations plus spécifiques que l’objet actuel sur l’erreur.
message	string	Représentation lisible de l’erreur.
target	string	Cible de l’erreur.

ErrorResponse

Objet de réponse d’erreur.

Nom	Type	Description
error	Error	Informations sur l’erreur.

InnerError

Objet contenant des informations plus spécifiques sur l’erreur.

Nom	Type	Description
code	string	Un des ensembles de codes d’erreur définis par le serveur.
innererror	InnerError	Erreur interne.
message	string	Représentation lisible de l’erreur.