Microsoft Azure TextModeration API

openapi: 3.2.0
info:
  title: Microsoft Azure Content Moderator Client Text Moderation API
  version: '1.0'
  description: 'You use the API to scan your content as it''s generated. Content Moderator then processes your content and sends the results, along with relevant information, either back to your systems or to the built-in review tool. You can use this information to make decisions, like taking it down or sending it to a human judge.


    When you''re using the API, images need to have a minimum of 128 pixels and a maximum file size of 4 MB.

    Text can be at most 1,024 characters long.

    If the content passed to the text API or the image API exceeds the size limits, the API will return an error code that informs you about the issue.'
security:
- apim_key: []
tags:
- name: TextModeration
paths:
  /contentmoderator/moderate/v1.0/ProcessText/Screen/:
    post:
      tags:
      - TextModeration
      summary: Microsoft Azure Detect Profanity And Match Against Custom And Shared Blocklists
      description: Detects profanity in more than 100 languages and matches against custom and shared blocklists.
      operationId: microsoftAzureTextmoderationScreentext
      parameters:
      - $ref: '#/components/parameters/textLanguage'
      - $ref: '#/components/parameters/autocorrect'
      - $ref: '#/components/parameters/PII'
      - $ref: '#/components/parameters/listIdQueryParameter'
      - $ref: '#/components/parameters/classify'
      - name: Content-Type
        description: Content type.
        required: true
        x-ms-client-name: textContentType
        in: header
        schema:
          type: string
          enum:
          - text/plain
          - text/html
          - text/xml
          - text/markdown
      - $ref: '#/components/parameters/textContent'
      responses:
        '200':
          description: Status 200.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Screen'
        default:
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
      x-ms-examples:
        Detect Language request:
          $ref: ../v1.0/examples/ScreenTextResource.JSON
  /contentmoderator/moderate/v1.0/ProcessText/DetectLanguage:
    post:
      tags:
      - TextModeration
      operationId: microsoftAzureTextmoderationDetectlanguage
      description: This operation detects the language of input content. It returns the ISO 639-3 code for the predominant language in the submitted text. More than 110 languages are supported.
      parameters:
      - name: Content-Type
        description: Content type.
        required: true
        x-ms-client-name: textContentType
        in: header
        schema:
          type: string
          enum:
          - text/plain
          - text/html
          - text/xml
          - text/markdown
      - $ref: '#/components/parameters/textContent'
      responses:
        '200':
          description: Detected language result.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DetectedLanguage'
        default:
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
      x-ms-examples:
        Detect Language request:
          $ref: ../v1.0/examples/DetectLanguageResource.JSON
      summary: Microsoft Azure Post Contentmoderator Moderate 0 Processtext Detectlanguage
