openapi: 3.2.0
info:
  title: Microsoft Azure Project API
  version: '1.0'
  description: 'Operations tagged ProjectApi across 2 of this provider''s published API definitions: custom-vision-training-client-openapi-original.yml, trainingapi-openapi-original.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://southcentralus.api.cognitive.microsoft.com/customvision/v3.3/training
- url: https://southcentralus.api.cognitive.microsoft.com/customvision/v2.1/Training
tags:
- name: Project API
paths:
  /projects:
    get:
      tags:
      - Project API
      summary: Microsoft Azure Get Your Projects
      operationId: microsoftAzureGetprojects
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Project'
            application/xml:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Project'
            text/xml:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Project'
        default:
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomVisionError'
            application/xml:
              schema:
                $ref: '#/components/schemas/CustomVisionError'
            text/xml:
              schema:
                $ref: '#/components/schemas/CustomVisionError'
      x-ms-examples:
        Successful GetProjects request:
          $ref: ./examples/GetProjects.json
      description: Needs a more full description created.
      security:
      - apim_key: []
    post:
      tags:
      - Project API
      summary: Microsoft Azure Create A Project
      operationId: microsoftAzureCreateproject
      parameters:
      - name: name
        in: query
        description: Name of the project.
        required: true
        schema:
          type: string
      - name: description
        in: query
        description: The description of the project.
        required: false
        schema:
          type: string
      - name: domainId
        in: query
        description: The id of the domain to use for this project. Defaults to General.
        required: false
        schema:
          type: string
          format: uuid
      - name: classificationType
        in: query
        description: The type of classifier to create for this project.
        required: false
        schema:
          type: string
          enum:
          - Multiclass
          - Multilabel
      - name: targetExportPlatforms
        in: query
        description: List of platforms the trained model is intending exporting to.
        required: false
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
            enum:
            - CoreML
            - TensorFlow
            - DockerFile
            - ONNX
            - VAIDK
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Project'
            application/xml:
              schema:
                $ref: '#/components/schemas/Project'
            text/xml:
              schema:
                $ref: '#/components/schemas/Project'
        default:
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomVisionError'
            application/xml:
              schema:
                $ref: '#/components/schemas/CustomVisionError'
            text/xml:
              schema:
                $ref: '#/components/schemas/CustomVisionError'
      x-ms-examples:
        Successful CreateProject request:
          $ref: ./examples/CreateProject.json
      description: Needs a more full description created.
      security:
      - apim_key: []
    servers:
    - url: https://southcentralus.api.cognitive.microsoft.com/customvision/v3.3/training
  /projects/{projectId}:
    get:
      tags:
      - Project API
      summary: Microsoft Azure Get A Specific Project
      operationId: microsoftAzureGetproject
      parameters:
      - name: projectId
        in: path
        description: The id of the project to get.
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Project'
            application/xml:
              schema:
                $ref: '#/components/schemas/Project'
            text/xml:
              schema:
                $ref: '#/components/schemas/Project'
        default:
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomVisionError'
            application/xml:
              schema:
                $ref: '#/components/schemas/CustomVisionError'
            text/xml:
              schema:
                $ref: '#/components/schemas/CustomVisionError'
      x-ms-examples:
        Successful GetProject request:
          $ref: ./examples/GetProject.json
      description: Needs a more full description created.
      security:
      - apim_key: []
    delete:
      tags:
      - Project API
      summary: Microsoft Azure Delete A Specific Project
      operationId: microsoftAzureDeleteproject
      parameters:
      - name: projectId
        in: path
        description: The project id.
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '204':
          description: No Content
        default:
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomVisionError'
      x-ms-examples:
        Successful DeleteProject request:
          $ref: ./examples/DeleteProject.json
      description: Needs a more full description created.
      security:
      - apim_key: []
    patch:
      tags:
      - Project API
      summary: Microsoft Azure Update A Specific Project
      operationId: microsoftAzureUpdateproject
      parameters:
      - name: projectId
        in: path
        description: The id of the project to update.
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Project'
            application/xml:
              schema:
                $ref: '#/components/schemas/Project'
            text/xml:
              schema:
                $ref: '#/components/schemas/Project'
        default:
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomVisionError'
            application/xml:
              schema:
                $ref: '#/components/schemas/CustomVisionError'
            text/xml:
              schema:
                $ref: '#/components/schemas/CustomVisionError'
      x-ms-examples:
        Successful UpdateProject request:
          $ref: ./examples/UpdateProject.json
      description: Needs a more full description created.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Project'
          application/xml:
            schema:
              $ref: '#/components/schemas/Project'
          text/xml:
            schema:
              $ref: '#/components/schemas/Project'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Project'
        description: The updated project model.
        required: true
      security:
      - apim_key: []
    servers:
    - url: https://southcentralus.api.cognitive.microsoft.com/customvision/v3.3/training
  /projects/{projectId}/artifacts:
    get:
      tags:
      - Project API
      summary: Microsoft Azure Get Artifact Content From Blob Storage, Based On Artifact…
      operationId: microsoftAzureGetartifact
      parameters:
      - name: projectId
        in: path
        description: The project id.
        required: true
        schema:
          type: string
          format: uuid
      - name: path
        in: query
        description: The relative path for artifact.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary
        default:
          description: Error response
          content:
            application/octet-stream:
              schema:
                $ref: '#/components/schemas/CustomVisionError'
      x-ms-examples:
        Successful GetArtifact request:
          $ref: ./examples/GetArtifact.json
      description: Needs a more full description created.
      security:
      - apim_key: []
    servers:
    - url: https://southcentralus.api.cognitive.microsoft.com/customvision/v3.3/training
  /projects/{projectId}/export:
    get:
      tags:
      - Project API
      summary: Microsoft Azure Exports A Project
      operationId: microsoftAzureExportproject
      parameters:
      - name: projectId
        in: path
        description: The project id of the project to export.
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectExport'
            application/xml:
              schema:
                $ref: '#/components/schemas/ProjectExport'
            text/xml:
              schema:
                $ref: '#/components/schemas/ProjectExport'
        default:
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomVisionError'
            application/xml:
              schema:
                $ref: '#/components/schemas/CustomVisionError'
            text/xml:
              schema:
                $ref: '#/components/schemas/CustomVisionError'
      x-ms-examples:
        Successful ExportProject request:
          $ref: ./examples/ExportProject.json
      description: Needs a more full description created.
      security:
      - apim_key: []
    servers:
    - url: https://southcentralus.api.cognitive.microsoft.com/customvision/v3.3/training
  /projects/{projectId}/iterations:
    get:
      tags:
      - Project API
      summary: Microsoft Azure Get Iterations For The Project
      operationId: microsoftAzureGetiterations
      parameters:
      - name: projectId
        in: path
        description: The project id.
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Iteration'
            application/xml:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Iteration'
            text/xml:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Iteration'
        default:
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomVisionError'
            application/xml:
              schema:
                $ref: '#/components/schemas/CustomVisionError'
            text/xml:
              schema:
                $ref: '#/components/schemas/CustomVisionError'
      x-ms-examples:
        Successful GetIterations request:
          $ref: ./examples/GetIterations.json
      description: Needs a more full description created.
      security:
      - apim_key: []
    servers:
    - url: https://southcentralus.api.cognitive.microsoft.com/customvision/v3.3/training
  /projects/{projectId}/iterations/{iterationId}:
    get:
      tags:
      - Project API
      summary: Microsoft Azure Get A Specific Iteration
      operationId: microsoftAzureGetiteration
      parameters:
      - name: projectId
        in: path
        description: The id of the project the iteration belongs to.
        required: true
        schema:
          type: string
          format: uuid
      - name: iterationId
        in: path
        description: The id of the iteration to get.
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Iteration'
            application/xml:
              schema:
                $ref: '#/components/schemas/Iteration'
            text/xml:
              schema:
                $ref: '#/components/schemas/Iteration'
        default:
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomVisionError'
            application/xml:
              schema:
                $ref: '#/components/schemas/CustomVisionError'
            text/xml:
              schema:
                $ref: '#/components/schemas/CustomVisionError'
      x-ms-examples:
        Successful GetIteration request:
          $ref: ./examples/GetIteration.json
      description: Needs a more full description created.
      security:
      - apim_key: []
    delete:
      tags:
      - Project API
      summary: Microsoft Azure Delete A Specific Iteration Of A Project
      operationId: microsoftAzureDeleteiteration
      parameters:
      - name: projectId
        in: path
        description: The project id.
        required: true
        schema:
          type: string
          format: uuid
      - name: iterationId
        in: path
        description: The iteration id.
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '204':
          description: No Content
        default:
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomVisionError'
      x-ms-examples:
        Successful DeleteIteration request:
          $ref: ./examples/DeleteIteration.json
      description: Needs a more full description created.
      security:
      - apim_key: []
    patch:
      tags:
      - Project API
      summary: Microsoft Azure Update A Specific Iteration
      operationId: microsoftAzureUpdateiteration
      parameters:
      - name: projectId
        in: path
        description: Project id.
        required: true
        schema:
          type: string
          format: uuid
      - name: iterationId
        in: path
        description: Iteration id.
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Iteration'
            application/xml:
              schema:
                $ref: '#/components/schemas/Iteration'
            text/xml:
              schema:
                $ref: '#/components/schemas/Iteration'
        default:
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomVisionError'
            application/xml:
              schema:
                $ref: '#/components/schemas/CustomVisionError'
            text/xml:
              schema:
                $ref: '#/components/schemas/CustomVisionError'
      x-ms-examples:
        Successful UpdateIteration request:
          $ref: ./examples/UpdateIteration.json
      description: Needs a more full description created.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Iteration'
          application/xml:
            schema:
              $ref: '#/components/schemas/Iteration'
          text/xml:
            schema:
              $ref: '#/components/schemas/Iteration'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Iteration'
        description: The updated iteration model.
        required: true
      security:
      - apim_key: []
    servers:
    - url: https://southcentralus.api.cognitive.microsoft.com/customvision/v3.3/training
  /projects/{projectId}/iterations/{iterationId}/export:
    get:
      tags:
      - Project API
      summary: Microsoft Azure Get The List Of Exports For A Specific Iteration
      operationId: microsoftAzureGetexports
      parameters:
      - name: projectId
        in: path
        description: The project id.
        required: true
        schema:
          type: string
          format: uuid
      - name: iterationId
        in: path
        description: The iteration id.
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Export'
            application/xml:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Export'
            text/xml:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Export'
        default:
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomVisionError'
            application/xml:
              schema:
                $ref: '#/components/schemas/CustomVisionError'
            text/xml:
              schema:
                $ref: '#/components/schemas/CustomVisionError'
      x-ms-examples:
        Successful GetExports request:
          $ref: ./examples/GetExports.json
      description: Needs a more full description created.
      security:
      - apim_key: []
    post:
      tags:
      - Project API
      summary: Microsoft Azure Export A Trained Iteration
      operationId: microsoftAzureExportiteration
      parameters:
      - name: projectId
        in: path
        description: The project id.
        required: true
        schema:
          type: string
          format: uuid
      - name: iterationId
        in: path
        description: The iteration id.
        required: true
        schema:
          type: string
          format: uuid
      - name: platform
        in: query
        description: The target platform.
        required: true
        schema:
          type: string
          enum:
          - CoreML
          - TensorFlow
          - DockerFile
          - ONNX
          - VAIDK
      - name: flavor
        in: query
        description: The flavor of the target platform.
        required: false
        schema:
          type: string
          enum:
          - Linux
          - Windows
          - ONNX10
          - ONNX12
          - ARM
          - TensorFlowNormal
          - TensorFlowLite
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Export'
            application/xml:
              schema:
                $ref: '#/components/schemas/Export'
            text/xml:
              schema:
                $ref: '#/components/schemas/Export'
        default:
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomVisionError'
            application/xml:
              schema:
                $ref: '#/components/schemas/CustomVisionError'
            text/xml:
              schema:
                $ref: '#/components/schemas/CustomVisionError'
      x-ms-examples:
        Successful ExportIteration request:
          $ref: ./examples/ExportIteration.json
      description: Needs a more full description created.
      security:
      - apim_key: []
    servers:
    - url: https://southcentralus.api.cognitive.microsoft.com/customvision/v3.3/training
  /projects/{projectId}/iterations/{iterationId}/performance:
    get:
      tags:
      - Project API
      summary: Microsoft Azure Get Detailed Performance Information About An Iteration
      operationId: microsoftAzureGetiterationperformance
      parameters:
      - name: projectId
        in: path
        description: The id of the project the iteration belongs to.
        required: true
        schema:
          type: string
          format: uuid
      - name: iterationId
        in: path
        description: The id of the iteration to get.
        required: true
        schema:
          type: string
          format: uuid
      - name: threshold
        in: query
        description: The threshold used to determine true predictions.
        required: false
        schema:
          type: number
          format: float
      - name: overlapThreshold
        in: query
        description: If applicable, the bounding box overlap threshold used to determine true predictions.
        required: false
        schema:
          type: number
          format: float
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IterationPerformance'
            application/xml:
              schema:
                $ref: '#/components/schemas/IterationPerformance'
            text/xml:
              schema:
                $ref: '#/components/schemas/IterationPerformance'
        default:
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomVisionError'
            application/xml:
              schema:
                $ref: '#/components/schemas/CustomVisionError'
            text/xml:
              schema:
                $ref: '#/components/schemas/CustomVisionError'
      x-ms-examples:
        Successful GetIterationPerformance request:
          $ref: ./examples/GetIterationPerformance.json
      description: Needs a more full description created.
      security:
      - apim_key: []
    servers:
    - url: https://southcentralus.api.cognitive.microsoft.com/customvision/v3.3/training
  /projects/{projectId}/iterations/{iterationId}/performance/images:
    get:
      tags:
      - Project API
      summary: Microsoft Azure Get Image With Its Prediction For A Given Project Iteration
      description: 'This API supports batching and range selection. By default it will only return first 50 images matching images.

        Use the {take} and {skip} parameters to control how many images to return in a given batch.

        The filtering is on an and/or relationship. For example, if the provided tag ids are for the "Dog" and

        "Cat" tags, then only images tagged with Dog and/or Cat will be returned'
      operationId: microsoftAzureGetimageperformances
      parameters:
      - name: projectId
        in: path
        description: The project id.
        required: true
        schema:
          type: string
          format: uuid
      - name: iterationId
        in: path
        description: The iteration id. Defaults to workspace.
        required: true
        schema:
          type: string
          format: uuid
      - name: tagIds
        in: query
        description: A list of tags ids to filter the images. Defaults to all tagged images when null. Limited to 20.
        required: false
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
            format: uuid
          maxItems: 20
          minItems: 0
      - name: orderBy
        in: query
        description: The ordering. Defaults to newest.
        required: false
        schema:
          type: string
          enum:
          - Newest
          - Oldest
      - name: take
        in: query
        description: Maximum number of images to return. Defaults to 50, limited to 256.
        required: false
        schema:
          type: integer
          format: int32
          default: 50
          maximum: 256
          minimum: 0
      - name: skip
        in: query
        description: Number of images to skip before beginning the image batch. Defaults to 0.
        required: false
        schema:
          type: integer
          format: int32
          default: 0
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ImagePerformance'
            application/xml:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ImagePerformance'
            text/xml:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ImagePerformance'
        default:
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomVisionError'
            application/xml:
              schema:
                $ref: '#/components/schemas/CustomVisionError'
            text/xml:
              schema:
                $ref: '#/components/schemas/CustomVisionError'
      x-ms-examples:
        Successful GetImagePerformances request:
          $ref: ./examples/GetImagePerformances.json
      security:
      - apim_key: []
    servers:
    - url: https://southcentralus.api.cognitive.microsoft.com/customvision/v3.3/training
  /projects/{projectId}/iterations/{iterationId}/performance/images/count:
    get:
      tags:
      - Project API
      summary: Microsoft Azure Gets The Number Of Images Tagged With The Provided {tagids}…
      description: 'The filtering is on an and/or relationship. For example, if the provided tag ids are for the "Dog" and

        "Cat" tags, then only images tagged with Dog and/or Cat will be returned'
      operationId: microsoftAzureGetimageperformancecount
      parameters:
      - name: projectId
        in: path
        description: The project id.
        required: true
        schema:
          type: string
          format: uuid
      - name: iterationId
        in: path
        description: The iteration id. Defaults to workspace.
        required: true
        schema:
          type: string
          format: uuid
      - name: tagIds
        in: query
        description: A list of tags ids to filter the images to count. Defaults to all tags when null.
        required: false
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
            format: uuid
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                format: int32
                type: integer
            application/xml:
              schema:
                format: int32
                type: integer
            text/xml:
              schema:
                format: int32
                type: integer
        default:
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomVisionError'
            application/xml:
              schema:
                $ref: '#/components/schemas/CustomVisionError'
            text/xml:
              schema:
                $ref: '#/components/schemas/CustomVisionError'
      x-ms-examples:
        Successful GetImagePerformanceCount request:
          $ref: ./examples/GetImagePerformanceCount.json
      security:
      - apim_key: []
    servers:
    - url: https://southcentralus.api.cognitive.microsoft.com/customvision/v3.3/training
  /projects/{projectId}/iterations/{iterationId}/publish:
    post:
      tags:
      - Project API
      summary: Microsoft Azure Publish A Specific Iteration
      operationId: microsoftAzurePublishiteration
      parameters:
      - name: projectId
        in: path
        description: The project id.
        required: true
        schema:
          type: string
          format: uuid
      - name: iterationId
        in: path
        description: The iteration id.
        required: true
        schema:
          type: string
          format: uuid
      - name: publishName
        in: query
        description: The name to give the published iteration.
        required: true
        schema:
          type: string
      - name: predictionId
        in: query
        description: The id of the prediction resource to publish to.
        required: true
        schema:
          type: string
      - name: overwrite
        in: query
        description: 'Whether to overwrite the published model with the given name (default: false).'
        required: false
        schema:
          type: boolean
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: boolean
            application/xml:
              schema:
                type: boolean
            text/xml:
              schema:
                type: boolean
        default:
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomVisionError'
            application/xml:
              schema:
                $ref: '#/components/schemas/CustomVisionError'
            text/xml:
              schema:
                $ref: '#/components/schemas/CustomVisionError'
      x-ms-examples:
        Successful PublishIteration request:
          $ref: ./examples/PublishIteration.json
      description: Needs a more full description created.
      security:
      - apim_key: []
    delete:
      tags:
      - Project API
      summary: Microsoft Azure Unpublish A Specific Iteration
      operationId: microsoftAzureUnpublishiteration
      parameters:
      - name: projectId
        in: path
        description: The project id.
        required: true
        schema:
          type: string
          format: uuid
      - name: iterationId
        in: path
        description: The iteration id.
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '204':
          description: No Content
        default:
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomVisionError'
      x-ms-examples:
        Successful UnpublishIteration request:
          $ref: ./examples/UnpublishIteration.json
      description: Needs a more full description created.
      security:
      - apim_key: []
    servers:
    - url: https://southcentralus.api.cognitive.microsoft.com/customvision/v3.3/training
  /projects/{projectId}/train:
    post:
      tags:
      - Project API
      summary: Microsoft Azure Queues Project For Training
      operationId: microsoftAzureTrainproject
      parameters:
      - name: projectId
        in: path
        description: The project id.
        required: true
        schema:
          type: string
          format: uuid
      - name: trainingType
        in: query
        description: 'The type of training to use to train the project (default: Regular).'
        required: false
        schema:
          type: string
          enum:
          - Regular
          - Advanced
      - name: reservedBudgetInHours
        in: query
        description: The number of hours reserved as budget for training (if applicable).
        required: false
        schema:
          type: integer
          format: int32
          default: 0
      - name: forceTrain
        in: query
        description: 'Whether to force train even if dataset and configuration does not change (default: false).'
        required: false
        schema:
          type: boolean
          default: false
      - name: notificationEmailAddress
        in: query
        description: 'The email address to send notification to when training finishes (default: null).'
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Iteration'
            application/xml:
              schema:
                $ref: '#/components/schemas/Iteration'
            text/xml:
              schema:
                $ref: '#/components/schemas/Iteration'
        default:
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomVisionError'
            application/xml:
              schema:
                $ref: '#/components/schemas/CustomVisionError'
            text/xml:
              schema:
                $ref: '#/components/schemas/CustomVisionError'
      x-ms-examples:
        Successful TrainProject request:
          $ref: ./examples/TrainProject.json
      description: Needs a more full description created.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TrainingParameters'
          application/xml:
            schema:
              $ref: '#/components/schemas/TrainingParameters'
          text/xml:
            schema:
              $ref: '#/components/schemas/TrainingParameters'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/TrainingParameters'
        description: Additional training parameters passed in to control how the project is trained.
      security:
      - apim_key: []
    servers:
    - url: https://southcentralus.api.cognitive.microsoft.com/customvision/v3.3/training
  /projects/import:
    post:
      tags:
      - Project API
      summary: Microsoft Azure Imports A Project
      operationId: microsoftAzureImportproject
      parameters:
      - name: token
        in: query
        description: Token generated from the export project call.
        required: true
        schema:
          type: string
      - name: name
        in: query
        description: Optional, name of the project to use instead of auto-generated name.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Project'
            application/xml:
              schema:
                $ref: '#/components/schemas/Project'
            text/xml:
              schema:
                $ref: '#/components/schemas/Project'
        default:
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomVisionError'
            application/xml:
              schema:
                $ref: '#/components/schemas/CustomVisionError'
            text/xml:
              schema:
                $ref: '#/components/schemas/CustomVisionError'
      x-ms-examples:
        Successful ImportProject request:
          $ref: ./examples/ImportProject.json
      description: Needs a more full description created.
      security:
      - apim_key: []
    servers:
    - url: https://southcentralus.api.cognitive.microsoft.com/customvision/v3.3/training
