swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector recognizeText API
schemes:
- https
tags:
- name: recognizeText
paths:
  /recognizeText:
    post:
      description: Recognize Text operation. When you use the Recognize Text interface, the response contains a field called 'Operation-Location'. The 'Operation-Location' field contains the URL that you must use for your Get Handwritten Text Operation Result operation.
      operationId: microsoftAzureRecognizetext
      parameters:
      - $ref: ../../../Common/Parameters.json#/parameters/ImageUrl
      - $ref: '#/parameters/HandwritingBoolean'
      consumes:
      - application/json
      produces:
      - application/json
      responses:
        '202':
          description: The service has accepted the request and will start processing later. It will return Accepted immediately and include an Operation-Location header. Client side should further query the operation status using the URL specified in this header. The operation ID will expire in 48 hours.
          headers:
            Operation-Location:
              description: 'URL to query for status of the operation. The operation ID will expire in 48 hours. '
              type: string
        default:
          description: Error response.
          schema:
            $ref: '#/definitions/ComputerVisionError'
      x-ms-examples:
        Successful Domain Model analysis request:
          $ref: ./examples/SuccessfulRecognizeTextWithUrl.json
      summary: Microsoft Azure Post Recognizetext
      tags:
      - recognizeText
definitions:
  ComputerVisionError:
    type: object
    required:
    - code
    - message
    properties:
      code:
        type: string
        description: The error code.
        enum:
        - InvalidImageUrl
        - InvalidImageFormat
        - InvalidImageSize
        - NotSupportedVisualFeature
        - NotSupportedImage
        - InvalidDetails
        - NotSupportedLanguage
        - BadArgument
        - FailedToProcess
        - Timeout
        - InternalServerError
        - Unspecified
        - StorageException
        x-ms-enum:
          name: ComputerVisionErrorCodes
          modelAsString: false
      message:
        type: string
        description: A message explaining the error reported by the service.
      requestId:
        type: string
        description: A unique request identifier.
parameters:
  HandwritingBoolean:
    name: detectHandwriting
    in: query
    description: If 'true' is specified, handwriting recognition is performed. If this parameter is set to 'false' or is not specified, printed text recognition is performed.
    required: false
    x-ms-parameter-location: method
    type: boolean
    default: false
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'