swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector ProjectApi API
schemes:
- https
tags:
- name: ProjectApi
paths:
  /projects:
    get:
      tags:
      - ProjectApi
      summary: Microsoft Azure Get Your Projects
      operationId: microsoftAzureGetprojects
      consumes: []
      produces:
      - application/json
      - application/xml
      - text/xml
      parameters: []
      responses:
        '200':
          description: OK
          schema:
            type: array
            items:
              $ref: '#/definitions/Project'
        default:
          description: Error response
          schema:
            $ref: '#/definitions/CustomVisionError'
      x-ms-examples:
        Successful GetProjects request:
          $ref: ./examples/GetProjects.json
      description: Needs a more full description created.
    post:
      tags:
      - ProjectApi
      summary: Microsoft Azure Create A Project
      operationId: microsoftAzureCreateproject
      consumes: []
      produces:
      - application/json
      - application/xml
      - text/xml
      parameters:
      - name: name
        in: query
        description: Name of the project.
        required: true
        type: string
      - name: description
        in: query
        description: The description of the project.
        required: false
        type: string
      - name: domainId
        in: query
        description: The id of the domain to use for this project. Defaults to General.
        required: false
        type: string
        format: uuid
      - name: classificationType
        in: query
        description: The type of classifier to create for this project.
        required: false
        type: string
        enum:
        - Multiclass
        - Multilabel
      - name: targetExportPlatforms
        in: query
        description: List of platforms the trained model is intending exporting to.
        required: false
        type: array
        items:
          type: string
          enum:
          - CoreML
          - TensorFlow
          - DockerFile
          - ONNX
          - VAIDK
        collectionFormat: csv
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/Project'
        default:
          description: Error response
          schema:
            $ref: '#/definitions/CustomVisionError'
      x-ms-examples:
        Successful CreateProject request:
          $ref: ./examples/CreateProject.json
      description: Needs a more full description created.
  /projects/{projectId}:
    get:
      tags:
      - ProjectApi
      summary: Microsoft Azure Get A Specific Project
      operationId: microsoftAzureGetproject
      consumes: []
      produces:
      - application/json
      - application/xml
      - text/xml
      parameters:
      - name: projectId
        in: path
        description: The id of the project to get.
        required: true
        type: string
        format: uuid
        x-nullable: false
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/Project'
        default:
          description: Error response
          schema:
            $ref: '#/definitions/CustomVisionError'
      x-ms-examples:
        Successful GetProject request:
          $ref: ./examples/GetProject.json
      description: Needs a more full description created.
    delete:
      tags:
      - ProjectApi
      summary: Microsoft Azure Delete A Specific Project
      operationId: microsoftAzureDeleteproject
      consumes: []
      produces: []
      parameters:
      - name: projectId
        in: path
        description: The project id.
        required: true
        type: string
        format: uuid
        x-nullable: false
      responses:
        '204':
          description: No Content
        default:
          description: Error response
          schema:
            $ref: '#/definitions/CustomVisionError'
      x-ms-examples:
        Successful DeleteProject request:
          $ref: ./examples/DeleteProject.json
      description: Needs a more full description created.
    patch:
      tags:
      - ProjectApi
      summary: Microsoft Azure Update A Specific Project
      operationId: microsoftAzureUpdateproject
      consumes:
      - application/json
      - application/xml
      - text/xml
      - application/x-www-form-urlencoded
      produces:
      - application/json
      - application/xml
      - text/xml
      parameters:
      - name: projectId
        in: path
        description: The id of the project to update.
        required: true
        type: string
        format: uuid
        x-nullable: false
      - name: updatedProject
        in: body
        description: The updated project model.
        required: true
        schema:
          $ref: '#/definitions/Project'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/Project'
        default:
          description: Error response
          schema:
            $ref: '#/definitions/CustomVisionError'
      x-ms-examples:
        Successful UpdateProject request:
          $ref: ./examples/UpdateProject.json
      description: Needs a more full description created.
  /projects/{projectId}/artifacts:
    get:
      tags:
      - ProjectApi
      summary: Microsoft Azure Get Artifact Content From Blob Storage, Based On Artifact Relative Path In The Blob
      operationId: microsoftAzureGetartifact
      consumes: []
      produces:
      - application/octet-stream
      parameters:
      - name: projectId
        in: path
        description: The project id.
        required: true
        type: string
        format: uuid
        x-nullable: false
      - name: path
        in: query
        description: The relative path for artifact.
        required: true
        type: string
      responses:
        '200':
          description: OK
          schema:
            type: file
        default:
          description: Error response
          schema:
            $ref: '#/definitions/CustomVisionError'
      x-ms-examples:
        Successful GetArtifact request:
          $ref: ./examples/GetArtifact.json
      description: Needs a more full description created.
  /projects/{projectId}/export:
    get:
      tags:
      - ProjectApi
      summary: Microsoft Azure Exports A Project
      operationId: microsoftAzureExportproject
      consumes: []
      produces:
      - application/json
      - application/xml
      - text/xml
      parameters:
      - name: projectId
        in: path
        description: The project id of the project to export.
        required: true
        type: string
        format: uuid
        x-nullable: false
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/ProjectExport'
        default:
          description: Error response
          schema:
            $ref: '#/definitions/CustomVisionError'
      x-ms-examples:
        Successful ExportProject request:
          $ref: ./examples/ExportProject.json
      description: Needs a more full description created.
  /projects/{projectId}/iterations:
    get:
      tags:
      - ProjectApi
      summary: Microsoft Azure Get Iterations For The Project
      operationId: microsoftAzureGetiterations
      consumes: []
      produces:
      - application/json
      - application/xml
      - text/xml
      parameters:
      - name: projectId
        in: path
        description: The project id.
        required: true
        type: string
        format: uuid
        x-nullable: false
      responses:
        '200':
          description: OK
          schema:
            type: array
            items:
              $ref: '#/definitions/Iteration'
        default:
          description: Error response
          schema:
            $ref: '#/definitions/CustomVisionError'
      x-ms-examples:
        Successful GetIterations request:
          $ref: ./examples/GetIterations.json
      description: Needs a more full description created.
  /projects/{projectId}/iterations/{iterationId}:
    get:
      tags:
      - ProjectApi
      summary: Microsoft Azure Get A Specific Iteration
      operationId: microsoftAzureGetiteration
      consumes: []
      produces:
      - application/json
      - application/xml
      - text/xml
      parameters:
      - name: projectId
        in: path
        description: The id of the project the iteration belongs to.
        required: true
        type: string
        format: uuid
        x-nullable: false
      - name: iterationId
        in: path
        description: The id of the iteration to get.
        required: true
        type: string
        format: uuid
        x-nullable: false
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/Iteration'
        default:
          description: Error response
          schema:
            $ref: '#/definitions/CustomVisionError'
      x-ms-examples:
        Successful GetIteration request:
          $ref: ./examples/GetIteration.json
      description: Needs a more full description created.
    delete:
      tags:
      - ProjectApi
      summary: Microsoft Azure Delete A Specific Iteration Of A Project
      operationId: microsoftAzureDeleteiteration
      consumes: []
      produces: []
      parameters:
      - name: projectId
        in: path
        description: The project id.
        required: true
        type: string
        format: uuid
        x-nullable: false
      - name: iterationId
        in: path
        description: The iteration id.
        required: true
        type: string
        format: uuid
        x-nullable: false
      responses:
        '204':
          description: No Content
        default:
          description: Error response
          schema:
            $ref: '#/definitions/CustomVisionError'
      x-ms-examples:
        Successful DeleteIteration request:
          $ref: ./examples/DeleteIteration.json
      description: Needs a more full description created.
    patch:
      tags:
      - ProjectApi
      summary: Microsoft Azure Update A Specific Iteration
      operationId: microsoftAzureUpdateiteration
      consumes:
      - application/json
      - application/xml
      - text/xml
      - application/x-www-form-urlencoded
      produces:
      - application/json
      - application/xml
      - text/xml
      parameters:
      - name: projectId
        in: path
        description: Project id.
        required: true
        type: string
        format: uuid
        x-nullable: false
      - name: iterationId
        in: path
        description: Iteration id.
        required: true
        type: string
        format: uuid
        x-nullable: false
      - name: updatedIteration
        in: body
        description: The updated iteration model.
        required: true
        schema:
          $ref: '#/definitions/Iteration'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/Iteration'
        default:
          description: Error response
          schema:
            $ref: '#/definitions/CustomVisionError'
      x-ms-examples:
        Successful UpdateIteration request:
          $ref: ./examples/UpdateIteration.json
      description: Needs a more full description created.
  /projects/{projectId}/iterations/{iterationId}/export:
    get:
      tags:
      - ProjectApi
      summary: Microsoft Azure Get The List Of Exports For A Specific Iteration
      operationId: microsoftAzureGetexports
      consumes: []
      produces:
      - application/json
      - application/xml
      - text/xml
      parameters:
      - name: projectId
        in: path
        description: The project id.
        required: true
        type: string
        format: uuid
        x-nullable: false
      - name: iterationId
        in: path
        description: The iteration id.
        required: true
        type: string
        format: uuid
        x-nullable: false
      responses:
        '200':
          description: OK
          schema:
            type: array
            items:
              $ref: '#/definitions/Export'
        default:
          description: Error response
          schema:
            $ref: '#/definitions/CustomVisionError'
      x-ms-examples:
        Successful GetExports request:
          $ref: ./examples/GetExports.json
      description: Needs a more full description created.
    post:
      tags:
      - ProjectApi
      summary: Microsoft Azure Export A Trained Iteration
      operationId: microsoftAzureExportiteration
      consumes: []
      produces:
      - application/json
      - application/xml
      - text/xml
      parameters:
      - name: projectId
        in: path
        description: The project id.
        required: true
        type: string
        format: uuid
        x-nullable: false
      - name: iterationId
        in: path
        description: The iteration id.
        required: true
        type: string
        format: uuid
        x-nullable: false
      - name: platform
        in: query
        description: The target platform.
        required: true
        type: string
        enum:
        - CoreML
        - TensorFlow
        - DockerFile
        - ONNX
        - VAIDK
      - name: flavor
        in: query
        description: The flavor of the target platform.
        required: false
        type: string
        enum:
        - Linux
        - Windows
        - ONNX10
        - ONNX12
        - ARM
        - TensorFlowNormal
        - TensorFlowLite
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/Export'
        default:
          description: Error response
          schema:
            $ref: '#/definitions/CustomVisionError'
      x-ms-examples:
        Successful ExportIteration request:
          $ref: ./examples/ExportIteration.json
      description: Needs a more full description created.
  /projects/{projectId}/iterations/{iterationId}/performance:
    get:
      tags:
      - ProjectApi
      summary: Microsoft Azure Get Detailed Performance Information About An Iteration
      operationId: microsoftAzureGetiterationperformance
      consumes: []
      produces:
      - application/json
      - application/xml
      - text/xml
      parameters:
      - name: projectId
        in: path
        description: The id of the project the iteration belongs to.
        required: true
        type: string
        format: uuid
        x-nullable: false
      - name: iterationId
        in: path
        description: The id of the iteration to get.
        required: true
        type: string
        format: uuid
        x-nullable: false
      - name: threshold
        in: query
        description: The threshold used to determine true predictions.
        required: false
        type: number
        format: float
      - name: overlapThreshold
        in: query
        description: If applicable, the bounding box overlap threshold used to determine true predictions.
        required: false
        type: number
        format: float
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/IterationPerformance'
        default:
          description: Error response
          schema:
            $ref: '#/definitions/CustomVisionError'
      x-ms-examples:
        Successful GetIterationPerformance request:
          $ref: ./examples/GetIterationPerformance.json
      description: Needs a more full description created.
  /projects/{projectId}/iterations/{iterationId}/performance/images:
    get:
      tags:
      - ProjectApi
      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.<br>Use the {take} and {skip} parameters to control how many images to return in a given batch.<br>The filtering is on an and/or relationship. For example, if the provided tag ids are for the "Dog" and<br>"Cat" tags, then only images tagged with Dog and/or Cat will be returned
      operationId: microsoftAzureGetimageperformances
      consumes: []
      produces:
      - application/json
      - application/xml
      - text/xml
      parameters:
      - name: projectId
        in: path
        description: The project id.
        required: true
        type: string
        format: uuid
        x-nullable: false
      - name: iterationId
        in: path
        description: The iteration id. Defaults to workspace.
        required: true
        type: string
        format: uuid
        x-nullable: false
      - 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
        type: array
        items:
          type: string
          format: uuid
          x-nullable: false
        collectionFormat: csv
        maxItems: 20
        minItems: 0
      - name: orderBy
        in: query
        description: The ordering. Defaults to newest.
        required: false
        type: string
        enum:
        - Newest
        - Oldest
      - name: take
        in: query
        description: Maximum number of images to return. Defaults to 50, limited to 256.
        required: false
        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
        type: integer
        format: int32
        default: 0
      responses:
        '200':
          description: OK
          schema:
            type: array
            items:
              $ref: '#/definitions/ImagePerformance'
        default:
          description: Error response
          schema:
            $ref: '#/definitions/CustomVisionError'
      x-ms-examples:
        Successful GetImagePerformances request:
          $ref: ./examples/GetImagePerformances.json
  /projects/{projectId}/iterations/{iterationId}/performance/images/count:
    get:
      tags:
      - ProjectApi
      summary: "Microsoft Azure Gets The Number Of Images Tagged With The Provided {tagids} That Have Prediction Results From\r\ntraining For The Provided Iteration {iterationid}"
      description: The filtering is on an and/or relationship. For example, if the provided tag ids are for the "Dog" and<br>"Cat" tags, then only images tagged with Dog and/or Cat will be returned
      operationId: microsoftAzureGetimageperformancecount
      consumes: []
      produces:
      - application/json
      - application/xml
      - text/xml
      parameters:
      - name: projectId
        in: path
        description: The project id.
        required: true
        type: string
        format: uuid
        x-nullable: false
      - name: iterationId
        in: path
        description: The iteration id. Defaults to workspace.
        required: true
        type: string
        format: uuid
        x-nullable: false
      - name: tagIds
        in: query
        description: A list of tags ids to filter the images to count. Defaults to all tags when null.
        required: false
        type: array
        items:
          type: string
          format: uuid
          x-nullable: false
        collectionFormat: csv
      responses:
        '200':
          description: OK
          schema:
            format: int32
            type: integer
        default:
          description: Error response
          schema:
            $ref: '#/definitions/CustomVisionError'
      x-ms-examples:
        Successful GetImagePerformanceCount request:
          $ref: ./examples/GetImagePerformanceCount.json
  /projects/{projectId}/iterations/{iterationId}/publish:
    post:
      tags:
      - ProjectApi
      summary: Microsoft Azure Publish A Specific Iteration
      operationId: microsoftAzurePublishiteration
      consumes: []
      produces:
      - application/json
      - application/xml
      - text/xml
      parameters:
      - name: projectId
        in: path
        description: The project id.
        required: true
        type: string
        format: uuid
        x-nullable: false
      - name: iterationId
        in: path
        description: The iteration id.
        required: true
        type: string
        format: uuid
        x-nullable: false
      - name: publishName
        in: query
        description: The name to give the published iteration.
        required: true
        type: string
      - name: predictionId
        in: query
        description: The id of the prediction resource to publish to.
        required: true
        type: string
      - name: overwrite
        in: query
        description: 'Whether to overwrite the published model with the given name (default: false).'
        required: false
        type: boolean
      responses:
        '200':
          description: OK
          schema:
            type: boolean
        default:
          description: Error response
          schema:
            $ref: '#/definitions/CustomVisionError'
      x-ms-examples:
        Successful PublishIteration request:
          $ref: ./examples/PublishIteration.json
      description: Needs a more full description created.
    delete:
      tags:
      - ProjectApi
      summary: Microsoft Azure Unpublish A Specific Iteration
      operationId: microsoftAzureUnpublishiteration
      consumes: []
      produces: []
      parameters:
      - name: projectId
        in: path
        description: The project id.
        required: true
        type: string
        format: uuid
        x-nullable: false
      - name: iterationId
        in: path
        description: The iteration id.
        required: true
        type: string
        format: uuid
        x-nullable: false
      responses:
        '204':
          description: No Content
        default:
          description: Error response
          schema:
            $ref: '#/definitions/CustomVisionError'
      x-ms-examples:
        Successful UnpublishIteration request:
          $ref: ./examples/UnpublishIteration.json
      description: Needs a more full description created.
  /projects/{projectId}/train:
    post:
      tags:
      - ProjectApi
      summary: Microsoft Azure Queues Project For Training
      operationId: microsoftAzureTrainproject
      consumes:
      - application/json
      - application/xml
      - text/xml
      - application/x-www-form-urlencoded
      produces:
      - application/json
      - application/xml
      - text/xml
      parameters:
      - name: projectId
        in: path
        description: The project id.
        required: true
        type: string
        format: uuid
        x-nullable: false
      - name: trainingType
        in: query
        description: 'The type of training to use to train the project (default: Regular).'
        required: false
        type: string
        enum:
        - Regular
        - Advanced
      - name: reservedBudgetInHours
        in: query
        description: The number of hours reserved as budget for training (if applicable).
        required: false
        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
        type: boolean
        default: false
      - name: notificationEmailAddress
        in: query
        description: 'The email address to send notification to when training finishes (default: null).'
        required: false
        type: string
      - name: trainingParameters
        in: body
        description: Additional training parameters passed in to control how the project is trained.
        required: false
        schema:
          $ref: '#/definitions/TrainingParameters'
        x-nullable: true
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/Iteration'
        default:
          description: Error response
          schema:
            $ref: '#/definitions/CustomVisionError'
      x-ms-examples:
        Successful TrainProject request:
          $ref: ./examples/TrainProject.json
      description: Needs a more full description created.
  /projects/import:
    post:
      tags:
      - ProjectApi
      summary: Microsoft Azure Imports A Project
      operationId: microsoftAzureImportproject
      consumes: []
      produces:
      - application/json
      - application/xml
      - text/xml
      parameters:
      - name: token
        in: query
        description: Token generated from the export project call.
        required: true
        type: string
      - name: name
        in: query
        description: Optional, name of the project to use instead of auto-generated name.
        required: false
        type: string
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/Project'
        default:
          description: Error response
          schema:
            $ref: '#/definitions/CustomVisionError'
      x-ms-examples:
        Successful ImportProject request:
          $ref: ./examples/ImportProject.json
      description: Needs a more full description created.
