swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector textOperations API
schemes:
- https
tags:
- name: textOperations
paths:
  /textOperations/{operationId}:
    get:
      description: This interface is used for getting text operation result. The URL to this interface should be retrieved from 'Operation-Location' field returned from Recognize Text interface.
      operationId: microsoftAzureGettextoperationresult
      parameters:
      - name: operationId
        in: path
        description: Id of the text operation returned in the response of the 'Recognize Handwritten Text'
        required: true
        type: string
      produces:
      - application/json
      responses:
        '200':
          description: Returns the operation status.
          schema:
            $ref: '#/definitions/TextOperationResult'
        default:
          description: Error response.
          schema:
            $ref: '#/definitions/ComputerVisionError'
      x-ms-examples:
        Successful Domain Model analysis request:
          $ref: ./examples/SuccessfulGetTextOperationResult.json
      summary: Microsoft Azure Get Textoperations Operationid
      tags:
      - textOperations
definitions:
  TextOperationResult:
    type: object
    properties:
      status:
        type: string
        description: Status of the text operation.
        enum:
        - Not Started
        - Running
        - Failed
        - Succeeded
        x-ms-enum:
          name: TextOperationStatusCodes
          modelAsString: false
        x-nullable: false
      recognitionResult:
        $ref: '#/definitions/RecognitionResult'
  Line:
    type: object
    properties:
      boundingBox:
        $ref: '#/definitions/BoundingBox'
      text:
        type: string
      words:
        type: array
        items:
          $ref: '#/definitions/Word'
  RecognitionResult:
    type: object
    properties:
      lines:
        type: array
        items:
          $ref: '#/definitions/Line'
  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.
  Word:
    type: object
    properties:
      boundingBox:
        $ref: '#/definitions/BoundingBox'
      text:
        type: string
  BoundingBox:
    type: array
    items:
      type: integer
      x-nullable: false
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'