# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for stream-api Compare.json API
  version: 1.0.0
extends: openapi/khoros-ai-compare-json-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 4
- target: $.paths['/compare.json?streams'].get
  update:
    x-apievangelist-phrasing:
      intent: Compare volumes across streams
      effect: read
      questions:
      - How do I compare post volumes between several social streams?
      - Which of my streams has the most volume?
      instructions:
      - text: Compare the volumes of streams {streams}.
        slots:
          streams: path.streams
      - text: Show stream volume side by side for {streams}.
        slots:
          streams: path.streams
      method: generated
      generated: '2026-10-01'
- target: $.paths['/compare.json?streams={content}&target'].get
  update:
    x-apievangelist-phrasing:
      intent: Get stream progress toward a target
      effect: read
      questions:
      - How close are my streams to a volume target?
      - Can I get a percentage toward a goal number for compared streams?
      instructions:
      - text: Get the percentage of target {target} reached by streams {content}.
        slots:
          target: query.target
          content: path.content
      - text: Show progress toward the target for streams {content}.
        slots:
          content: path.content
      method: generated
      generated: '2026-10-01'
- target: $.paths['/compare.json?streams={content}&target={number}&precision'].get
  update:
    x-apievangelist-phrasing:
      intent: Set decimals on target-progress percentages
      effect: read
      questions:
      - How many decimal places can a stream target percentage have?
      - Can I round the percent-toward-target result for compared streams?
      instructions:
      - text: Compare streams {content} against target {number} with {precision} decimal places.
        slots:
          content: path.content
          number: path.number
          precision: query.precision
      - text: Return progress of {content} toward {number} rounded to {precision} decimals.
        slots:
          content: path.content
          number: path.number
          precision: query.precision
      method: generated
      generated: '2026-10-01'
- target: $.paths['/compare.json?streams={content}&sort'].get
  update:
    x-apievangelist-phrasing:
      intent: Sort compared streams by percentage
      effect: read
      questions:
      - Can I order compared streams by percentage ascending or descending?
      - How do I rank a stream comparison by share?
      instructions:
      - text: Compare streams {content} sorted by {sort}.
        slots:
          content: path.content
          sort: query.sort
      - text: Rank the stream comparison for {content} in {sort} order.
        slots:
          content: path.content
          sort: query.sort
      method: generated
      generated: '2026-10-01'