components:
  schemas:
    PII:
      description: Details about personally identifiable information.
      properties:
        Email:
          type: array
          items:
            $ref: '#/components/schemas/Email'
        SSN:
          type: array
          items:
            $ref: '#/components/schemas/SSN'
        IPA:
          type: array
          items:
            $ref: '#/components/schemas/IPA'
        Phone:
          type: array
          items:
            $ref: '#/components/schemas/Phone'
        Address:
          type: array
          items:
            $ref: '#/components/schemas/Address'
    DetectedTerms:
      description: Detected term details.
      properties:
        Index:
          description: Index (location) of the detected profanity term in the input text content.
          type: integer
        OriginalIndex:
          description: Original index (location) of the detected profanity term in the input text content.
          type: integer
        ListId:
          description: Matched ID in the term list.
          type: integer
        Term:
          description: Detected profanity term.
          type: string
    Status:
      description: Status properties.
      properties:
        Code:
          description: Status code.
          type: integer
        Description:
          description: Status description.
          type: string
        Exception:
          description: Exception status.
          type: string
    Screen:
      description: Response for a screen text request.
      properties:
        OriginalText:
          description: Original text.
          type: string
        NormalizedText:
          description: Normalized text.
          type: string
        AutoCorrectedText:
          description: Autocorrected text.
          type: string
        Misrepresentation:
          description: Misrepresentation text.
          type: array
          items:
            type: string
        Classification:
          description: Classification details of the text.
          $ref: '#/components/schemas/Classification'
        Status:
          description: Evaluation status.
          $ref: '#/components/schemas/Status'
        PII:
          description: Details about personally identifiable information.
          $ref: '#/components/schemas/PII'
        Language:
          description: Language of the input text content.
          type: string
        Terms:
          type: array
          items:
            $ref: '#/components/schemas/DetectedTerms'
        TrackingId:
          description: Unique Content Moderator transaction ID.
          type: string
    SSN:
      description: Details about a detected social security number.
      properties:
        Text:
          description: Detected social security number in the input text content.
          type: string
        Index:
          description: Index (location) of the social security number in the input text content.
          type: integer
    Address:
      description: Address details.
      properties:
        Text:
          description: Detected address.
          type: string
        Index:
          description: Index (location) of the address in the input text content.
          type: integer
    Classification:
      description: Classification details of the text.
      properties:
        Category1:
          description: Category1 score details of the text. For more details on category classification, see <a href="https://aka.ms/textClassifyCategories">this article</a>.
          properties:
            Score:
              description: Category1 score.
              type: number
        Category2:
          description: Category2 score details of the text. For more details on category classification, see <a href="https://aka.ms/textClassifyCategories">this article</a>.
          properties:
            Score:
              description: Category2 score.
              type: number
        Category3:
          description: Category3 score details of the text. For more details on category classification, see <a href="https://aka.ms/textClassifyCategories">this article</a>.
          properties:
            Score:
              description: Category3 score.
              type: number
        ReviewRecommended:
          description: Review-recommended flag.
          type: boolean
    Error:
      type: object
      description: Error body.
      properties:
        Code:
          type: string
        Message:
          type: string
    Email:
      description: Email address details.
      properties:
        Detected:
          description: Detected email address from the input text content.
          type: string
        SubType:
          description: Subtype of the detected email address.
          type: string
        Text:
          description: Email address in the input text content.
          type: string
        Index:
          description: Index (location) of the email address in the input text content.
          type: integer
    APIError:
      type: object
      description: Error information that the API returns.
      properties:
        Error:
          $ref: '#/components/schemas/Error'
    DetectedLanguage:
      description: Detected language result.
      properties:
        DetectedLanguage:
          description: Detected language.
          type: string
        Status:
          description: Detected language status.
          $ref: '#/components/schemas/Status'
        TrackingId:
          description: Tracking ID.
          type: string
    Phone:
      description: Phone property details.
      properties:
        CountryCode:
          description: Country/region code of the detected phone number.
          type: string
        Text:
          description: Detected phone number.
          type: string
        Index:
          description: Index (location) of the phone number in the input text content.
          type: integer
    IPA:
      description: IP address details.
      properties:
        SubType:
          description: Subtype of the detected IP address.
          type: string
        Text:
          description: Detected IP address.
          type: string
        Index:
          description: Index (location) of the IP address in the input text content.
          type: integer
  parameters:
    textContent:
      name: Text Content
      description: Content to screen.
      in: body
      required: true
      schema:
        type: object
        format: file
      x-ms-parameter-location: method
    autocorrect:
      name: autocorrect
      in: query
      required: false
      description: Autocorrect text.
      x-ms-parameter-location: method
      schema:
        type: boolean
        default: false
    PII:
      name: PII
      in: query
      description: Detect personal identifiable information.
      required: false
      x-ms-parameter-location: method
      schema:
        type: boolean
        default: false
    classify:
      name: classify
      description: Classify input.
      in: query
      required: false
      x-ms-parameter-location: method
      schema:
        type: boolean
        default: false
    listIdQueryParameter:
      name: listId
      in: query
      description: List ID.
      x-ms-parameter-location: method
      schema:
        type: string
    textLanguage:
      name: language
      in: query
      description: Language of the text.
      x-ms-parameter-location: method
      schema:
        type: string
  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
x-provenance:
  method: harvested
  publisher: Microsoft Azure
  source: https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/cognitiveservices/data-plane/ContentModerator/stable/v1.0/ContentModerator.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)