Azure AI Services: Form Recognizer
Extracts information from forms and images into structured data.
AI & machine learning#openapi#cloud
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Extracts information from forms and images into structured data.
Endpoints 19
- POSTCustomModels_Train
/custom/modelsCreate and train a custom model. The request must include a source parameter that is either an externally accessible Azure storage blob container Uri… - GETCustomModels_Get
/custom/models/:modelId?includeKeys=falseGet detailed information about a custom model. - DELETECustomModels_Delete
/custom/models/:modelIdMark model for deletion. Model artifacts will be permanently removed within a predetermined period. - POSTCustomModels_AnalyzeDocument
/custom/models/:modelId/analyze?includeTextDetails=false&pages=stringExtract key-value pairs, tables, and semantic values from a given document. The input document must be of one of the supported content types -… - GETCustomModels_GetAnalyzeResult
/custom/models/:modelId/analyzeResults/:resultIdObtain current status and the result of the analyze form operation. - POSTCustomModels_Copy
/custom/models/:modelId/copyCopy custom model stored in this resource (the source) to user specified target Form Recognizer resource. - GETCustomModels_GetCopyResult
/custom/models/:modelId/copyResults/:resultIdObtain current status and the result of a custom model copy operation. - POSTCustomModels_AuthorizeModelCopy
/custom/models/copyAuthorizationGenerate authorization to copy a model into the target Form Recognizer resource. - POSTCustomModels_Compose
/custom/models/composeCompose request would include list of models ids. It would validate what all models either trained with labels model or composed model. It would validate… - POSTAnalyzer_AnalyzeBusinessCard
/prebuilt/businessCard/analyze?includeTextDetails=false&locale=en-AU&pages=stringExtract field text and semantic values from a given business card document. The input document must be of one of the supported content types -… - GETAnalyzer_GetAnalyzeBusinessCardResult
/prebuilt/businessCard/analyzeResults/:resultIdTrack the progress and obtain the result of the analyze business card operation. - POSTAnalyzer_AnalyzeInvoice
/prebuilt/invoice/analyze?includeTextDetails=false&locale=en-AU&pages=stringExtract field text and semantic values from a given invoice document. The input document must be of one of the supported content types - 'application/pdf',… - GETAnalyzer_GetAnalyzeInvoiceResult
/prebuilt/invoice/analyzeResults/:resultIdTrack the progress and obtain the result of the analyze invoice operation. - POSTAnalyzer_AnalyzeIdDocument
/prebuilt/idDocument/analyze?includeTextDetails=false&pages=stringExtract field text and semantic values from a given ID document. The input document must be of one of the supported content types - 'application/pdf',… - GETAnalyzer_GetAnalyzeIdDocumentResult
/prebuilt/idDocument/analyzeResults/:resultIdTrack the progress and obtain the result of the analyze ID operation. - POSTAnalyzer_AnalyzeReceipt
/prebuilt/receipt/analyze?includeTextDetails=false&locale=en-AU&pages=stringExtract field text and semantic values from a given receipt document. The input document must be of one of the supported content types - 'application/pdf',… - GETAnalyzer_GetAnalyzeReceiptResult
/prebuilt/receipt/analyzeResults/:resultIdTrack the progress and obtain the result of the analyze receipt operation. - POSTAnalyzer_AnalyzeLayout
/layout/analyze?pages=string&language=af&readingOrder=basicExtract text and layout information from a given document. The input document must be of one of the supported content types - 'application/pdf', 'image/jpeg',… - GETAnalyzer_GetAnalyzeLayoutResult
/layout/analyzeResults/:resultIdTrack the progress and obtain the result of the analyze layout operation
API details
- Authentication
- An API key in the Ocp-Apim-Subscription-Key header
- Operations
- 19 operations on 18 pathsPOST 10GET 8DELETE 1
- Description format
- Swagger 2.0, API version
2.1 - Links
- OpenAPI document
How to test the Azure AI Services: Form Recognizer in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Azure AI Services: Form Recognizer collection, without the publisher's secrets.
- Add your credentialsThis API uses an API key in the Ocp-Apim-Subscription-Key header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “CustomModels_Train” (POST /custom/models), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Azure AI Services: Form Recognizer?
Extracts information from forms and images into structured data. It is listed under AI & machine learning and has 19 endpoints.
Who publishes the Azure AI Services: Form Recognizer?
It is listed from Microsoft Azure's public API description (an OpenAPI document), not published by Microsoft Azure on Swastik Codes. Anyone who controls azure.com can claim the profile by adding a DNS TXT record.
How do I authenticate with the Azure AI Services: Form Recognizer?
With an API key in the Ocp-Apim-Subscription-Key header.
How many endpoints does the Azure AI Services: Form Recognizer have?
19 operations on 18 paths (10 POST, 8 GET, 1 DELETE).
Is forking the Azure AI Services: Form Recognizer free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.