swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector ImageRegionProposalApi API
schemes:
- https
tags:
- name: ImageRegionProposalApi
paths:
  /projects/{projectId}/images/{imageId}/regionproposals:
    post:
      tags:
      - ImageRegionProposalApi
      summary: Microsoft Azure Get Region Proposals For An Image Returns Empty Array If No Proposals Are Found
      description: This API will get region proposals for an image along with confidences for the region. It returns an empty array if no proposals are found.
      operationId: microsoftAzureGetimageregionproposals
      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: imageId
        in: path
        description: The image id.
        required: true
        type: string
        format: uuid
        x-nullable: false
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/ImageRegionProposal'
        default:
          description: Error response
          schema:
            $ref: '#/definitions/CustomVisionError'
      x-ms-examples:
        Successful GetImageRegionProposals request:
          $ref: ./examples/GetImageRegionProposals.json
  /{projectId}/images/{imageId}/regionproposals:
    post:
      tags:
      - ImageRegionProposalApi
      summary: Microsoft Azure Get Region Proposals For An Image Returns Empty Array If No Proposals Are Found
      description: This API will get region proposals for an image along with confidences for the region. It returns an empty array if no proposals are found.
      operationId: microsoftAzureGetimageregionproposals
      consumes: []
      produces:
      - application/json
      - text/json
      parameters:
      - name: projectId
        in: path
        description: The project id
        required: true
        type: string
        format: uuid
        x-nullable: false
      - name: imageId
        in: path
        description: The image id
        required: true
        type: string
        format: uuid
        x-nullable: false
      - $ref: '#/parameters/ApiKey'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/ImageRegionProposal_2'
      x-ms-examples:
        Successful GetImageRegionProposals request:
          $ref: ./examples/GetImageRegionProposals.json
definitions:
  RegionProposal:
    type: object
    properties:
      confidence:
        format: float
        type: number
        readOnly: true
        x-nullable: false
      boundingBox:
        $ref: '#/definitions/BoundingBox'
        readOnly: true
  ImageRegionProposal_2:
    type: object
    properties:
      projectId:
        format: uuid
        type: string
        readOnly: true
        x-nullable: false
      imageId:
        format: uuid
        type: string
        readOnly: true
        x-nullable: false
      proposals:
        type: array
        items:
          $ref: '#/definitions/RegionProposal_2'
        readOnly: true
        x-nullable: true
    x-nullable: 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
  BoundingBox_2:
    type: object
    properties:
      left:
        format: float
        type: number
        x-nullable: false
      top:
        format: float
        type: number
        x-nullable: false
      width:
        format: float
        type: number
        x-nullable: false
      height:
        format: float
        type: number
        x-nullable: false
    x-nullable: true
  RegionProposal_2:
    type: object
    properties:
      confidence:
        format: float
        type: number
        readOnly: true
        x-nullable: false
      boundingBox:
        $ref: '#/definitions/BoundingBox_2'
        readOnly: true
    x-nullable: true
  ImageRegionProposal:
    type: object
    properties:
      projectId:
        format: uuid
        type: string
        readOnly: true
        x-nullable: false
      imageId:
        format: uuid
        type: string
        readOnly: true
        x-nullable: false
      proposals:
        type: array
        items:
          $ref: '#/definitions/RegionProposal'
          x-nullable: false
        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
        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
parameters:
  ApiKey:
    name: Training-Key
    in: header
    required: true
    type: string
    x-ms-client-name: ApiKey
    x-ms-parameter-location: client
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'