Microsoft Azure ImageModeration API

swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector ImageModeration API
schemes:
- https
tags:
- name: ImageModeration
paths:
  /contentmoderator/moderate/v1.0/ProcessImage/FindFaces:
    post:
      tags:
      - ImageModeration
      operationId: microsoftAzureImagemoderationFindfaces
      description: Returns the list of faces found.
      parameters:
      - $ref: '#/parameters/CacheImage'
      consumes:
      - application/json
      - image/gif
      - image/jpeg
      - image/png
      - image/bmp
      - image/tiff
      responses:
        '200':
          description: List of faces found.
          schema:
            $ref: '#/definitions/FoundFaces'
        default:
          description: Error response.
          schema:
            $ref: '#/definitions/APIError'
      produces:
      - application/json
      summary: Microsoft Azure Post Contentmoderator Moderate 0 Processimage Findfaces
  /contentmoderator/moderate/v1.0/ProcessImage/OCR:
    post:
      tags:
      - ImageModeration
      operationId: microsoftAzureImagemoderationOcr
      description: Returns any text found in the image for the specified language. If no language is specified in the input, the detection defaults to English.
      parameters:
      - $ref: '#/parameters/language'
      - $ref: '#/parameters/CacheImage'
      - $ref: '#/parameters/enhanced'
      consumes:
      - application/json
      - image/gif
      - image/jpeg
      - image/png
      - image/bmp
      - image/tiff
      responses:
        '200':
          description: Text found and list of candidate text details.
          schema:
            $ref: '#/definitions/OCR'
        default:
          description: Error response.
          schema:
            $ref: '#/definitions/APIError'
      produces:
      - application/json
      summary: Microsoft Azure Post Contentmoderator Moderate 0 Processimage Ocr
  /contentmoderator/moderate/v1.0/ProcessImage/Evaluate:
    post:
      tags:
      - ImageModeration
      operationId: microsoftAzureImagemoderationEvaluate
      description: Returns probabilities of the image containing racy or adult content.
      parameters:
      - $ref: '#/parameters/CacheImage'
      consumes:
      - application/json
      - image/gif
      - image/jpeg
      - image/png
      - image/bmp
      - image/tiff
      responses:
        '200':
          description: ''
          schema:
            $ref: '#/definitions/Evaluate'
        default:
          description: Error response.
          schema:
            $ref: '#/definitions/APIError'
      produces:
      - application/json
      summary: Microsoft Azure Post Contentmoderator Moderate 0 Processimage Evaluate
  /contentmoderator/moderate/v1.0/ProcessImage/Match:
    post:
      tags:
      - ImageModeration
      operationId: microsoftAzureImagemoderationMatch
      description: 'Fuzzily match an image against one of your custom image lists. You can create and manage your custom image lists by using this API. <br><br>Returns the ID and tags of a matching image.<br><br>Note: You must refresh the index on the corresponding image list to ensure that additions and removals are reflected in the response.'
      parameters:
      - $ref: '#/parameters/listIdQueryParameter'
      - $ref: '#/parameters/CacheImage'
      consumes:
      - application/json
      - image/gif
      - image/jpeg
      - image/png
      - image/bmp
      - image/tiff
      responses:
        '200':
          description: "Supported values for tags are:\r\n<ul>\r\n<li>101: Nudity</li>\r\n<li>102: Sexual Content</li>\r\n<li>201: Alcohol</li>\r\n<li>202: Tobacco</li>\r\n<li>203: Drugs</li>\r\n<li>301: Child Exploitation</li>\r\n<li>401: Violence</li>\r\n<li>402: Weapons</li>\r\n<li>403: Gore</li>\r\n<li>501: Profanity</li>\r\n<li>502: Vulgarity</li>\r\n</ul>."
          schema:
            $ref: '#/definitions/MatchResponse'
        default:
          description: Error response.
          schema:
            $ref: '#/definitions/APIError'
      produces:
      - application/json
      summary: Microsoft Azure Post Contentmoderator Moderate 0 Processimage Match
