Microsoft Azure Computer Vision Client

Microsoft Azure Computer Vision Client is a powerful tool that allows users to analyze and extract insights from images and videos. With this client, users can easily detect objects, faces, text, and even landmarks within their visual content. They can also identify and categorize images based on content, as well as analyze image quality and extract text from images.

OpenAPI Specification

computer-vision-client-openapi-original.yml Raw ↑
swagger: '2.0'
info:
  title: Microsoft Azure Computer Vision Client
  description: >-
    The Computer Vision API provides state-of-the-art algorithms to process
    images and return information. For example, it can be used to extract text
    using Read OCR, caption an image using descriptive natural language, detect
    objects, people, and more.
  version: 2023-04-01-preview
paths:
  /imageanalysis:segment:
    post:
      tags:
        - Operations
      summary: >-
        Microsoft Azure Analyze The Input Image The Request Either Contains An Image Stream With Any Content Type [ Image * , Application Octet Stream ], Or A Json Payload Which Includes A Url Property To Be Used To Retrieve The Image Stream An Image Stream Of Content Type Image Png Is Returned, Where The Pixel Values Depend On The Analysis Mode The Returned Image Has The Same Dimensions As The Input Image For Modes: Foregroundmatting The Returned Image Has The Same Aspect Ratio And Same Dimensions As The Input Image Up To A Limit Of 16 Megapixels For Modes: Backgroundremoval
      operationId: microsoftAzureImageanalysisSegment
      consumes:
        - application/json
      produces:
        - image/png
        - application/json
      parameters:
        - in: query
          name: mode
          description: The analysis mode requested.
          type: string
          enum:
            - backgroundRemoval
            - foregroundMatting
          x-ms-enum:
            name: SegmentationMode
            modelAsString: true
        - $ref: '#/parameters/ApiVersion'
        - in: body
          name: body
          description: >-
            A JSON document with a URL pointing to the image that is to be
            analyzed.
          required: true
          schema:
            $ref: '#/definitions/ImageUrl'
      responses:
        '200':
          description: Success
          schema:
            type: file
        default:
          description: Error
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
      x-ms-examples:
        Segment_BackgroundRemoval_FromImageUrl:
          $ref: ./examples/Segment_BackgroundRemoval_FromImageUrl.json
        Segment_ForegroundMatting_FromImageUrl:
          $ref: ./examples/Segment_ForegroundMatting_FromImageUrl.json
      description: Needs a more full description created.
  /retrieval:vectorizeText:
    post:
      tags:
        - ImageRetrieval
      summary: 'Microsoft Azure Return Vector From A Text'
      operationId: microsoftAzureImageretrievalVectorizetext
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - in: query
          name: model-version
          description: Model version.
          type: string
        - $ref: '#/parameters/ApiVersion'
        - in: body
          name: body
          description: Request of VectorizeText.
          schema:
            $ref: '#/definitions/VectorizeTextRequestApiModel'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/SingleVectorResultApiModel'
        default:
          description: Error
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
      x-ms-examples:
        ImageRetrieval_VectorizeText:
          $ref: ./examples/ImageRetrieval_VectorizeText.json
      description: Needs a more full description created.
  /retrieval:vectorizeImage:
    post:
      tags:
        - ImageRetrieval
      summary: 'Microsoft Azure Return Vector From An Image'
      operationId: microsoftAzureImageretrievalVectorizeimage
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - in: query
          name: model-version
          description: Model version.
          type: string
        - $ref: '#/parameters/ApiVersion'
        - in: body
          name: body
          description: >-
            A JSON document with a URL pointing to the image that is to be
            analyzed.
          required: true
          schema:
            $ref: '#/definitions/ImageUrl'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/SingleVectorResultApiModel'
        default:
          description: Error
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
      x-ms-examples:
        ImageRetrieval_VectorizeImage:
          $ref: ./examples/ImageRetrieval_VectorizeImage.json
      description: Needs a more full description created.
  /imagecomposition:stitch:
    post:
      tags:
        - Operations
      summary: 'Microsoft Azure Run The Image Stitching Operation Against A Sequence Of Images'
      operationId: microsoftAzureImagecompositionStitch
      consumes:
        - application/json-patch+json
      produces:
        - image/jpeg
        - application/json
      parameters:
        - $ref: '#/parameters/ApiVersion'
        - in: body
          name: body
          description: Input images urls that pass into image stitching operation.
          required: true
          schema:
            $ref: '#/definitions/ImageStitchingRequestApiModel'
      responses:
        '200':
          description: Success
          schema:
            type: file
        default:
          description: Error
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
      x-ms-examples:
        ImageComposition_Stitch:
          $ref: ./examples/ImageComposition_Stitch.json
      description: Needs a more full description created.
  /imagecomposition:rectify:
    post:
      tags:
        - Operations
      summary: >-
        Microsoft Azure Run The Image Rectification Operation Against An Image With 4 Control Points Provided In The Parameter
      operationId: microsoftAzureImagecompositionRectify
      consumes:
        - application/json-patch+json
      produces:
        - image/jpeg
        - application/json
      parameters:
        - $ref: '#/parameters/ApiVersion'
        - in: body
          name: body
          description: >-
            Input image url and control points that are passed into
            rectification operation.
          required: true
          schema:
            $ref: '#/definitions/ImageRectificationRequestApiModel'
      responses:
        '200':
          description: Success
          schema:
            type: file
        default:
          description: Error
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
      x-ms-examples:
        ImageComposition_Rectify:
          $ref: ./examples/ImageComposition_Rectify.json
      description: Needs a more full description created.
  /planogramcompliance:match:
    post:
      tags:
        - Operations
      summary: >-
        Microsoft Azure Run The Planogram Matching Operation Against A Planogram And A Product Understanding Result
      operationId: microsoftAzurePlanogramcomplianceMatch
      consumes:
        - application/json-patch+json
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/ApiVersion'
        - in: body
          name: body
          description: Input to pass into the planogram matching operation.
          schema:
            $ref: '#/definitions/PlanogramMatchingRequestApiModel'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/PlanogramMatchingResultApiModel'
        default:
          description: Error
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
      x-ms-examples:
        PlanogramCompliance_Match:
          $ref: ./examples/PlanogramCompliance_Match.json
      description: Needs a more full description created.
  /productrecognition/{modelName}/runs/{runName}:
    put:
      tags:
        - Operations
      summary: 'Microsoft Azure Run The Product Recognition Against A Model With An Image'
      operationId: microsoftAzureProductrecognitionCreate
      produces:
        - application/json
      parameters:
        - in: path
          name: modelName
          description: The name of the model to run product recognition with.
          required: true
          type: string
          maxLength: 255
          pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]*$
        - in: path
          name: runName
          description: The name of the product recognition run.
          required: true
          type: string
          maxLength: 255
          pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]*$
        - $ref: '#/parameters/ApiVersion'
      responses:
        '201':
          description: Created
          schema:
            $ref: '#/definitions/ProductRecognitionApiModel'
        default:
          description: Error
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
      x-ms-examples:
        ProductRecognition_Create:
          $ref: ./examples/ProductRecognition_Create.json
      description: Needs a more full description created.
    get:
      tags:
        - Operations
      summary: 'Microsoft Azure Get Information About A Specific Product Recognition Run'
      operationId: microsoftAzureProductrecognitionGet
      produces:
        - application/json
      parameters:
        - in: path
          name: modelName
          description: The name of the model the product recognition run belongs to.
          required: true
          type: string
          maxLength: 255
          pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]*$
        - in: path
          name: runName
          description: The name of the product recognition run.
          required: true
          type: string
          maxLength: 255
          pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]*$
        - $ref: '#/parameters/ApiVersion'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/ProductRecognitionApiModel'
        default:
          description: Error
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
      x-ms-examples:
        ProductRecognition_Get:
          $ref: ./examples/ProductRecognition_Get.json
      description: Needs a more full description created.
    delete:
      tags:
        - Operations
      summary: "Microsoft Azure Delete A Product Recognition Run A Product Recognition Run Can Be Deleted If It Is In The Succeeded Or Failed States \r\n      \r\nstatus Codes Returned:\r\n 204: Operation Completed Successfully \r\n 400: The Request Was Malformed \r\n 404: A Product Recognition Run With The Specified Name Was Not Found"
      operationId: microsoftAzureProductrecognitionDelete
      produces:
        - application/json
      parameters:
        - in: path
          name: modelName
          description: The name of the model to delete the product recognition run for.
          required: true
          type: string
          maxLength: 255
          pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]*$
        - in: path
          name: runName
          description: The name of the product recognition run.
          required: true
          type: string
          maxLength: 255
          pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]*$
        - $ref: '#/parameters/ApiVersion'
      responses:
        '204':
          description: No Content
        default:
          description: Error
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
      x-ms-examples:
        ProductRecognition_Delete:
          $ref: ./examples/ProductRecognition_Delete.json
      description: Needs a more full description created.
  /productrecognition/{modelName}/runs:
    get:
      tags:
        - Operations
      summary: 'Microsoft Azure List All Product Recognition Run Of A Model'
      operationId: microsoftAzureProductrecognitionList
      produces:
        - application/json
      parameters:
        - in: path
          name: modelName
          description: The name of the model the product recognition runs belongs to.
          required: true
          type: string
          maxLength: 255
          pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]*$
        - in: query
          name: skip
          description: Number of product recognition runs to be skipped.
          type: integer
          format: int32
          default: 0
          maximum: 2147483647
          minimum: 0
        - in: query
          name: top
          description: >-
            Number of product recognition runs to be returned after skipping.
            The maximum allowed value is 30.
          type: integer
          format: int32
          default: 10
          maximum: 30
          minimum: 1
        - $ref: '#/parameters/ApiVersion'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/ProductRecognitionApiModelCollectionApiModel'
        default:
          description: Error
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        ProductRecognition_List:
          $ref: ./examples/ProductRecognition_List.json
      description: Needs a more full description created.
  /imageanalysis:analyze:
    post:
      tags:
        - Operations
      summary: >-
        Microsoft Azure Analyze The Input Image The Request Either Contains Image Stream With Any Content Type [ Image * , Application Octet Stream ], Or A Json Payload Which Includes An Url Property To Be Used To Retrieve The Image Stream
      operationId: microsoftAzureImageanalysisAnalyze
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - in: query
          name: features
          description: >-
            The visual features requested: tags, objects, caption,
            denseCaptions, read, smartCrops, people. This parameter needs to be
            specified if the parameter "model-name" is not specified.
          type: array
          items:
            enum:
              - tags
              - caption
              - denseCaptions
              - objects
              - read
              - smartCrops
              - people
            type: string
            x-ms-enum:
              name: VisualFeature
              modelAsString: true
          collectionFormat: csv
        - in: query
          name: model-name
          description: >-
            The name of the custom trained model. This parameter needs to be
            specified if the parameter "features" is not specified.
          type: string
        - in: query
          name: language
          description: >-
            The desired language for output generation. If this parameter is not
            specified, the default value is "en". See
            https://aka.ms/cv-languages for a list of supported languages.
          type: string
          default: en
        - in: query
          name: smartcrops-aspect-ratios
          description: >-
            A list of aspect ratios to use for smartCrops feature. Aspect ratios
            are calculated by dividing the target crop width by the height.
            Supported values are between 0.75 and 1.8 (inclusive). Multiple
            values should be comma-separated. If this parameter is not
            specified, the service will return one crop suggestion with an
            aspect ratio it sees fit between 0.5 and 2.0 (inclusive).
          type: string
        - in: query
          name: gender-neutral-caption
          description: >-
            Boolean flag for enabling gender-neutral captioning for caption and
            denseCaptions features. If this parameter is not specified, the
            default value is "false".
          type: boolean
          default: false
        - $ref: '#/parameters/ApiVersion'
        - in: body
          name: body
          description: >-
            A JSON document with a URL pointing to the image that is to be
            analyzed.
          required: true
          schema:
            $ref: '#/definitions/ImageUrl'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/ImageAnalysisResult'
        default:
          description: Error
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
      x-ms-examples:
        AnalyzeImage_CustomModel:
          $ref: ./examples/AnalyzeImage_CustomModel.json
      description: Needs a more full description created.
  /datasets/{name}:
    put:
      tags:
        - Datasets
      summary: "Microsoft Azure Register A New Dataset \r\n      \r\nstatus Codes Returned:\r\n 201: Operation Completed Successfully \r\n 400: The Request Was Malformed \r\n 409: A Dataset With The Specified Name Already Exists"
      operationId: microsoftAzureDatasetsRegister
      consumes:
        - application/json-patch+json
      produces:
        - application/json
      parameters:
        - in: path
          name: name
          description: >-
            A name that can be used to uniquely identify the dataset after it
            has been registered.
          required: true
          type: string
          maxLength: 255
          pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]*$
        - $ref: '#/parameters/ApiVersion'
        - in: body
          name: body
          description: >-
            Properties for the dataset, such as the list of URIs to the
            annotation files.
          required: true
          schema:
            $ref: '#/definitions/Dataset'
      responses:
        '201':
          description: Created
          schema:
            $ref: '#/definitions/Dataset'
        default:
          description: Error
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
      x-ms-examples:
        RegisterDataset_ImageClassification:
          $ref: ./examples/RegisterDataset_ImageClassification.json
      description: Needs a more full description created.
    get:
      tags:
        - Datasets
      summary: "Microsoft Azure Get Information About A Specific Dataset \r\n      \r\nstatus Codes Returned:\r\n 200: Operation Completed Successfully \r\n 400: The Request Was Malformed \r\n 404: A Dataset With The Specified Name Was Not Found"
      operationId: microsoftAzureDatasetsGet
      produces:
        - application/json
      parameters:
        - in: path
          name: name
          description: The name of the dataset to get.
          required: true
          type: string
          maxLength: 255
          pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]*$
        - $ref: '#/parameters/ApiVersion'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/Dataset'
        default:
          description: Error
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
      x-ms-examples:
        Datasets_Get:
          $ref: ./examples/Datasets_Get.json
      description: Needs a more full description created.
    patch:
      tags:
        - Datasets
      summary: "Microsoft Azure Update The Properties Of An Existing Dataset \r\n      \r\nstatus Codes Returned:\r\n 200: Operation Completed Successfully \r\n 400: The Request Was Malformed \r\n 404: A Dataset With The Specified Name Was Not Found \r\n 412: An If Match Header Was Provided, But The Given Etag Did Not Match The Current Etag Value"
      operationId: microsoftAzureDatasetsUpdate
      consumes:
        - application/json-patch+json
      produces:
        - application/json
      parameters:
        - in: path
          name: name
          description: The name of the dataset to update.
          required: true
          type: string
          maxLength: 255
          pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]*$
        - in: header
          name: If-Match
          description: "Optional ETag for the dataset to update.<br />\r\nIf an ETag is provided, then the dataset will be updated only if its current ETag value matches the given ETag.\r\nIf the ETag values don't match, then the update operation will fail with status code 412 (Precondition Failed).\r\nThis indicates that the dataset has been updated since the last time information for the dataset was obtained.<br />\r\nIf an ETag is not provided or its value is '*', then the dataset will always be updated regardless of the current ETag value."
          type: string
        - $ref: '#/parameters/ApiVersion'
        - in: body
          name: body
          description: Properties to update on the existing dataset.
          required: true
          schema:
            $ref: '#/definitions/Dataset'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/Dataset'
        default:
          description: Error
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
      x-ms-examples:
        Datasets_Update:
          $ref: ./examples/Datasets_Update.json
      description: Needs a more full description created.
    delete:
      tags:
        - Datasets
      summary: "Microsoft Azure Unregister A Dataset \r\n      \r\nstatus Codes Returned:\r\n 204: Operation Completed Successfully \r\n 400: The Request Was Malformed \r\n 404: A Dataset With The Specified Name Was Not Found \r\n 412: An If Match Header Was Provided, But The Given Etag Did Not Match The Current Etag Value"
      operationId: microsoftAzureDatasetsUnregister
      produces:
        - application/json
      parameters:
        - in: path
          name: name
          description: The name of the dataset to unregister.
          required: true
          type: string
          maxLength: 255
          pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]*$
        - in: header
          name: If-Match
          description: "Optional ETag for the dataset to unregister.<br />\r\nIf an ETag is provided, then the dataset will be unregistered only if its current ETag value matches the given ETag.\r\nIf the ETag values don't match, then the unregister operation will fail with status code 412 (Precondition Failed).\r\nThis indicates that the dataset has been updated since the last time information for the dataset was obtained.<br />\r\nIf an ETag is not provided or its value is '*', then the dataset will always be unregistered regardless of the current ETag value."
          type: string
        - $ref: '#/parameters/ApiVersion'
      responses:
        '204':
          description: No Content
        default:
          description: Error
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
      x-ms-examples:
        Datasets_Unregister:
          $ref: ./examples/Datasets_Unregister.json
      description: Needs a more full description created.
  /datasets:
    get:
      tags:
        - Datasets
      summary: "Microsoft Azure Get A List Of Datasets That Have Been Registered \r\n      \r\nstatus Codes Returned:\r\n 200: Operation Completed Successfully \r\n 400: The Request Was Malformed"
      operationId: microsoftAzureDatasetsList
      produces:
        - application/json
      parameters:
        - in: query
          name: skip
          description: Number of datasets to be skipped.
          type: integer
          format: int32
          default: 0
          maximum: 2147483647
          minimum: 0
        - in: query
          name: top
          description: >-
            Number of datasets to be returned after skipping. The maximum
            allowed value is 30.
          type: integer
          format: int32
          default: 10
          maximum: 30
          minimum: 1
        - $ref: '#/parameters/ApiVersion'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/DatasetApiModelCollectionApiModel'
        default:
          description: Error
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
      x-ms-examples:
        Datasets_List:
          $ref: ./examples/Datasets_List.json
      x-ms-pageable:
        nextLinkName: nextLink
      description: Needs a more full description created.
  /models/{name}:
    put:
      tags:
        - Models
      summary: "Microsoft Azure Start Training A Custom Model \r\n      \r\nstatus Codes Returned:\r\n 201: Operation Completed Successfully \r\n 400: The Request Was Malformed \r\n 409: A Model With The Specified Name Already Exists"
      operationId: microsoftAzureModelsCreate
      consumes:
        - application/json-patch+json
      produces:
        - application/json
      parameters:
        - in: path
          name: name
          description: >-
            A name that can be used to uniquely identify the model after it has
            been created.
          required: true
          type: string
          maxLength: 255
          pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]*$
        - $ref: '#/parameters/ApiVersion'
        - in: body
          name: body
          description: >-
            Properties for the model, such as the name of the dataset to use to
            train the model.
          required: true
          schema:
            $ref: '#/definitions/Model'
      responses:
        '201':
          description: Created
          schema:
            $ref: '#/definitions/Model'
        default:
          description: Error
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
      x-ms-examples:
        Models_Create:
          $ref: ./examples/Models_Create.json
      description: Needs a more full description created.
    get:
      tags:
        - Models
      summary: "Microsoft Azure Get Information About A Specific Model \r\n      \r\nstatus Codes Returned:\r\n 200: Operation Completed Successfully \r\n 400: The Request Was Malformed \r\n 404: A Model With The Specified Name Was Not Found"
      operationId: microsoftAzureModelsGet
      produces:
        - application/json
      parameters:
        - in: path
          name: name
          description: The name of the model to get.
          required: true
          type: string
          maxLength: 255
          pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]*$
        - $ref: '#/parameters/ApiVersion'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/Model'
        default:
          description: Error
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
      x-ms-examples:
        Models_Get:
          $ref: ./examples/Models_Get.json
      description: Needs a more full description created.
    delete:
      tags:
        - Models
      summary: "Microsoft Azure Delete A Custom Model A Model Can Be Deleted If It Is In One Of The Succeeded , Failed , Or Canceled States \r\nif A Model Is In The Notstarted Or Training State, Cancel Training And Wait For Cancellation To Finish Before Deleting The Model \r\n      \r\nstatus Codes Returned:\r\n 204: Operation Completed Successfully \r\n 400: The Request Was Malformed \r\n 404: A Model With The Specified Name Was Not Found"
      operationId: microsoftAzureModelsDelete
      produces:
        - application/json
      parameters:
        - in: path
          name: name
          description: The name of the model to delete.
          required: true
          type: string
          maxLength: 255
          pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]*$
        - $ref: '#/parameters/ApiVersion'
      responses:
        '204':
          description: No Content
        default:
          description: Error
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
      x-ms-examples:
        Models_Delete:
          $ref: ./examples/Models_Delete.json
      description: Needs a more full description created.
  /models:
    get:
      tags:
        - Models
      summary: "Microsoft Azure Get A List Of The Available Models \r\n      \r\nstatus Codes Returned:\r\n 200: Operation Completed Successfully \r\n 400: The Request Was Malformed"
      operationId: microsoftAzureModelsList
      produces:
        - application/json
      parameters:
        - in: query
          name: skip
          description: Number of models to be skipped.
          type: integer
          format: int32
          default: 0
          maximum: 2147483647
          minimum: 0
        - in: query
          name: top
          description: >-
            Number of models to be returned after skipping. The maximum allowed
            value is 30.
          type: integer
          format: int32
          default: 10
          maximum: 30
          minimum: 1
        - $ref: '#/parameters/ApiVersion'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/ModelApiModelCollectionApiModel'
        default:
          description: Error
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
      x-ms-examples:
        Models_List:
          $ref: ./examples/Models_List.json
      x-ms-pageable:
        nextLinkName: nextLink
      description: Needs a more full description created.
  /models/{name}:cancel:
    post:
      tags:
        - Models
      summary: "Microsoft Azure Cancel Model Training \r\n      \r\nstatus Codes Returned:\r\n 202: Operation Completed Successfully \r\n 400: The Request Was Malformed \r\n 404: A Model With The Specified Name Was Not Found"
      operationId: microsoftAzureModelsCanceltraining
      produces:
        - application/json
      parameters:
        - in: path
          name: name
          description: The name of the model to cancel training.
          required: true
          type: string
          maxLength: 255
          pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]*$
        - $ref: '#/parameters/ApiVersion'
      responses:
        '202':
          description: Accepted
        default:
          description: Error
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
      x-ms-examples:
        Models_CancelTraining:
          $ref: ./examples/Models_CancelTraining.json
      description: Needs a more full description created.
  /models/{name}/evaluations/{evaluationName}:
    put:
      tags:
        - Models
      summary: "Microsoft Azure Evaluate An Existing Model \r\n      \r\nstatus Codes Returned:\r\n 201: Operation Completed Successfully \r\n 400: The Request Was Malformed \r\n 409: An Evaluation With The Specified Name Already Exists"
      operationId: microsoftAzureModelevaluationsCreate
      consumes:
        - application/json-patch+json
      produces:
        - application/json
      parameters:
        - in: path
          name: name
          description: The name of the model to evaluate.
          required: true
          type: string
          maxLength: 255
          pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]*$
        - in: path
          name: evaluationName
          description: >-
            A name that can be used to uniquely identify the evaluation after it
            has been created.
          required: true
          type: string
          maxLength: 255
          pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]*$
        - $ref: '#/parameters/ApiVersion'
        - in: body
          name: body
          description: >-
            Properties for the evaluation,

# --- truncated at 32 KB (78 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/computer-vision-client-openapi-original.yml