components:
  schemas:
    TrainingParameters:
      description: Parameters used for training.
      type: object
      properties:
        selectedTags:
          description: List of tags selected for this training session, other tags in the project will be ignored.
          type: array
          items:
            format: uuid
            type: string
          readOnly: false
    ImageTag:
      type: object
      properties:
        tagId:
          format: uuid
          type: string
          readOnly: true
        tagName:
          type: string
          readOnly: true
        created:
          format: date-time
          type: string
          readOnly: true
    CustomVisionError:
      required:
      - code
      - message
      type: object
      properties:
        code:
          description: The error code.
          enum:
          - NoError
          - BadRequest
          - BadRequestExceededBatchSize
          - BadRequestNotSupported
          - BadRequestInvalidIds
          - BadRequestProjectName
          - BadRequestProjectNameNotUnique
          - BadRequestProjectDescription
          - BadRequestProjectUnknownDomain
          - BadRequestProjectUnknownClassification
          - BadRequestProjectUnsupportedDomainTypeChange
          - BadRequestProjectUnsupportedExportPlatform
          - BadRequestProjectImagePreprocessingSettings
          - BadRequestProjectDuplicated
          - BadRequestIterationName
          - BadRequestIterationNameNotUnique
          - BadRequestIterationDescription
          - BadRequestIterationIsNotTrained
          - BadRequestIterationValidationFailed
          - BadRequestWorkspaceCannotBeModified
          - BadRequestWorkspaceNotDeletable
          - BadRequestTagName
          - BadRequestTagNameNotUnique
          - BadRequestTagDescription
          - BadRequestTagType
          - BadRequestMultipleNegativeTag
          - BadRequestMultipleGeneralProductTag
          - BadRequestImageTags
          - BadRequestImageRegions
          - BadRequestNegativeAndRegularTagOnSameImage
          - BadRequestUnsupportedDomain
          - BadRequestRequiredParamIsNull
          - BadRequestIterationIsPublished
          - BadRequestInvalidPublishName
          - BadRequestInvalidPublishTarget
          - BadRequestUnpublishFailed
          - BadRequestIterationNotPublished
          - BadRequestSubscriptionApi
          - BadRequestExceedProjectLimit
          - BadRequestExceedIterationPerProjectLimit
          - BadRequestExceedTagPerProjectLimit
          - BadRequestExceedTagPerImageLimit
          - BadRequestExceededQuota
          - BadRequestCannotMigrateProjectWithName
          - BadRequestNotLimitedTrial
          - BadRequestImageBatch
          - BadRequestImageStream
          - BadRequestImageUrl
          - BadRequestImageFormat
          - BadRequestImageSizeBytes
          - BadRequestImageDimensions
          - BadRequestImageExceededCount
          - BadRequestTrainingNotNeeded
          - BadRequestTrainingNotNeededButTrainingPipelineUpdated
          - BadRequestTrainingValidationFailed
          - BadRequestClassificationTrainingValidationFailed
          - BadRequestMultiClassClassificationTrainingValidationFailed
          - BadRequestMultiLabelClassificationTrainingValidationFailed
          - BadRequestDetectionTrainingValidationFailed
          - BadRequestTrainingAlreadyInProgress
          - BadRequestDetectionTrainingNotAllowNegativeTag
          - BadRequestInvalidEmailAddress
          - BadRequestDomainNotSupportedForAdvancedTraining
          - BadRequestExportPlatformNotSupportedForAdvancedTraining
          - BadRequestReservedBudgetInHoursNotEnoughForAdvancedTraining
          - BadRequestExportValidationFailed
          - BadRequestExportAlreadyInProgress
          - BadRequestPredictionIdsMissing
          - BadRequestPredictionIdsExceededCount
          - BadRequestPredictionTagsExceededCount
          - BadRequestPredictionResultsExceededCount
          - BadRequestPredictionInvalidApplicationName
          - BadRequestPredictionInvalidQueryParameters
          - BadRequestInvalidImportToken
          - BadRequestExportWhileTraining
          - BadRequestImageMetadataKey
          - BadRequestImageMetadataValue
          - BadRequestOperationNotSupported
          - BadRequestInvalidArtifactUri
          - BadRequestCustomerManagedKeyRevoked
          - BadRequestInvalid
          - UnsupportedMediaType
          - Forbidden
          - ForbiddenUser
          - ForbiddenUserResource
          - ForbiddenUserSignupDisabled
          - ForbiddenUserSignupAllowanceExceeded
          - ForbiddenUserDoesNotExist
          - ForbiddenUserDisabled
          - ForbiddenUserInsufficientCapability
          - ForbiddenDRModeEnabled
          - ForbiddenInvalid
          - NotFound
          - NotFoundProject
          - NotFoundProjectDefaultIteration
          - NotFoundIteration
          - NotFoundIterationPerformance
          - NotFoundTag
          - NotFoundImage
          - NotFoundDomain
          - NotFoundApimSubscription
          - NotFoundInvalid
          - Conflict
          - ConflictInvalid
          - ErrorUnknown
          - ErrorIterationCopyFailed
          - ErrorPreparePerformanceMigrationFailed
          - ErrorProjectInvalidWorkspace
          - ErrorProjectInvalidPipelineConfiguration
          - ErrorProjectInvalidDomain
          - ErrorProjectTrainingRequestFailed
          - ErrorProjectImportRequestFailed
          - ErrorProjectExportRequestFailed
          - ErrorFeaturizationServiceUnavailable
          - ErrorFeaturizationQueueTimeout
          - ErrorFeaturizationInvalidFeaturizer
          - ErrorFeaturizationAugmentationUnavailable
          - ErrorFeaturizationUnrecognizedJob
          - ErrorFeaturizationAugmentationError
          - ErrorExporterInvalidPlatform
          - ErrorExporterInvalidFeaturizer
          - ErrorExporterInvalidClassifier
          - ErrorPredictionServiceUnavailable
          - ErrorPredictionModelNotFound
          - ErrorPredictionModelNotCached
          - ErrorPrediction
          - ErrorPredictionStorage
          - ErrorRegionProposal
          - ErrorUnknownBaseModel
          - ErrorInvalid
          type: string
          x-ms-enum:
            name: CustomVisionErrorCodes
            modelAsString: true
        message:
          description: A message explaining the error reported by the service.
          type: string
    ProjectSettings:
      description: Represents settings associated with a project.
      type: object
      properties:
        domainId:
          format: uuid
          description: Gets or sets the id of the Domain to use with this project.
          type: string
          readOnly: false
        classificationType:
          description: Gets or sets the classification type of the project.
          enum:
          - Multiclass
          - Multilabel
          type:
          - string
          - 'null'
          readOnly: false
          x-ms-enum:
            name: Classifier
            modelAsString: true
        targetExportPlatforms:
          description: A list of ExportPlatform that the trained model should be able to support.
          type: array
          items:
            enum:
            - CoreML
            - TensorFlow
            - DockerFile
            - ONNX
            - VAIDK
            type: string
          readOnly: false
        useNegativeSet:
          description: Indicates if negative set is being used.
          type:
          - boolean
          - 'null'
          readOnly: true
        detectionParameters:
          description: Detection parameters in use, if any.
          type: string
          readOnly: true
        imageProcessingSettings:
          $ref: '#/components/schemas/ImageProcessingSettings'
          description: Gets or sets image preprocessing settings.
          readOnly: false
    Prediction:
      description: Prediction result.
      type: object
      properties:
        probability:
          format: float
          description: Probability of the tag.
          type: number
          readOnly: true
        tagId:
          format: uuid
          description: Id of the predicted tag.
          type: string
          readOnly: true
        tagName:
          description: Name of the predicted tag.
          type:
          - string
          - 'null'
          readOnly: true
        boundingBox:
          $ref: '#/components/schemas/BoundingBox'
          description: Bounding box of the prediction.
          readOnly: true
        tagType:
          description: Type of the predicted tag.
          enum:
          - Regular
          - Negative
          - GeneralProduct
          type:
          - string
          - 'null'
          readOnly: true
          x-ms-enum:
            name: TagType
            modelAsString: true
    ProjectExport:
      description: Represents information about a project export.
      type: object
      properties:
        iterationCount:
          format: int32
          description: Count of iterations that will be exported.
          type: integer
          readOnly: true
        imageCount:
          format: int32
          description: Count of images that will be exported.
          type: integer
          readOnly: true
        tagCount:
          format: int32
          description: Count of tags that will be exported.
          type: integer
          readOnly: true
        regionCount:
          format: int32
          description: Count of regions that will be exported.
          type: integer
          readOnly: true
        estimatedImportTimeInMS:
          format: int32
          description: 'Estimated time this project will take to import, can change based on network connectivity and load between

            source and destination regions.'
          type: integer
          readOnly: true
        token:
          description: 'Opaque token that should be passed to ImportProject to perform the import. This token grants access to import this

            project to all that have the token.'
          type: string
          readOnly: true
    Project:
      description: Represents a project.
      required:
      - name
      - description
      - settings
      type: object
      properties:
        id:
          format: uuid
          description: Gets the project id.
          type: string
          readOnly: true
        name:
          description: Gets or sets the name of the project.
          type: string
          readOnly: false
        description:
          description: Gets or sets the description of the project.
          type:
          - string
          - 'null'
          readOnly: false
        settings:
          $ref: '#/components/schemas/ProjectSettings'
          description: Gets or sets the project settings.
          readOnly: false
        created:
          format: date-time
          description: Gets the date this project was created.
          type: string
          readOnly: true
        lastModified:
          format: date-time
          description: Gets the date this project was last modified.
          type: string
          readOnly: true
        thumbnailUri:
          description: Gets the thumbnail url representing the image. If VNET feature is enabled this will be a relative path to be used with GetArtifact, otherwise this will be an absolute URI to the resource.
          type: string
          readOnly: true
        drModeEnabled:
          description: Gets if the Disaster Recovery (DR) mode is on, indicating the project is temporarily read-only.
          type:
          - boolean
          - 'null'
          readOnly: true
        status:
          description: Gets the status of the project.
          enum:
          - Succeeded
          - Importing
          - Failed
          type: string
          readOnly: false
          x-ms-enum:
            name: ProjectStatus
            modelAsString: true
    IterationPerformance:
      description: Represents the detailed performance data for a trained iteration.
      type: object
      properties:
        perTagPerformance:
          description: Gets the per-tag performance details for this iteration.
          type: array
          items:
            $ref: '#/components/schemas/TagPerformance'
          readOnly: true
        precision:
          format: float
          description: Gets the precision.
          type: number
          readOnly: true
        precisionStdDeviation:
          format: float
          description: Gets the standard deviation for the precision.
          type: number
          readOnly: true
        recall:
          format: float
          description: Gets the recall.
          type: number
          readOnly: true
        recallStdDeviation:
          format: float
          description: Gets the standard deviation for the recall.
          type: number
          readOnly: true
        averagePrecision:
          format: float
          description: Gets the average precision when applicable.
          type:
          - number
          - 'null'
          readOnly: true
    Iteration:
      description: Iteration model to be sent over JSON.
      required:
      - name
      type: object
      properties:
        id:
          format: uuid
          description: Gets the id of the iteration.
          type: string
          readOnly: true
        name:
          description: Gets or sets the name of the iteration.
          type: string
          readOnly: false
        status:
          description: Gets the current iteration status.
          type: string
          readOnly: true
        created:
          format: date-time
          description: Gets the time this iteration was completed.
          type: string
          readOnly: true
        lastModified:
          format: date-time
          description: Gets the time this iteration was last modified.
          type: string
          readOnly: true
        trainedAt:
          format: date-time
          description: Gets the time this iteration was last modified.
          type:
          - string
          - 'null'
          readOnly: true
        projectId:
          format: uuid
          description: Gets the project id of the iteration.
          type: string
          readOnly: true
        exportable:
          description: Whether the iteration can be exported to another format for download.
          type: boolean
          readOnly: true
        exportableTo:
          description: A set of platforms this iteration can export to.
          type: array
          items:
            enum:
            - CoreML
            - TensorFlow
            - DockerFile
            - ONNX
            - VAIDK
            type: string
          readOnly: true
        domainId:
          format: uuid
          description: Get or sets a guid of the domain the iteration has been trained on.
          type:
          - string
          - 'null'
          readOnly: true
        classificationType:
          description: Gets the classification type of the project.
          enum:
          - Multiclass
          - Multilabel
          type:
          - string
          - 'null'
          readOnly: true
          x-ms-enum:
            name: Classifier
            modelAsString: true
        trainingType:
          description: Gets the training type of the iteration.
          enum:
          - Regular
          - Advanced
          type: string
          readOnly: true
          x-ms-enum:
            name: TrainingType
            modelAsString: true
        reservedBudgetInHours:
          format: int32
          description: Gets the reserved advanced training budget for the iteration.
          type: integer
          readOnly: true
        trainingTimeInMinutes:
          format: int32
          description: Gets the training time for the iteration.
          type: integer
          readOnly: true
        publishName:
          description: Name of the published model.
          type: string
          readOnly: true
        originalPublishResourceId:
          description: Resource Provider Id this iteration was originally published to.
          type: string
          readOnly: true
    BoundingBox:
      description: Bounding box that defines a region of an image.
      required:
      - left
      - top
      - width
      - height
      type: object
      properties:
        left:
          format: float
          description: Coordinate of the left boundary.
          type: number
          readOnly: false
        top:
          format: float
          description: Coordinate of the top boundary.
          type: number
          readOnly: false
        width:
          format: float
          description: Width.
          type: number
          readOnly: false
        height:
          format: float
          description: Height.
          type: number
          readOnly: false
    Export:
      type: object
      properties:
        platform:
          description: Platform of the export.
          enum:
          - CoreML
          - TensorFlow
          - DockerFile
          - ONNX
          - VAIDK
          type: string
          readOnly: true
          x-ms-enum:
            name: ExportPlatform
            modelAsString: true
        status:
          description: Status of the export.
          enum:
          - Exporting
          - Failed
          - Done
          type: string
          readOnly: true
          x-ms-enum:
            name: ExportStatus
            modelAsString: true
        downloadUri:
          description: URI used to download the model. If VNET feature is enabled this will be a relative path to be used with GetArtifact, otherwise this will be an absolute URI to the resource.
          type: string
          readOnly: true
        flavor:
          description: 'Flavor of the export. These are specializations of the export platform.

            Docker platform has valid flavors: Linux, Windows, ARM.

            Tensorflow platform has valid flavors: TensorFlowNormal, TensorFlowLite.

            ONNX platform has valid flavors: ONNX10, ONNX12.'
          enum:
          - Linux
          - Windows
          - ONNX10
          - ONNX12
          - ARM
          - TensorFlowNormal
          - TensorFlowLite
          type:
          - string
          - 'null'
          readOnly: true
          x-ms-enum:
            name: ExportFlavor
            modelAsString: true
        newerVersionAvailable:
          description: Indicates an updated version of the export package is available and should be re-exported for the latest changes.
          type: boolean
          readOnly: true
    ImagePerformance:
      description: Image performance model.
      type: object
      properties:
        predictions:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/Prediction'
          readOnly: true
        id:
          format: uuid
          type: string
          readOnly: true
        created:
          format: date-time
          type: string
          readOnly: true
        width:
          format: int32
          type: integer
          readOnly: true
        height:
          format: int32
          type: integer
          readOnly: true
        imageUri:
          type: string
          readOnly: true
        thumbnailUri:
          type: string
          readOnly: true
        tags:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ImageTag'
          readOnly: true
        regions:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ImageRegion'
          readOnly: true
    ImageRegion:
      required:
      - tagId
      - left
      - top
      - width
      - height
      type: object
      properties:
        regionId:
          format: uuid
          type: string
          readOnly: true
        tagName:
          type: string
          readOnly: true
        created:
          format: date-time
          type: string
          readOnly: true
        tagId:
          format: uuid
          description: Id of the tag associated with this region.
          type: string
          readOnly: false
        left:
          format: float
          description: Coordinate of the left boundary.
          type: number
          readOnly: false
        top:
          format: float
          description: Coordinate of the top boundary.
          type: number
          readOnly: false
        width:
          format: float
          description: Width.
          type: number
          readOnly: false
        height:
          format: float
          description: Height.
          type: number
          readOnly: false
    ImageProcessingSettings:
      description: Represents image preprocessing settings used by image augmentation.
      type: object
      properties:
        augmentationMethods:
          description: 'Gets or sets enabled image transforms. The key corresponds to the transform name. If value is set to true, then correspondent transform is enabled. Otherwise this transform will not be used.

            Augmentation will be uniformly distributed among enabled transforms.'
          type:
          - object
          - 'null'
          additionalProperties:
            type: boolean
          readOnly: false
    TagPerformance:
      description: Represents performance data for a particular tag in a trained iteration.
      type: object
      properties:
        id:
          format: uuid
          type: string
          readOnly: true
        name:
          type: string
          readOnly: true
        precision:
          format: float
          description: Gets the precision.
          type: number
          readOnly: true
        precisionStdDeviation:
          format: float
          description: Gets the standard deviation for the precision.
          type: number
          readOnly: true
        recall:
          format: float
          description: Gets the recall.
          type: number
          readOnly: true
        recallStdDeviation:
          format: float
          description: Gets the standard deviation for the recall.
          type: number
          readOnly: true
        averagePrecision:
          format: float
          description: Gets the average precision when applicable.
          type:
          - number
          - 'null'
          readOnly: true
    ImageTag_2:
      type:
      - object
      - 'null'
      properties:
        tagId:
          format: uuid
          type: string
          readOnly: true
        tagName:
          type:
          - string
          - 'null'
          readOnly: true
        created:
          format: date-time
          type: string
          readOnly: true
    ProjectSettings_2:
      description: Represents settings associated with a project
      type:
      - object
      - 'null'
      properties:
        domainId:
          format: uuid
          description: Gets or sets the id of the Domain to use with this project
          type: string
        classificationType:
          description: Gets or sets the classification type of the project
          enum:
          - Multiclass
          - Multilabel
          type:
          - string
          - 'null'
          x-ms-enum:
            name: Classifier
            modelAsString: true
    Prediction_2:
      type:
      - object
      - 'null'
      properties:
        probability:
          format: float
          type: number
          readOnly: true
        tagId:
          format: uuid
          type: string
          readOnly: true
        tagName:
          type:
          - string
          - 'null'
          readOnly: true
        boundingBox:
          $ref: '#/components/schemas/BoundingBox_2'
          readOnly: true
    Project_2:
      description: Represents a project
      type:
      - object
      - 'null'
      properties:
        id:
          format: uuid
          description: Gets the project id
          type: string
          readOnly: true
        name:
          description: Gets or sets the name of the project
          type:
          - string
          - 'null'
        description:
          description: Gets or sets the description of the project
          type:
          - string
          - 'null'
        settings:
          $ref: '#/components/schemas/ProjectSettings_2'
          description: Gets or sets the project settings
        created:
          format: date-time
          description: Gets the date this project was created
          type: string
          readOnly: true
        lastModified:
          format: date-time
          description: Gets the date this project was last modified
          type: string
          readOnly: true
        thumbnailUri:
          description: Gets the thumbnail url representing the project
          type:
          - string
          - 'null'
          readOnly: true
    IterationPerformance_2:
      description: Represents the detailed performance data for a trained iteration
      type:
      - object
      - 'null'
      properties:
        perTagPerformance:
          description: Gets the per-tag performance details for this iteration
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/TagPerformance_2'
          readOnly: true
        precision:
          format: float
          description: Gets the precision
          type: number
          readOnly: true
        precisionStdDeviation:
          format: float
          description: Gets the standard deviation for the precision
          type: number
          readOnly: true
        recall:
          format: float
          description: Gets the recall
          type: number
          readOnly: true
        recallStdDeviation:
          format: float
          description: Gets the standard deviation for the recall
          type: number
          readOnly: true
        averagePrecision:
          format: float
          description: Gets the average precision when applicable
          type:
          - number
          - 'null'
          readOnly: true
    Iteration_2:
      description: Iteration model to be sent over JSON
      type:
      - object
      - 'null'
      properties:
        id:
          format: uuid
          description: Gets the id of the iteration
          type: string
          readOnly: true
        name:
          description: Gets or sets the name of the iteration
          type:
          - string
          - 'null'
        isDefault:
          description: Gets or sets a value indicating whether the iteration is the default iteration for the project
          type: boolean
        status:
          description: Gets the current iteration status
          type:
          - string
          - 'null'
          readOnly: true
        created:
          format: date-time
          description: Gets the time this iteration was completed
          type: string
          readOnly: true
        lastModified:
          format: date-time
          description: Gets the time this iteration was last modified
          type: string
          readOnly: true
        trainedAt:
          format: date-time
          description: Gets the time this iteration was last modified
          type:
          - string
          - 'null'
          readOnly: true
        projectId:
          format: uuid
          description: Gets the project id of the iteration
          type: string
          readOnly: true
        exportable:
          description: Whether the iteration can be exported to another format for download
          type: boolean
          readOnly: true
        domainId:
          format: uuid
          description: Get or sets a guid of the domain the iteration has been trained on
          type:
          - string
          - 'null'
          readOnly: true
        classificationType:
          description: Gets the classification type of the project
          enum:
          - Multiclass
          - Multilabel
          type:
          - string
          - 'null'
          readOnly: true
          x-ms-enum:
            name: Classifier
            modelAsString: true
    BoundingBox_2:
      type:
      - object
      - 'null'
      properties:
        left:
          format: float
          type: number
        top:
          format: float
          type: number
        width:
          format: float
          type: number
        height:
          format: float
          type: number
    Export_2:
      type:
      - object
      - 'null'
      properties:
        platform:
          enum:
          - CoreML
          - TensorFlow
          - DockerFile
          - ONNX
          type: string
          readOnly: true
          x-ms-enum:
            name: ExportPlatform
            modelAsString: true
        status:
          enum:
          - Exporting
          - Failed
          - Done
          type: string
          readOnly: true
          x-ms-enum:
            name: ExportStatusModel
            modelAsString: true
        downloadUri:
          type:
          - string
          - 'null'
          readOnly: true
        flavor:
          enum:
          - Linux
          - Windows
          type:
          - string
          - 'null'
          readOnly: true
          x-ms-enum:
            name: ExportFlavor
            modelAsString: true
        newerVersionAvailable:
          type: boolean
          readOnly: true
    ImagePerformance_2:
      description: Image performance model
      type:
      - object
      - 'null'
      properties:
        predictions:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/Prediction_2'
          readOnly: true
        id:
          format: uuid
          type: string
          readOnly: true
        created:
          format: date-time
          type: string
          readOnly: true
        width:
          format: int32
          type: integer
          readOnly: true
        height:
          format: int32
          type: integer
          readOnly: true
        imageUri:
          type:
          - string
          - 'null'
          readOnly: true
        thumbnailUri:
          type:
          - string
          - 'null'
          readOnly: true
        tags:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ImageTag_2'
          readOnly: true
        regions:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ImageRegion_2'
          readOnly: true
    ImageRegion_2:
      type:
      - object
      - 'null'
      properties:
        regionId:
          format: uuid
          type: string
          readOnly: true
        tagName:
          type:
          - string
          - 'null'
          readOnly: true
        created:
          format: date-time
          type: string
          readOnly: true
        tagId:
          format: uuid
          type: string
        left:
          format: float
          type: number
        top:
          format: float
          type: number
        width:
          format: float
          type: number
        height:
          format: float
          type: number
    TagPerformance_2:
      description: Represents performance data for a particular tag in a trained iteration
      type:
      - object
      - 'null'
      properties:
        id:
          format: uuid
          type: string
          readOnly: true
        name:
          type:
          - string
          - 'null'
          readOnly: true
        precision:
          format: float
          description: Gets the precision
          type: number
          readOnly: true
        precisionStdDeviation:
          format: float
          description: Gets the standard deviation for the precision
          type: number
          readOnly: true
        recall:
          format: float
          description: Gets the recall
          type: number
          readOnly: true
        recallStdDeviation:
          format: float
          description: Gets the standard deviation for the recall
          type: number
          readOnly: true
        averagePrecision:
          format: float
          description: Gets the average precision when applicable
          type:
          - number
          - 'null'
          readOnly: true
  parameters:
    ApiKey:
      name: Training-Key
      in: header
      required: true
      x-ms-client-name: ApiKey
      x-ms-parameter-location: client
      schema:
        type: string
  securitySchemes:
    apim_key:
      type: apiKey
      name: Training-Key
      in: header
x-refined-from:
- custom-vision-training-client-openapi-original.yml
- trainingapi-openapi-original.yml
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/components/parameters/Endpoint'