API Evangelist conversational phrasing for Khoros Ai Meta.json API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Khoros Ai Meta.json API
  version: 1.0.0
extends: openapi/khoros-ai-meta-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: 18
- target: $.paths['/{account}/{streamName}/meta.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get summary metadata for a stream
      effect: read
      questions:
      - What summary information can I get about the entities in a social stream?
      - How do I pull the meta.json overview for one of our streams?
      instructions:
      - text: Get the meta summary for stream {stream} in account {account}.
        slots:
          account: path.account
          stream: path.streamName
      - text: Show what is derived from the entities in stream {stream} for account {account}.
        slots:
          account: path.account
          stream: path.streamName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{account}/{streamName}/meta.json?num_minutes'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a stream's activity by the minute
      effect: read
      questions:
      - Can I see minute-by-minute activity for a stream?
      - How many minutes of activity can the stream meta response cover?
      instructions:
      - text: Get the last {minutes} minutes of activity for stream {stream} in account {account}.
        slots:
          account: path.account
          stream: path.streamName
          minutes: query.num_minutes
      - text: Show per-minute activity for stream {stream} in account {account}.
        slots:
          account: path.account
          stream: path.streamName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{account}/{streamName}/meta.json?num_hours'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a stream's activity by the hour
      effect: read
      questions:
      - Can I get hourly activity counts for a stream?
      - What does a stream's activity look like broken into hours?
      instructions:
      - text: Get the last {hours} hours of activity for stream {stream} in account {account}.
        slots:
          account: path.account
          stream: path.streamName
          hours: query.num_hours
      - text: Show hourly activity for stream {stream} in account {account}.
        slots:
          account: path.account
          stream: path.streamName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{account}/{streamName}/meta.json?num_days'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a stream's activity by the day
      effect: read
      questions:
      - Can I see daily activity totals for a stream over several days?
      - What does a stream's activity look like day by day?
      instructions:
      - text: Get the last {days} days of activity for stream {stream} in account {account}.
        slots:
          account: path.account
          stream: path.streamName
          days: query.num_days
      - text: Show daily activity for stream {stream} in account {account}.
        slots:
          account: path.account
          stream: path.streamName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{account}/{streamName}/meta.json?activity'].get
  update:
    x-apievangelist-phrasing:
      intent: Include activity and count totals in stream meta
      effect: read
      questions:
      - How do I make the stream meta response include activity and count properties?
      - Can stream metadata return item counts alongside activity?
      instructions:
      - text: Get stream {stream} metadata for account {account} with activity and count properties.
        slots:
          account: path.account
          stream: path.streamName
      - text: Include activity and counts in the meta response for stream {stream} in account {account}.
        slots:
          account: path.account
          stream: path.streamName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{account}/{streamName}/meta.json?finish'].get
  update:
    x-apievangelist-phrasing:
      intent: Set where a stream's activity data ends
      effect: read
      questions:
      - Can I make stream activity data stop at a specific point in time?
      - How do I cap stream activity at a Unix timestamp?
      instructions:
      - text: Get activity for stream {stream} in account {account} ending at {finish}.
        slots:
          account: path.account
          stream: path.streamName
          finish: query.finish
      - text: End the activity data for stream {stream} in account {account} at Unix time {finish}.
        slots:
          account: path.account
          stream: path.streamName
          finish: query.finish
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{account}/{streamName}/meta.json? networks'].get
  update:
    x-apievangelist-phrasing:
      intent: List the networks a stream covers
      effect: read
      questions:
      - Which social networks does a stream pull content from?
      - Can the stream meta response include its list of networks?
      instructions:
      - text: List the networks in stream {stream} for account {account}.
        slots:
          account: path.account
          stream: path.streamName
      - text: Include the networks array in the meta response for stream {stream} in account {account}.
        slots:
          account: path.account
          stream: path.streamName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{account}/{streamName}/meta.json?top_periods'].get
  update:
    x-apievangelist-phrasing:
      intent: Get top retweets for specific hourly periods
      effect: read
      questions:
      - Can I get the top retweeted posts for particular hours in a stream?
      - Which tweets were most retweeted during specific hourly periods I choose?
      instructions:
      - text: Get the top retweets in stream {stream} for account {account} during hourly periods {periods}.
        slots:
          account: path.account
          stream: path.streamName
          periods: query.top_periods
      - text: Show the most retweeted posts in stream {stream} of account {account} for periods {periods}.
        slots:
          account: path.account
          stream: path.streamName
          periods: query.top_periods
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{account}/{streamName}/meta.json?top_periods_relative'].get
  update:
    x-apievangelist-phrasing:
      intent: Get top retweets for hours counted back from now
      effect: read
      questions:
      - Can I see the top tweets from a few hours ago, counted back from now?
      - What were the most retweeted posts in recent relative hourly periods?
      instructions:
      - text: Get top retweets in stream {stream} for account {account} from {hours_ago} hours ago.
        slots:
          account: path.account
          stream: path.streamName
          hours_ago: query.top_periods_relative
      - text: List the leading tweets in stream {stream} of account {account} counting {hours_ago} hourly periods back from now.
        slots:
          account: path.account
          stream: path.streamName
          hours_ago: query.top_periods_relative
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{account}/{streamName}/meta.json?top_count'].get
  update:
    x-apievangelist-phrasing:
      intent: Set how many top tweets to return per period
      effect: read
      questions:
      - How many top tweets can I include for each period in stream meta?
      - Can I limit the number of tweets returned per period?
      instructions:
      - text: Return {count} top tweets per period for stream {stream} in account {account}.
        slots:
          account: path.account
          stream: path.streamName
          count: query.top_count
      - text: Limit stream {stream} in account {account} to {count} tweets per period.
        slots:
          account: path.account
          stream: path.streamName
          count: query.top_count
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{account}/{streamName}/meta.json?num_hashtags'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a stream's top hashtags
      effect: read
      questions:
      - Which hashtags show up most in a stream?
      - Can I choose how many hashtags the stream meta returns?
      instructions:
      - text: Get the top {count} hashtags in stream {stream} for account {account}.
        slots:
          account: path.account
          stream: path.streamName
          count: query.num_hashtags
      - text: List the leading hashtags in stream {stream} of account {account}.
        slots:
          account: path.account
          stream: path.streamName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{account}/{streamName}/meta.json?num_contributors'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a stream's top contributors
      effect: read
      questions:
      - Who are the most active contributors posting in a stream?
      - Can I choose how many contributor handles are returned?
      instructions:
      - text: Get the top {count} contributor handles in stream {stream} for account {account}.
        slots:
          account: path.account
          stream: path.streamName
          count: query.num_contributors
      - text: List the most active contributors in stream {stream} of account {account}.
        slots:
          account: path.account
          stream: path.streamName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{account}/{streamName}/meta.json?num_trends'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a stream's top topics
      effect: read
      questions:
      - What topics are trending in a stream, and how many topic buckets can I get?
      - Can I choose how many trend buckets the stream meta returns?
      instructions:
      - text: Get the top {count} topics in stream {stream} for account {account}.
        slots:
          account: path.account
          stream: path.streamName
          count: query.num_trends
      - text: Return {count} trend buckets for stream {stream} of account {account}.
        slots:
          account: path.account
          stream: path.streamName
          count: query.num_trends
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{account}/{streamName}/meta.json?sort'].get
  update:
    x-apievangelist-phrasing:
      intent: Sort a stream's returned topics
      effect: read
      questions:
      - Can I control the sort order of topics in the stream meta response?
      - How are stream topics ordered, and can I change that?
      instructions:
      - text: Sort the topics for stream {stream} in account {account} by {sort}.
        slots:
          account: path.account
          stream: path.streamName
          sort: query.sort
      - text: Return stream {stream} topics for account {account} in {sort} order.
        slots:
          account: path.account
          stream: path.streamName
          sort: query.sort
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{account}/{streamName}/meta.json?all_topics'].get
  update:
    x-apievangelist-phrasing:
      intent: Include zero-count topics in stream meta
      effect: read
      questions:
      - Can I see every topic in a stream, even ones with no mentions?
      - How do I include topics whose count is zero?
      instructions:
      - text: Get all topics for stream {stream} in account {account}, including empty ones.
        slots:
          account: path.account
          stream: path.streamName
      - text: Include zero-count topics in the meta response for stream {stream} of account {account}.
        slots:
          account: path.account
          stream: path.streamName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{account}/{streamName}/meta.json?percent'].get
  update:
    x-apievangelist-phrasing:
      intent: Show topic bucket shares as percentages
      effect: read
      questions:
      - Can stream topic buckets be returned as percentages of the total?
      - What share of a stream's volume does each topic bucket hold?
      instructions:
      - text: Get percentage shares per bucket for stream {stream} in account {account}.
        slots:
          account: path.account
          stream: path.streamName
      - text: Return bucket percentages for the total group of stream {stream} in account {account}.
        slots:
          account: path.account
          stream: path.streamName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{account}/{streamName}/meta.json?precision'].get
  update:
    x-apievangelist-phrasing:
      intent: Set decimal places for stream meta percentages
      effect: read
      questions:
      - How many decimal places can the percentages in stream metadata have?
      - Can I round stream meta percentages to fewer decimals?
      instructions:
      - text: Return stream {stream} percentages for account {account} with {places} decimal places.
        slots:
          account: path.account
          stream: path.streamName
          places: query.precision
      - text: Round the meta percentages for stream {stream} in account {account} to {places} decimals.
        slots:
          account: path.account
          stream: path.streamName
          places: query.precision
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{account}/{streamName}/meta.json?disregard'].get
  update:
    x-apievangelist-phrasing:
      intent: Exclude specific trends from topic buckets
      effect: read
      questions:
      - Can I leave certain terms out of a stream's trending topics?
      - How do I ignore specific values in the trend buckets but still get enough topics?
      instructions:
      - text: Exclude {values} from the trends in stream {stream} for account {account}.
        slots:
          account: path.account
          stream: path.streamName
          values: query.disregard
      - text: Get topics for stream {stream} in account {account} while disregarding {values}.
        slots:
          account: path.account
          stream: path.streamName
          values: query.disregard
      method: generated
      generated: '2026-10-01'