definitions:
  FoundFaces:
    description: Request object that contains found faces.
    properties:
      Status:
        description: Evaluation status.
        $ref: '#/definitions/Status'
      TrackingId:
        description: Tracking ID.
        type: string
      CacheId:
        description: Cache ID.
        type: string
      Result:
        description: True if a result was found.
        type: boolean
      Count:
        description: Number of faces found.
        type: integer
      AdvancedInfo:
        description: Advanced info.
        type: array
        items:
          $ref: '#/definitions/KeyValuePair'
      Faces:
        description: List of faces.
        type: array
        items:
          $ref: '#/definitions/Face'
  APIError:
    type: object
    description: Error information that the API returns.
    properties:
      Error:
        $ref: '#/definitions/Error'
  MatchResponse:
    description: Response for a match request.
    properties:
      TrackingId:
        description: Tracking ID.
        type: string
      CacheID:
        description: Cache ID.
        type: string
      IsMatch:
        description: Indicates if there is a match.
        type: boolean
      Matches:
        description: Match details.
        type: array
        items:
          $ref: '#/definitions/Match'
      Status:
        description: Evaluation status.
        $ref: '#/definitions/Status'
  KeyValuePair:
    description: Key/value pair object properties.
    properties:
      Key:
        description: Key parameter.
        type: string
      Value:
        description: Value parameter.
        type: string
  Evaluate:
    description: Evaluation response object.
    properties:
      CacheID:
        description: Cache ID.
        type: string
      Result:
        description: Evaluation result.
        type: boolean
      TrackingId:
        description: Tracking ID.
        type: string
      AdultClassificationScore:
        description: Adult classification score.
        type: number
      IsImageAdultClassified:
        description: Indicates if an image is classified as adult.
        type: boolean
      RacyClassificationScore:
        description: Racy classification score.
        type: number
      IsImageRacyClassified:
        description: Indicates if the image is classified as racy.
        type: boolean
      AdvancedInfo:
        description: Advanced info.
        type: array
        items:
          $ref: '#/definitions/KeyValuePair'
      Status:
        description: Evaluation status.
        $ref: '#/definitions/Status'
  Status:
    description: Status properties.
    properties:
      Code:
        description: Status code.
        type: integer
      Description:
        description: Status description.
        type: string
      Exception:
        description: Exception status.
        type: string
  Face:
    description: Coordinates to the found face.
    properties:
      Bottom:
        description: Bottom coordinate.
        type: integer
      Left:
        description: Left coordinate.
        type: integer
      Right:
        description: Right coordinate.
        type: integer
      Top:
        description: Top coordinate.
        type: integer
  OCR:
    description: Contains the text found in an image for the specified language.
    properties:
      Status:
        description: Evaluation status.
        $ref: '#/definitions/Status'
      Metadata:
        description: Array of key/value pairs.
        type: array
        items:
          $ref: '#/definitions/KeyValuePair'
      TrackingId:
        description: Tracking ID.
        type: string
      CacheId:
        description: Cache ID.
        type: string
      Language:
        description: ISO 639-3 code.
        type: string
      Text:
        description: Found text.
        type: string
      Candidates:
        description: List of candidate text.
        type: array
        items:
          $ref: '#/definitions/Candidate'
  Match:
    description: Match details.
    properties:
      Score:
        description: Confidence score of the image match.
        type: number
      MatchId:
        description: Match ID.
        type: integer
      Source:
        description: Source.
        type: string
      Tags:
        description: Tags for match details.
        type: array
        items:
          type: integer
      Label:
        description: Label.
        type: string
  Candidate:
    description: Optical character recognition (OCR) candidate text.
    properties:
      Text:
        description: Text found.
        type: string
      Confidence:
        description: Confidence level.
        type: number
  Error:
    type: object
    description: Error body.
    properties:
      Code:
        type: string
      Message:
        type: string
parameters:
  CacheImage:
    name: CacheImage
    in: query
    description: Whether to retain the submitted image for future use. If it's omitted, the default is false.
    type: boolean
    x-ms-parameter-location: method
  listIdQueryParameter:
    name: listId
    in: query
    description: List ID.
    type: string
    x-ms-parameter-location: method
  enhanced:
    name: enhanced
    in: query
    description: 'When it''s set to true, the image goes through additional processing to come with additional candidates.


      The image or TIFF file is not supported when enhanced is set to true.


      Note: This affects the response time.'
    type: boolean
    default: false
    x-ms-parameter-location: method
  language:
    name: language
    in: query
    description: Language of the terms.
    required: true
    type: string
    x-ms-parameter-location: method
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'