Microsoft Azure · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Microsoft Azure Form Recognizer Client Prebuilt API

9 actions 9 updates phrasing extends openapi/microsoft-azure-prebuilt-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Microsoft Azure's API. It is a proposal applied on top of the contract, not a document Microsoft Azure publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 9

$.info
$.paths['/prebuilt/businessCard/analyze'].post
$.paths['/prebuilt/businessCard/analyzeResults/{resultId}'].get
$.paths['/prebuilt/invoice/analyze'].post
$.paths['/prebuilt/invoice/analyzeResults/{resultId}'].get
$.paths['/prebuilt/idDocument/analyze'].post
$.paths['/prebuilt/idDocument/analyzeResults/{resultId}'].get
$.paths['/prebuilt/receipt/analyze'].post
$.paths['/prebuilt/receipt/analyzeResults/{resultId}'].get

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Microsoft Azure Form Recognizer Client Prebuilt API
  version: 1.0.0
extends: openapi/microsoft-azure-prebuilt-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 8
- target: $.paths['/prebuilt/businessCard/analyze'].post
  update:
    x-apievangelist-phrasing:
      intent: Extract contact details from a business card
      effect: write
      questions:
      - How do I pull names, phone numbers and emails off a scanned business card?
      - Which file types can I send for business card extraction?
      instructions:
      - text: 'Extract the contact fields from this business card: {file}.'
        slots:
          file: body.fileStream
      - text: Analyze business card {file} in locale {locale} and include the raw text lines.
        slots:
          file: body.fileStream
          locale: query.locale
      method: generated
      generated: '2026-09-26'
- target: $.paths['/prebuilt/businessCard/analyzeResults/{resultId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the result of a business card analysis
      effect: read
      questions:
      - Is my business card extraction done yet?
      - Where do I collect the extracted business card fields?
      instructions:
      - text: Get the business card analysis result {resultId}.
        slots:
          resultId: path.resultId
      - text: Check whether business card job {resultId} has finished and show the contact fields.
        slots:
          resultId: path.resultId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/prebuilt/invoice/analyze'].post
  update:
    x-apievangelist-phrasing:
      intent: Extract fields from an invoice
      effect: write
      questions:
      - Can I automatically pull the field values out of an invoice PDF?
      - Is it possible to analyze only certain pages of a long invoice?
      instructions:
      - text: Extract the fields from invoice {file}.
        slots:
          file: body.fileStream
      - text: Analyze pages {pages} of invoice {file}.
        slots:
          pages: query.pages
          file: body.fileStream
      method: generated
      generated: '2026-09-26'
- target: $.paths['/prebuilt/invoice/analyzeResults/{resultId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the result of an invoice analysis
      effect: read
      questions:
      - Has my invoice extraction finished?
      - Where can I retrieve the values read from an invoice I submitted?
      instructions:
      - text: Get invoice analysis result {resultId}.
        slots:
          resultId: path.resultId
      - text: Poll invoice job {resultId} and show the extracted fields when it is done.
        slots:
          resultId: path.resultId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/prebuilt/idDocument/analyze'].post
  update:
    x-apievangelist-phrasing:
      intent: Extract fields from an ID document
      effect: write
      questions:
      - Can I read the name and date of birth from a photo of a passport or driver's license?
      - What image formats does ID document extraction accept?
      instructions:
      - text: Extract the identity fields from ID document {file}.
        slots:
          file: body.fileStream
      - text: Analyze the ID scan {file} and include the full text details ({include_text}).
        slots:
          file: body.fileStream
          include_text: query.includeTextDetails
      method: generated
      generated: '2026-09-26'
- target: $.paths['/prebuilt/idDocument/analyzeResults/{resultId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the result of an ID document analysis
      effect: read
      questions:
      - Is the ID document I submitted done processing?
      - Where do I fetch the fields read from a passport or license scan?
      instructions:
      - text: Get ID document analysis result {resultId}.
        slots:
          resultId: path.resultId
      - text: Check ID scan job {resultId} and show the identity fields.
        slots:
          resultId: path.resultId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/prebuilt/receipt/analyze'].post
  update:
    x-apievangelist-phrasing:
      intent: Extract fields from a receipt
      effect: write
      questions:
      - How do I read merchant, date and total from a photo of a receipt?
      - Can receipt extraction handle receipts in a specific locale?
      instructions:
      - text: Extract the merchant and totals from receipt {file}.
        slots:
          file: body.fileStream
      - text: Analyze receipt {file} using locale {locale}.
        slots:
          file: body.fileStream
          locale: query.locale
      method: generated
      generated: '2026-09-26'
- target: $.paths['/prebuilt/receipt/analyzeResults/{resultId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the result of a receipt analysis
      effect: read
      questions:
      - Has my receipt finished processing?
      - Where do I pick up the line items read from a receipt?
      instructions:
      - text: Get receipt analysis result {resultId}.
        slots:
          resultId: path.resultId
      - text: Poll receipt job {resultId} and show the merchant and total.
        slots:
          resultId: path.resultId
      method: generated
      generated: '2026-09-26'

Work with this as data

Every overlay here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for openapi overlays

4 MCP tools reach this
  • find_overlaysBrowse and filter every overlay in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This overlay
curl "https://apis.io/api/v1/overlays/microsoft-azure-prebuilt-api-phrasing-overlay"
All openapi overlays
curl "https://apis.io/api/v1/overlays?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.