Microsoft Azure ImageModeration API

openapi: 3.2.0
info:
  title: Microsoft Azure Content Moderator Client Image Moderation…
  version: '1.0'
  description: You use the API to scan your content as it's generated.
security:
- apim_key: []
tags:
- name: ImageModeration
paths:
  /contentmoderator/moderate/v1.0/ProcessImage/FindFaces:
    post:
      tags:
      - ImageModeration
      operationId: microsoftAzureImagemoderationFindfaces
      description: Returns the list of faces found.
      parameters:
      - $ref: '#/components/parameters/CacheImage'
      responses:
        '200':
          description: List of faces found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FoundFaces'
        default:
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
      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: '#/components/parameters/language'
      - $ref: '#/components/parameters/CacheImage'
      - $ref: '#/components/parameters/enhanced'
      responses:
        '200':
          description: Text found and list of candidate text details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OCR'
        default:
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
      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: '#/components/parameters/CacheImage'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Evaluate'
        default:
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
      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.


        Returns the ID and tags of a matching image.


        Note: You must refresh the index on the corresponding image list to ensure that additions and removals are reflected in the response.'
      parameters:
      - $ref: '#/components/parameters/listIdQueryParameter'
      - $ref: '#/components/parameters/CacheImage'
      responses:
        '200':
          description: 'Supported values for tags are:

            <ul>

            <li>101: Nudity</li>

            <li>102: Sexual Content</li>

            <li>201: Alcohol</li>

            <li>202: Tobacco</li>

            <li>203: Drugs</li>

            <li>301: Child Exploitation</li>

            <li>401: Violence</li>

            <li>402: Weapons</li>

            <li>403: Gore</li>

            <li>501: Profanity</li>

            <li>502: Vulgarity</li>

            </ul>.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MatchResponse'
        default:
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
      summary: Microsoft Azure Post Contentmoderator Moderate 0 Processimage Match
components:
  schemas:
    APIError:
      type: object
      description: Error information that the API returns.
      properties:
        Error:
          $ref: '#/components/schemas/Error'
    Status:
      description: Status properties.
      properties:
        Code:
          description: Status code.
          type: integer
        Description:
          description: Status description.
          type: string
        Exception:
          description: Exception status.
          type: string
    KeyValuePair:
      description: Key/value pair object properties.
      properties:
        Key:
          description: Key parameter.
          type: string
        Value:
          description: Value parameter.
          type: string
    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: '#/components/schemas/Match'
        Status:
          description: Evaluation status.
          $ref: '#/components/schemas/Status'
    Candidate:
      description: Optical character recognition (OCR) candidate text.
      properties:
        Text:
          description: Text found.
          type: string
        Confidence:
          description: Confidence level.
          type: number
    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: '#/components/schemas/KeyValuePair'
        Status:
          description: Evaluation status.
          $ref: '#/components/schemas/Status'
    OCR:
      description: Contains the text found in an image for the specified language.
      properties:
        Status:
          description: Evaluation status.
          $ref: '#/components/schemas/Status'
        Metadata:
          description: Array of key/value pairs.
          type: array
          items:
            $ref: '#/components/schemas/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: '#/components/schemas/Candidate'
    FoundFaces:
      description: Request object that contains found faces.
      properties:
        Status:
          description: Evaluation status.
          $ref: '#/components/schemas/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: '#/components/schemas/KeyValuePair'
        Faces:
          description: List of faces.
          type: array
          items:
            $ref: '#/components/schemas/Face'
    Error:
      type: object
      description: Error body.
      properties:
        Code:
          type: string
        Message:
          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
    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
  parameters:
    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.'
      x-ms-parameter-location: method
      schema:
        type: boolean
        default: false
    language:
      name: language
      in: query
      description: Language of the terms.
      required: true
      x-ms-parameter-location: method
      schema:
        type: string
    listIdQueryParameter:
      name: listId
      in: query
      description: List ID.
      x-ms-parameter-location: method
      schema:
        type: string
    CacheImage:
      name: CacheImage
      in: query
      description: Whether to retain the submitted image for future use. If it's omitted, the default is false.
      x-ms-parameter-location: method
      schema:
        type: boolean
  securitySchemes:
    apim_key:
      type: apiKey
      name: Ocp-Apim-Subscription-Key
      in: header
x-ms-parameterized-host:
  hostTemplate: '{Endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/components/parameters/Endpoint'
