# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Microsoft Azure Content Moderator Client Reviews API
  version: 1.0.0
extends: openapi/microsoft-azure-reviews-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 9
- target: $.paths['/contentmoderator/review/v1.0/teams/{teamName}/reviews/{reviewId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a content moderation review
      effect: read
      questions:
      - What did the human moderators decide on my review?
      - What details does Content Moderator return for a single review?
      instructions:
      - text: Get review {reviewId} for team {teamName}.
        slots:
          reviewId: path.reviewId
          teamName: path.teamName
      - text: Show the reviewer decisions on moderation review {reviewId} in team {teamName}.
        slots:
          reviewId: path.reviewId
          teamName: path.teamName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/contentmoderator/review/v1.0/teams/{teamName}/jobs/{JobId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a moderation job's details
      effect: read
      questions:
      - Did my moderation job create a review or get ignored by the workflow?
      - Where can I see the status of a Content Moderator job?
      instructions:
      - text: Get details of moderation job {JobId} for team {teamName}.
        slots:
          JobId: path.JobId
          teamName: path.teamName
      - text: Check the result of job {JobId} in team {teamName}.
        slots:
          JobId: path.JobId
          teamName: path.teamName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/contentmoderator/review/v1.0/teams/{teamName}/reviews'].post
  update:
    x-apievangelist-phrasing:
      intent: Create reviews for human moderators
      effect: write
      questions:
      - Can I send content straight to my moderation team for human review?
      - Can I assign newly created reviews to a sub-team?
      instructions:
      - text: Create reviews for team {teamName} with content type {UrlContentType}.
        slots:
          teamName: path.teamName
          UrlContentType: header.UrlContentType
      - text: Open new moderation reviews in team {teamName} and assign them to sub-team {subTeam}.
        slots:
          teamName: path.teamName
          subTeam: query.subTeam
      method: generated
      generated: '2026-09-26'
- target: $.paths['/contentmoderator/review/v1.0/teams/{teamName}/jobs'].post
  update:
    x-apievangelist-phrasing:
      intent: Submit content to a moderation workflow job
      effect: write
      questions:
      - How do I run an image, text or video through a moderation workflow?
      - Can I get a callback when a moderation job finishes?
      instructions:
      - text: Run content {ContentValue} with ID {ContentId} of type {ContentType} through workflow {WorkflowName} for team {teamName}.
        slots:
          ContentValue: requestBody.ContentValue
          ContentId: query.ContentId
          ContentType: query.ContentType
          WorkflowName: query.WorkflowName
          teamName: path.teamName
      - text: Start a moderation job in team {teamName} using workflow {WorkflowName} and post results to {CallBackEndpoint}.
        slots:
          teamName: path.teamName
          WorkflowName: query.WorkflowName
          CallBackEndpoint: query.CallBackEndpoint
      method: generated
      generated: '2026-09-26'
- target: $.paths['/contentmoderator/review/v1.0/teams/{teamName}/reviews/{reviewId}/frames'].get
  update:
    x-apievangelist-phrasing:
      intent: Get frames of a video review
      effect: read
      questions:
      - Which frames are attached to my video moderation review?
      - Can I filter a video review's frames by tag or start from a timestamp?
      instructions:
      - text: Get video frames for review {reviewId} in team {teamName}.
        slots:
          reviewId: path.reviewId
          teamName: path.teamName
      - text: Fetch {noOfRecords} frames of review {reviewId} starting at {startSeed} for team {teamName}.
        slots:
          noOfRecords: query.noOfRecords
          reviewId: path.reviewId
          startSeed: query.startSeed
          teamName: path.teamName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/contentmoderator/review/v1.0/teams/{teamName}/reviews/{reviewId}/frames'].post
  update:
    x-apievangelist-phrasing:
      intent: Add frames to a video review
      effect: write
      questions:
      - How do I attach frames to a video review before publishing it?
      - Does adding frames need the video's timescale?
      instructions:
      - text: Add video frames to review {reviewId} in team {teamName}.
        slots:
          reviewId: path.reviewId
          teamName: path.teamName
      - text: Attach frames to video review {reviewId} for team {teamName} using timescale {timescale}.
        slots:
          reviewId: path.reviewId
          teamName: path.teamName
          timescale: query.timescale
      method: generated
      generated: '2026-09-26'
- target: $.paths['/contentmoderator/review/v1.0/teams/{teamName}/reviews/{reviewId}/publish'].post
  update:
    x-apievangelist-phrasing:
      intent: Publish a video review to reviewers
      effect: write
      questions:
      - What makes a video review visible to my moderators?
      - When is a video review ready to be published?
      instructions:
      - text: Publish video review {reviewId} for team {teamName}.
        slots:
          reviewId: path.reviewId
          teamName: path.teamName
      - text: Release video moderation review {reviewId} to reviewers in {teamName}.
        slots:
          reviewId: path.reviewId
          teamName: path.teamName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/contentmoderator/review/v1.0/teams/{teamName}/reviews/{reviewId}/transcriptmoderationresult'].put
  update:
    x-apievangelist-phrasing:
      intent: Add transcript screening results to a review
      effect: write
      questions:
      - How do I attach profanity screening results for a video transcript to a review?
      - Where do the Screen Text results for a transcript go on a video review?
      instructions:
      - text: Add transcript moderation results {transcriptModerationBody} to video review {reviewId} in team {teamName}.
        slots:
          transcriptModerationBody: body.transcriptModerationBody
          reviewId: path.reviewId
          teamName: path.teamName
      - text: Attach screened transcript text results to review {reviewId} for team {teamName}.
        slots:
          reviewId: path.reviewId
          teamName: path.teamName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/contentmoderator/review/v1.0/teams/{teamName}/reviews/{reviewId}/transcript'].put
  update:
    x-apievangelist-phrasing:
      intent: Add a WebVTT transcript to a video review
      effect: write
      questions:
      - How do I upload the spoken-word transcript of a video to its review?
      - What file format does a video review transcript need to be in?
      instructions:
      - text: Upload a WebVTT transcript to video review {reviewId} in team {teamName}.
        slots:
          reviewId: path.reviewId
          teamName: path.teamName
      - text: Add the video's VTT transcript file to review {reviewId} for {teamName}.
        slots:
          reviewId: path.reviewId
          teamName: path.teamName
      method: generated
      generated: '2026-09-26'