definitions:
  ImagePerformance:
    description: Image performance model.
    type: object
    properties:
      predictions:
        type: array
        items:
          $ref: '#/definitions/Prediction'
        readOnly: true
        x-nullable: true
      id:
        format: uuid
        type: string
        readOnly: true
        x-nullable: false
      created:
        format: date-time
        type: string
        readOnly: true
        x-nullable: false
      width:
        format: int32
        type: integer
        readOnly: true
        x-nullable: false
      height:
        format: int32
        type: integer
        readOnly: true
        x-nullable: false
      imageUri:
        type: string
        readOnly: true
      thumbnailUri:
        type: string
        readOnly: true
      tags:
        type: array
        items:
          $ref: '#/definitions/ImageTag'
        readOnly: true
        x-nullable: true
      regions:
        type: array
        items:
          $ref: '#/definitions/ImageRegion'
        readOnly: true
        x-nullable: true
  Prediction:
    description: Prediction result.
    type: object
    properties:
      probability:
        format: float
        description: Probability of the tag.
        type: number
        readOnly: true
        x-nullable: false
      tagId:
        format: uuid
        description: Id of the predicted tag.
        type: string
        readOnly: true
        x-nullable: false
      tagName:
        description: Name of the predicted tag.
        type: string
        readOnly: true
        x-nullable: true
      boundingBox:
        $ref: '#/definitions/BoundingBox'
        description: Bounding box of the prediction.
        readOnly: true
        x-nullable: true
      tagType:
        description: Type of the predicted tag.
        enum:
        - Regular
        - Negative
        - GeneralProduct
        type: string
        readOnly: true
        x-nullable: true
        x-ms-enum:
          name: TagType
          modelAsString: true
  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
        x-nullable: false
      classificationType:
        description: Gets or sets the classification type of the project.
        enum:
        - Multiclass
        - Multilabel
        type: string
        readOnly: false
        x-nullable: true
        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
          x-nullable: false
        readOnly: false
      useNegativeSet:
        description: Indicates if negative set is being used.
        type: boolean
        readOnly: true
        x-nullable: true
      detectionParameters:
        description: Detection parameters in use, if any.
        type: string
        readOnly: true
        x-nullable: false
      imageProcessingSettings:
        $ref: '#/definitions/ImageProcessingSettings'
        description: Gets or sets image preprocessing settings.
        readOnly: false
  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
        x-nullable: false
      name:
        description: Gets or sets the name of the iteration.
        type: string
        readOnly: false
        x-nullable: false
      status:
        description: Gets the current iteration status.
        type: string
        readOnly: true
        x-nullable: false
      created:
        format: date-time
        description: Gets the time this iteration was completed.
        type: string
        readOnly: true
        x-nullable: false
      lastModified:
        format: date-time
        description: Gets the time this iteration was last modified.
        type: string
        readOnly: true
        x-nullable: false
      trainedAt:
        format: date-time
        description: Gets the time this iteration was last modified.
        type: string
        readOnly: true
        x-nullable: true
      projectId:
        format: uuid
        description: Gets the project id of the iteration.
        type: string
        readOnly: true
        x-nullable: false
      exportable:
        description: Whether the iteration can be exported to another format for download.
        type: boolean
        readOnly: true
        x-nullable: false
      exportableTo:
        description: A set of platforms this iteration can export to.
        type: array
        items:
          enum:
          - CoreML
          - TensorFlow
          - DockerFile
          - ONNX
          - VAIDK
          type: string
          x-nullable: false
        readOnly: true
      domainId:
        format: uuid
        description: Get or sets a guid of the domain the iteration has been trained on.
        type: string
        readOnly: true
        x-nullable: true
      classificationType:
        description: Gets the classification type of the project.
        enum:
        - Multiclass
        - Multilabel
        type: string
        readOnly: true
        x-nullable: 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-nullable: false
        x-ms-enum:
          name: TrainingType
          modelAsString: true
      reservedBudgetInHours:
        format: int32
        description: Gets the reserved advanced training budget for the iteration.
        type: integer
        readOnly: true
        x-nullable: false
      trainingTimeInMinutes:
        format: int32
        description: Gets the training time for the iteration.
        type: integer
        readOnly: true
        x-nullable: false
      publishName:
        description: Name of the published model.
        type: string
        readOnly: true
        x-nullable: false
      originalPublishResourceId:
        description: Resource Provider Id this iteration was originally published to.
        type: string
        readOnly: true
        x-nullable: false
  ImageRegion:
    required:
    - tagId
    - left
    - top
    - width
    - height
    type: object
    properties:
      regionId:
        format: uuid
        type: string
        readOnly: true
        x-nullable: false
      tagName:
        type: string
        readOnly: true
        x-nullable: false
      created:
        format: date-time
        type: string
        readOnly: true
        x-nullable: false
      tagId:
        format: uuid
        description: Id of the tag associated with this region.
        type: string
        readOnly: false
        x-nullable: false
      left:
        format: float
        description: Coordinate of the left boundary.
        type: number
        readOnly: false
        x-nullable: false
      top:
        format: float
        description: Coordinate of the top boundary.
        type: number
        readOnly: false
        x-nullable: false
      width:
        format: float
        description: Width.
        type: number
        readOnly: false
        x-nullable: false
      height:
        format: float
        description: Height.
        type: number
        readOnly: false
        x-nullable: false
  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: '#/definitions/TagPerformance'
          x-nullable: false
        readOnly: true
      precision:
        format: float
        description: Gets the precision.
        type: number
        readOnly: true
        x-nullable: false
      precisionStdDeviation:
        format: float
        description: Gets the standard deviation for the precision.
        type: number
        readOnly: true
        x-nullable: false
      recall:
        format: float
        description: Gets the recall.
        type: number
        readOnly: true
        x-nullable: false
      recallStdDeviation:
        format: float
        description: Gets the standard deviation for the recall.
        type: number
        readOnly: true
        x-nullable: false
      averagePrecision:
        format: float
        description: Gets the average precision when applicable.
        type: number
        readOnly: true
        x-nullable: true
  Export:
    type: object
    properties:
      platform:
        description: Platform of the export.
        enum:
        - CoreML
        - TensorFlow
        - DockerFile
        - ONNX
        - VAIDK
        type: string
        readOnly: true
        x-nullable: false
        x-ms-enum:
          name: ExportPlatform
          modelAsString: true
      status:
        description: Status of the export.
        enum:
        - Exporting
        - Failed
        - Done
        type: string
        readOnly: true
        x-nullable: false
        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.\r\nDocker platform has valid flavors: Linux, Windows, ARM.\r\nTensorflow platform has valid flavors: TensorFlowNormal, TensorFlowLite.\r\nONNX platform has valid flavors: ONNX10, ONNX12."
        enum:
        - Linux
        - Windows
        - ONNX10
        - ONNX12
        - ARM
        - TensorFlowNormal
        - TensorFlowLite
        type: string
        readOnly: true
        x-nullable: 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
        x-nullable: false
  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
  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.\r\nAugmentation will be uniformly distributed among enabled transforms."
        type: object
        additionalProperties:
          type: boolean
        readOnly: false
        x-nullable: 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
        x-nullable: false
      name:
        description: Gets or sets the name of the project.
        type: string
        readOnly: false
        x-nullable: false
      description:
        description: Gets or sets the description of the project.
        type: string
        readOnly: false
        x-nullable: true
      settings:
        $ref: '#/definitions/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
        x-nullable: false
      lastModified:
        format: date-time
        description: Gets the date this project was last modified.
        type: string
        readOnly: true
        x-nullable: false
      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
        readOnly: true
        x-nullable: true
      status:
        description: Gets the status of the project.
        enum:
        - Succeeded
        - Importing
        - Failed
        type: string
        readOnly: false
        x-nullable: false
        x-ms-enum:
          name: ProjectStatus
          modelAsString: true
  TagPerformance:
    description: Represents performance data for a particular tag in a trained iteration.
    type: object
    properties:
      id:
        format: uuid
        type: string
        readOnly: true
        x-nullable: false
      name:
        type: string
        readOnly: true
        x-nullable: false
      precision:
        format: float
        description: Gets the precision.
        type: number
        readOnly: true
        x-nullable: false
      precisionStdDeviation:
        format: float
        description: Gets the standard deviation for the precision.
        type: number
        readOnly: true
        x-nullable: false
      recall:
        format: float
        description: Gets the recall.
        type: number
        readOnly: true
        x-nullable: false
      recallStdDeviation:
        format: float
        description: Gets the standard deviation for the recall.
        type: number
        readOnly: true
        x-nullable: false
      averagePrecision:
        format: float
        description: Gets the average precision when applicable.
        type: number
        readOnly: true
        x-nullable: 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
        x-nullable: false
      top:
        format: float
        description: Coordinate of the top boundary.
        type: number
        readOnly: false
        x-nullable: false
      width:
        format: float
        description: Width.
        type: number
        readOnly: false
        x-nullable: false
      height:
        format: float
        description: Height.
        type: number
        readOnly: false
        x-nullable: false
  ImageTag:
    type: object
    properties:
      tagId:
        format: uuid
        type: string
        readOnly: true
        x-nullable: false
      tagName:
        type: string
        readOnly: true
        x-nullable: false
      created:
        format: date-time
        type: string
        readOnly: true
        x-nullable: false
  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
        x-nullable: false
      imageCount:
        format: int32
        description: Count of images that will be exported.
        type: integer
        readOnly: true
        x-nullable: false
      tagCount:
        format: int32
        description: Count of tags that will be exported.
        type: integer
        readOnly: true
        x-nullable: false
      regionCount:
        format: int32
        description: Count of regions that will be exported.
        type: integer
        readOnly: true
        x-nullable: false
      estimatedImportTimeInMS:
        format: int32
        description: "Estimated time this project will take to import, can change based on network connectivity and load between\r\nsource and destination regions."
        type: integer
        readOnly: true
        x-nullable: false
      token:
        description: "Opaque token that should be passed to ImportProject to perform the import. This token grants access to import this\r\nproject to all that have the token."
        type: string
        readOnly: true
        x-nullable: false
  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
          x-nullable: false
        readOnly: false
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'