# 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 ContentSafety Service Text API
  version: 1.0.0
extends: openapi/microsoft-azure-text-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: 8
- target: $.paths['/text/blocklists'].get
  update:
    x-apievangelist-phrasing:
      intent: List text blocklists
      effect: read
      questions:
      - Which text blocklists have I set up in Content Safety?
      - What custom blocklists exist for text moderation?
      instructions:
      - text: List all my text blocklists.
      - text: Show every text blocklist with its description.
      - text: List text blocklists using API version {api-version}.
        slots:
          api-version: query.api-version
      method: generated
      generated: '2026-09-26'
- target: $.paths['/text/blocklists/{blocklistName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a text blocklist
      effect: read
      questions:
      - How do I see the details of one text blocklist?
      - What description does a given blocklist have?
      instructions:
      - text: Get text blocklist {blocklistName}.
        slots:
          blocklistName: path.blocklistName
      - text: Show details of blocklist {blocklistName}.
        slots:
          blocklistName: path.blocklistName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/text/blocklists/{blocklistName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a text blocklist
      effect: destructive
      questions:
      - How do I delete a text blocklist entirely?
      - Can I remove a custom blocklist I no longer need?
      instructions:
      - text: Delete text blocklist {blocklistName}.
        slots:
          blocklistName: path.blocklistName
      - text: Remove the blocklist named {blocklistName}.
        slots:
          blocklistName: path.blocklistName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/text/blocklists/{blocklistName}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Create or update a text blocklist
      effect: write
      questions:
      - Can I create a new text blocklist for content moderation?
      - How do I change the description of an existing blocklist?
      instructions:
      - text: Create text blocklist {blocklistName} described as {description}.
        slots:
          blocklistName: path.blocklistName
          description: requestBody.description
      - text: Update blocklist {blocklistName} with description {description}.
        slots:
          blocklistName: path.blocklistName
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/text/blocklists/{blocklistName}:addOrUpdateBlocklistItems'].post
  update:
    x-apievangelist-phrasing:
      intent: Add or update items in a text blocklist
      effect: write
      questions:
      - How many terms can I add to a text blocklist in one request?
      - Can I add new blocked terms to an existing blocklist?
      instructions:
      - text: Add blocklist items {blocklistItems} to blocklist {blocklistName}.
        slots:
          blocklistItems: requestBody.blocklistItems
          blocklistName: path.blocklistName
      - text: Add or update terms {blocklistItems} in text blocklist {blocklistName}.
        slots:
          blocklistItems: requestBody.blocklistItems
          blocklistName: path.blocklistName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/text/blocklists/{blocklistName}:removeBlocklistItems'].post
  update:
    x-apievangelist-phrasing:
      intent: Remove items from a text blocklist
      effect: destructive
      questions:
      - Can I remove specific blocked terms from a blocklist?
      - What is the maximum number of blocklist items I can remove at once?
      instructions:
      - text: Remove items {blocklistItemIds} from blocklist {blocklistName}.
        slots:
          blocklistItemIds: requestBody.blocklistItemIds
          blocklistName: path.blocklistName
      - text: Delete blocklist item IDs {blocklistItemIds} from text blocklist {blocklistName}.
        slots:
          blocklistItemIds: requestBody.blocklistItemIds
          blocklistName: path.blocklistName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/text/blocklists/{blocklistName}/blocklistItems'].get
  update:
    x-apievangelist-phrasing:
      intent: List items in a text blocklist
      effect: read
      questions:
      - What terms are in my text blocklist?
      - Can I page through blocklist items with top and skip?
      instructions:
      - text: List items in text blocklist {blocklistName}.
        slots:
          blocklistName: path.blocklistName
      - text: List {top} items of blocklist {blocklistName}, skipping {skip}.
        slots:
          top: query.top
          blocklistName: path.blocklistName
          skip: query.skip
      method: generated
      generated: '2026-09-26'
- target: $.paths['/text/blocklists/{blocklistName}/blocklistItems/{blocklistItemId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a single text blocklist item
      effect: read
      questions:
      - How do I look up one blocked term by its item ID?
      - What does an individual blocklist item contain?
      instructions:
      - text: Get blocklist item {blocklistItemId} from blocklist {blocklistName}.
        slots:
          blocklistItemId: path.blocklistItemId
          blocklistName: path.blocklistName
      - text: Show item {blocklistItemId} in text blocklist {blocklistName}.
        slots:
          blocklistItemId: path.blocklistItemId
          blocklistName: path.blocklistName
      method: generated
      generated: '2026-09-26'