swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector PredictionsApi API
schemes:
- https
tags:
- name: PredictionsApi
paths:
  /projects/{projectId}/predictions:
    delete:
      tags:
      - PredictionsApi
      summary: Microsoft Azure Delete A Set Of Predicted Images And Their Associated Prediction Results
      operationId: microsoftAzureDeleteprediction
      consumes: []
      produces: []
      parameters:
      - name: projectId
        in: path
        description: The project id.
        required: true
        type: string
        format: uuid
        x-nullable: false
      - name: ids
        in: query
        description: The prediction ids. Limited to 64.
        required: true
        type: array
        items:
          type: string
          format: uuid
          x-nullable: false
        collectionFormat: csv
        maxItems: 64
        minItems: 0
      responses:
        '204':
          description: No Content
        default:
          description: Error response
          schema:
            $ref: '#/definitions/CustomVisionError'
      x-ms-examples:
        Successful DeletePrediction request:
          $ref: ./examples/DeletePrediction.json
      description: Needs a more full description created.
  /projects/{projectId}/predictions/query:
    post:
      tags:
      - PredictionsApi
      summary: Microsoft Azure Get Images That Were Sent To Your Prediction Endpoint
      operationId: microsoftAzureQuerypredictions
      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: query
        in: body
        description: Parameters used to query the predictions. Limited to combining 2 tags.
        required: true
        schema:
          $ref: '#/definitions/PredictionQueryToken'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/PredictionQueryResult'
        default:
          description: Error response
          schema:
            $ref: '#/definitions/CustomVisionError'
      x-ms-examples:
        Successful QueryPredictions request:
          $ref: ./examples/QueryPredictions.json
      description: Needs a more full description created.
  /projects/{projectId}/quicktest/image:
    post:
      tags:
      - PredictionsApi
      summary: Microsoft Azure Quick Test An Image
      operationId: microsoftAzureQuicktestimage
      consumes:
      - multipart/form-data
      - application/octet-stream
      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: query
        description: "Optional. Specifies the id of a particular iteration to evaluate against.\r\n            The default iteration for the project will be used when not specified."
        required: false
        type: string
        format: uuid
      - name: store
        in: query
        description: Optional. Specifies whether or not to store the result of this prediction. The default is true, to store.
        required: false
        type: boolean
        default: true
      - name: imageData
        in: formData
        description: Binary image data. Supported formats are JPEG, GIF, PNG, and BMP. Supports images up to 6MB.
        required: true
        type: file
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/ImagePrediction'
        default:
          description: Error response
          schema:
            $ref: '#/definitions/CustomVisionError'
      x-ms-examples:
        Successful QuickTestImage request:
          $ref: ./examples/QuickTestImage.json
      description: Needs a more full description created.
  /projects/{projectId}/quicktest/url:
    post:
      tags:
      - PredictionsApi
      summary: Microsoft Azure Quick Test An Image Url
      operationId: microsoftAzureQuicktestimageurl
      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 to evaluate against.
        required: true
        type: string
        format: uuid
        x-nullable: false
      - name: imageUrl
        in: body
        description: An ImageUrl that contains the url of the image to be evaluated.
        required: true
        schema:
          $ref: '#/definitions/ImageUrl'
      - name: iterationId
        in: query
        description: "Optional. Specifies the id of a particular iteration to evaluate against.\r\n            The default iteration for the project will be used when not specified."
        required: false
        type: string
        format: uuid
      - name: store
        in: query
        description: Optional. Specifies whether or not to store the result of this prediction. The default is true, to store.
        required: false
        type: boolean
        default: true
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/ImagePrediction'
        default:
          description: Error response
          schema:
            $ref: '#/definitions/CustomVisionError'
      x-ms-examples:
        Successful QuickTestImageUrl request:
          $ref: ./examples/QuickTestImageUrl.json
      description: Needs a more full description created.
definitions:
  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
  StoredImagePrediction:
    description: Result of an image prediction request.
    type: object
    properties:
      resizedImageUri:
        description: The URI to the (resized) prediction 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
      thumbnailUri:
        description: The URI to the thumbnail of the original prediction 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
      originalImageUri:
        description: The URI to the original prediction 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
      domain:
        format: uuid
        description: Domain used for the prediction.
        type: string
        readOnly: true
        x-nullable: false
      id:
        format: uuid
        description: Prediction Id.
        type: string
        readOnly: true
        x-nullable: false
      project:
        format: uuid
        description: Project Id.
        type: string
        readOnly: true
        x-nullable: false
      iteration:
        format: uuid
        description: Iteration Id.
        type: string
        readOnly: true
        x-nullable: false
      created:
        format: date-time
        description: Date this prediction was created.
        type: string
        readOnly: true
        x-nullable: false
      predictions:
        description: List of predictions.
        type: array
        items:
          $ref: '#/definitions/Prediction'
          x-nullable: false
        readOnly: true
  PredictionQueryTag:
    type: object
    properties:
      id:
        format: uuid
        type: string
        readOnly: false
        x-nullable: false
      minThreshold:
        format: float
        type: number
        readOnly: false
        x-nullable: false
      maxThreshold:
        format: float
        type: number
        readOnly: false
        x-nullable: false
  PredictionQueryResult:
    description: Query result of the prediction images that were sent to your prediction endpoint.
    type: object
    properties:
      token:
        $ref: '#/definitions/PredictionQueryToken'
        description: Prediction Query Token.
        readOnly: false
      results:
        description: Result of an image prediction request.
        type: array
        items:
          $ref: '#/definitions/StoredImagePrediction'
          x-nullable: false
        readOnly: true
  ImageUrl:
    description: Image url.
    required:
    - url
    type: object
    properties:
      url:
        description: Url of the image.
        type: string
        readOnly: false
        x-nullable: false
  ImagePrediction:
    description: Result of an image prediction request.
    type: object
    properties:
      id:
        format: uuid
        description: Prediction Id.
        type: string
        readOnly: true
        x-nullable: false
      project:
        format: uuid
        description: Project Id.
        type: string
        readOnly: true
        x-nullable: false
      iteration:
        format: uuid
        description: Iteration Id.
        type: string
        readOnly: true
        x-nullable: false
      created:
        format: date-time
        description: Date this prediction was created.
        type: string
        readOnly: true
        x-nullable: false
      predictions:
        description: List of predictions.
        type: array
        items:
          $ref: '#/definitions/Prediction'
          x-nullable: false
        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
  PredictionQueryToken:
    type: object
    properties:
      session:
        type: string
        readOnly: false
        x-nullable: false
      continuation:
        type: string
        readOnly: false
        x-nullable: false
      maxCount:
        format: int32
        type: integer
        readOnly: false
        x-nullable: false
      orderBy:
        enum:
        - Newest
        - Oldest
        - Suggested
        type: string
        readOnly: false
        x-nullable: false
        x-ms-enum:
          name: OrderBy
          modelAsString: true
      tags:
        type: array
        items:
          $ref: '#/definitions/PredictionQueryTag'
          x-nullable: false
        readOnly: false
      iterationId:
        format: uuid
        type: string
        readOnly: false
        x-nullable: true
      startTime:
        format: date-time
        type: string
        readOnly: false
        x-nullable: true
      endTime:
        format: date-time
        type: string
        readOnly: false
        x-nullable: true
      application:
        type: string
        readOnly: false
        x-nullable: false
  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
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'