Custom Models - Compose

Service:

Azure AI Services

API Version:

2.1

Compose request would include list of models ids. It would validate what all models either trained with labels model or composed model. It would validate limit of models put together.

POST {endpoint}/formrecognizer/v2.1/custom/models/compose

URI Parameters

Name	In	Required	Type	Description
endpoint	path	True	string	Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus2.api.cognitive.microsoft.com).

Request Header

Name	Required	Type	Description
Ocp-Apim-Subscription-Key	True	string

Request Body

Name	Required	Type	Description
modelIds	True	string[]	List of model ids to compose.
modelName		string	Optional user defined model name (max length: 1024).

Responses

Name	Type	Description
201 Created		Request is queued successfully. Media Types: "application/json", "text/json" Headers Location: string
Other Status Codes	ErrorResponse	Response entity accompanying non-successful responses containing additional details about the error. Media Types: "application/json", "text/json"

Security

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Examples

Compose custom models

Sample request

HTTP

POST {endpoint}/formrecognizer/v2.1/custom/models/compose


{
  "modelIds": [
    "4afb20d6-3ed0-4cde-ba40-dbd6207268dd",
    "6f841356-aa32-42c9-a739-2182c47b79c9"
  ]
}

Sample response

Status code:

201

Location: {endpoint}/formrecognizer/v2.1/custom/models/f973e3c1-1148-43bb-bea8-49d0603ab3a8

Definitions

Name	Description
ComposeRequest	Request contract for compose operation.
ErrorInformation
ErrorResponse

ComposeRequest

Request contract for compose operation.

Name	Type	Description
modelIds	string[]	List of model ids to compose.
modelName	string	Optional user defined model name (max length: 1024).

ErrorInformation

Name	Type	Description
code	string
message	string

ErrorResponse

Name	Type	Description
error	ErrorInformation