x-ms-paths:
  /contentmoderator/moderate/v1.0/ProcessImage/FindFaces?overload=stream:
    post:
      tags:
      - ImageModeration
      operationId: ImageModeration_FindFacesFileInput
      description: Returns the list of faces found.
      parameters:
      - $ref: '#/components/parameters/CacheImage'
      - $ref: '#/components/parameters/ImageStreamParameter'
      consumes:
      - image/gif
      - image/jpeg
      - image/png
      - image/bmp
      - image/tiff
      responses:
        '200':
          description: List of faces found.
          schema:
            $ref: '#/components/schemas/FoundFaces'
        default:
          description: Error response.
          schema:
            $ref: '#/components/schemas/APIError'
      produces:
      - application/json
  /contentmoderator/moderate/v1.0/ProcessImage/FindFaces?overload=url:
    post:
      tags:
      - ImageModeration
      operationId: ImageModeration_FindFacesUrlInput
      description: Returns the list of faces found.
      parameters:
      - $ref: '#/components/parameters/CacheImage'
      - name: Content-Type
        description: Content type.
        required: true
        type: string
        in: header
      - $ref: '#/components/parameters/ImageUrlParameter'
      consumes:
      - application/json
      responses:
        '200':
          description: List of faces found.
          schema:
            $ref: '#/components/schemas/FoundFaces'
        default:
          description: Error response.
          schema:
            $ref: '#/components/schemas/APIError'
      x-ms-examples:
        Find Faces request:
          $ref: ./examples/FindFacesResource.JSON
      produces:
      - application/json
  /contentmoderator/moderate/v1.0/ProcessImage/OCR?overload=url:
    post:
      tags:
      - ImageModeration
      operationId: ImageModeration_OCRUrlInput
      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: '#/components/parameters/language'
      - $ref: '#/components/parameters/CacheImage'
      - $ref: '#/components/parameters/enhanced'
      - name: Content-Type
        description: Content type.
        required: true
        type: string
        in: header
      - $ref: '#/components/parameters/ImageUrlParameter'
      consumes:
      - application/json
      responses:
        '200':
          description: Found text and list of candidate text.
          schema:
            $ref: '#/components/schemas/OCR'
        default:
          description: Error response.
          schema:
            $ref: '#/components/schemas/APIError'
      x-ms-examples:
        Image OCR request:
          $ref: ../v1.0/examples/OCRResource.JSON
      produces:
      - application/json
  /contentmoderator/moderate/v1.0/ProcessImage/OCR?overload=stream:
    post:
      tags:
      - ImageModeration
      operationId: ImageModeration_OCRFileInput
      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: '#/components/parameters/language'
      - $ref: '#/components/parameters/CacheImage'
      - $ref: '#/components/parameters/enhanced'
      - $ref: '#/components/parameters/ImageStreamParameter'
      consumes:
      - image/gif
      - image/jpeg
      - image/png
      - image/bmp
      - image/tiff
      responses:
        '200':
          description: Found text and list of candidate text.
          schema:
            $ref: '#/components/schemas/OCR'
        default:
          description: Error response.
          schema:
            $ref: '#/components/schemas/APIError'
      produces:
      - application/json
  /contentmoderator/moderate/v1.0/ProcessImage/Evaluate?overload=stream:
    post:
      tags:
      - ImageModeration
      operationId: ImageModeration_EvaluateFileInput
      description: Returns probabilities of the image containing racy or adult content.
      parameters:
      - $ref: '#/components/parameters/CacheImage'
      - $ref: '#/components/parameters/ImageStreamParameter'
      consumes:
      - image/gif
      - image/jpeg
      - image/png
      - image/bmp
      - image/tiff
      responses:
        '200':
          description: ''
          schema:
            $ref: '#/components/schemas/Evaluate'
        default:
          description: Error response.
          schema:
            $ref: '#/components/schemas/APIError'
      produces:
      - application/json
  /contentmoderator/moderate/v1.0/ProcessImage/Evaluate?overload=url:
    post:
      tags:
      - ImageModeration
      operationId: ImageModeration_EvaluateUrlInput
      description: Returns probabilities of the image containing racy or adult content.
      parameters:
      - $ref: '#/components/parameters/CacheImage'
      - name: Content-Type
        description: Content type.
        required: true
        type: string
        in: header
      - $ref: '#/components/parameters/ImageUrlParameter'
      consumes:
      - application/json
      responses:
        '200':
          description: ''
          schema:
            $ref: '#/components/schemas/Evaluate'
        default:
          description: Error response.
          schema:
            $ref: '#/components/schemas/APIError'
      x-ms-examples:
        Evaluate Image request:
          $ref: ./examples/EvaluateImageResource.JSON
      produces:
      - application/json
  /contentmoderator/moderate/v1.0/ProcessImage/Match?overload=url:
    post:
      tags:
      - ImageModeration
      operationId: ImageModeration_MatchUrlInput
      description: "Fuzzily match an image against one of your custom image lists. You can create and manage your custom image lists by using <a href=\"/docs/services/578ff44d2703741568569ab9/operations/578ff7b12703741568569abe\">this API</a>. \n\nReturns the ID and tags of a matching image.<br/>\n<br/>\nNote: You must refresh the index on the corresponding image list to ensure that additions and removals are reflected in the response."
      parameters:
      - $ref: '#/components/parameters/listIdQueryParameter'
      - $ref: '#/components/parameters/CacheImage'
      - name: Content-Type
        description: Content type.
        required: true
        type: string
        in: header
      - $ref: '#/components/parameters/ImageUrlParameter'
      consumes:
      - application/json
      responses:
        '200':
          description: 'Supported values for tags are:

            <ul>

            <li>101: Nudity</li>

            <li>102: Sexual Content</li>

            <li>201: Alcohol</li>

            <li>202: Tobacco</li>

            <li>203: Drugs</li>

            <li>301: Child Exploitation</li>

            <li>401: Violence</li>

            <li>402: Weapons</li>

            <li>403: Gore</li>

            <li>501: Profanity</li>

            <li>502: Vulgarity</li>

            </ul>.'
          schema:
            $ref: '#/components/schemas/MatchResponse'
        default:
          description: Error response.
          schema:
            $ref: '#/components/schemas/APIError'
      x-ms-examples:
        Match Image request:
          $ref: ../v1.0/examples/MatchImageResource.JSON
      produces:
      - application/json
  /contentmoderator/moderate/v1.0/ProcessImage/Match?overload=stream:
    post:
      tags:
      - ImageModeration
      operationId: ImageModeration_MatchFileInput
      description: "Fuzzily match an image against one of your custom image lists. You can create and manage your custom image lists by using <a href=\"/docs/services/578ff44d2703741568569ab9/operations/578ff7b12703741568569abe\">this API</a>. \n\nReturns the ID and tags of a matching image.<br/>\n<br/>\nNote: You must refresh the index on the corresponding image list to ensure that additions and removals are reflected in the response."
      parameters:
      - $ref: '#/components/parameters/listIdQueryParameter'
      - $ref: '#/components/parameters/CacheImage'
      - $ref: '#/components/parameters/ImageStreamParameter'
      consumes:
      - image/gif
      - image/jpeg
      - image/png
      - image/bmp
      - image/tiff
      responses:
        '200':
          description: 'Supported values for tags are:

            <ul>

            <li>101: Nudity</li>

            <li>102: Sexual Content</li>

            <li>201: Alcohol</li>

            <li>202: Tobacco</li>

            <li>203: Drugs</li>

            <li>301: Child Exploitation</li>

            <li>401: Violence</li>

            <li>402: Weapons</li>

            <li>403: Gore</li>

            <li>501: Profanity</li>

            <li>502: Vulgarity</li>

            </ul>.'
          schema:
            $ref: '#/components/schemas/MatchResponse'
        default:
          description: Error response.
          schema:
            $ref: '#/components/schemas/APIError'
      produces:
      - application/json
  /contentmoderator/lists/v1.0/imagelists/{listId}/images?overload=url:
    post:
      tags:
      - ListManagementImage
      operationId: ListManagementImage_AddImageUrlInput
      description: Add an image to the list with listId equal to the passed list ID.
      parameters:
      - $ref: '#/components/parameters/listId'
      - $ref: '#/components/parameters/tag'
      - $ref: '#/components/parameters/label'
      - name: Content-Type
        description: Content type.
        required: true
        type: string
        in: header
      - $ref: '#/components/parameters/ImageUrlParameter'
      consumes:
      - application/json
      responses:
        '200':
          description: OK.
          schema:
            $ref: '#/components/schemas/Image'
        default:
          description: Error response.
          schema:
            $ref: '#/components/schemas/APIError'
      x-ms-examples:
        Add Image request:
          $ref: ./examples/AddImageResource.JSON
      produces:
      - application/json
  /contentmoderator/lists/v1.0/imagelists/{listId}/images?overload=stream:
    post:
      tags:
      - ListManagementImage
      operationId: ListManagementImage_AddImageFileInput
      description: Add an image to the list with listId equal to the passed list ID.
      parameters:
      - $ref: '#/components/parameters/listId'
      - $ref: '#/components/parameters/tag'
      - $ref: '#/components/parameters/label'
      - $ref: '#/components/parameters/ImageStreamParameter'
      consumes:
      - image/gif
      - image/jpeg
      - image/png
      - image/bmp
      - image/tiff
      responses:
        '200':
          description: OK.
          schema:
            $ref: '#/components/schemas/Image'
        default:
          description: Error response.
          schema:
            $ref: '#/components/schemas/APIError'
      produces:
      - application/json
  /contentmoderator/review/v1.0/teams/{teamName}/reviews?overload=video:
    post:
      tags:
      - Reviews
      operationId: Reviews_CreateVideoReviews
      description: "The created reviews appear for reviewers on your team. As reviewers finish reviewing, results of the reviews are posted (that is, HTTP POST) on the specified CallBackEndpoint value.\n\n<h3>CallBack Schemas </h3>\n<h4>Review Completion CallBack Sample</h4>\n<p>\n{<br/>\n  \"ReviewId\": \"<Review ID>\",<br/>\n  \"ModifiedOn\": \"2016-10-11T22:36:32.9934851Z\",<br/>\n  \"ModifiedBy\": \"<Name of the reviewer>\",<br/>\n  \"CallBackType\": \"Review\",<br/>\n  \"ContentId\": \"<ContentId that was specified on input>\",<br/>\n  \"Metadata\": {<br/>\n    \"adultscore\": \"0.xxx\",<br/>\n    \"a\": \"False\",<br/>\n    \"racyscore\": \"0.xxx\",<br/>\n    \"r\": \"True\"<br/>\n  },<br/>\n  \"ReviewerResultTags\": {<br/>\n    \"a\": \"False\",<br/>\n    \"r\": \"True\"<br/>\n  }<br/>\n}<br/>\n\n</p>."
      parameters:
      - name: Content-Type
        description: Content type.
        required: true
        type: string
        in: header
      - $ref: '#/components/parameters/teamName'
      - $ref: '#/components/parameters/subTeam'
      - $ref: '#/components/parameters/CreateVideoReviewsBody'
      consumes:
      - application/json
      responses:
        '200':
          description: OK.
          schema:
            $ref: '#/components/schemas/ReviewList'
        default:
          description: Error response.
          schema:
            $ref: '#/components/schemas/APIError'
      x-ms-examples:
        Create video review request:
          $ref: ../v1.0/examples/CreateVideoReviewResource.JSON
      produces:
      - application/json
  /contentmoderator/review/v1.0/teams/{teamName}/reviews/{reviewId}/frames?overload=url:
    post:
      tags:
      - Reviews
      operationId: Reviews_AddVideoFrameUrl
      description: Use this method to add frames for a video review. The timescale parameter is a factor that's used to convert the time stamp on a frame into milliseconds. Timescale is provided in the output of the Content Moderator video media processor on the Azure Media Services platform. Timescale in the video moderation output is Ticks/Second.
      parameters:
      - name: Content-Type
        description: Content type.
        required: true
        type: string
        in: header
      - $ref: '#/components/parameters/teamName'
      - $ref: '#/components/parameters/reviewId'
      - $ref: '#/components/parameters/timescale'
      - $ref: '#/components/parameters/videoFrameBody'
      consumes:
      - application/json
      responses:
        '204':
          description: No content.
        default:
          description: Error response.
          schema:
            $ref: '#/components/schemas/APIError'
      x-ms-examples:
        Add video frame url input request:
          $ref: ./examples/AddFrameResource.JSON
      produces:
      - application/json
  /contentmoderator/review/v1.0/teams/{teamName}/reviews/{reviewId}/frames?overload=stream:
    post:
      tags:
      - Reviews
      operationId: Reviews_AddVideoFrameStream
      description: Use this method to add frames for a video review. The timescale parameter is a factor that's used to convert the timestamp on a frame into milliseconds. Timescale is provided in the output of the Content Moderator video media processor on the Azure Media Services platform. Timescale in the video moderation output is Ticks/Second.
      parameters:
      - name: Content-Type
        description: Content type.
        required: true
        type: string
        in: header
      - name: teamName
        description: Your team name.
        in: path
        required: true
        type: string
      - name: reviewId
        description: ID of the review.
        in: path
        required: true
        type: string
      - name: timescale
        description: Timescale of the video.
        in: query
        required: false
        type: integer
      - name: frameImageZip
        description: Zip file that contains frame images.
        in: formData
        required: true
        type: string
        format: binary
      - name: frameMetadata
        description: Metadata of the frame.
        in: formData
        required: true
        type: string
      consumes:
      - multipart/form-data
      responses:
        '204':
          description: No content.
        default:
          description: Error response.
          schema:
            $ref: '#/components/schemas/APIError'
      produces:
      - application/json