@lap v0.3
# Machine-readable API spec. Each @endpoint block is one API call.
@api Form Recognizer Client
@version 2.0-preview
@auth ApiKey Ocp-Apim-Subscription-Key in header
@endpoints 12
@toc custom(8), prebuilt(2), layout(2)

@group custom
@endpoint POST /custom/models
@required {trainRequest: map}
@returns(201)

@endpoint GET /custom/models/{modelId}
@required {modelId: any}
@optional {includeKeys: any}
@returns(200)

@endpoint DELETE /custom/models/{modelId}
@required {modelId: any}
@returns(204)

@endpoint POST /custom/models/{modelId}/analyze
@required {modelId: any}
@optional {includeTextDetails: any, fileStream: map}
@returns(202)

@endpoint GET /custom/models/{modelId}/analyzeResults/{resultId}
@required {modelId: any, resultId: any}
@returns(200)

@endpoint POST /custom/models/{modelId}/copy
@required {modelId: any, copyRequest: map}
@returns(202)

@endpoint GET /custom/models/{modelId}/copyResults/{resultId}
@required {modelId: any, resultId: any}
@returns(200)

@endpoint POST /custom/models/copyAuthorization
@returns(201)

@endgroup

@group prebuilt
@endpoint POST /prebuilt/receipt/analyze
@optional {includeTextDetails: any, fileStream: map}
@returns(202)

@endpoint GET /prebuilt/receipt/analyzeResults/{resultId}
@required {resultId: any}
@returns(200)

@endgroup

@group layout
@endpoint POST /layout/analyze
@optional {fileStream: map}
@returns(202)

@endpoint GET /layout/analyzeResults/{resultId}
@required {resultId: any}
@returns(200)

@endgroup

@end