# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Thehiveryiq Com Smsh API
  version: 1.0.0
extends: openapi/thehiveryiq-com-smsh-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['/v1/smsh/compress'].post
  update:
    x-apievangelist-phrasing:
      intent: Compress a prompt with smsh
      effect: write
      questions:
      - How do I shrink a long prompt to save tokens?
      - Can I compress a prompt and have it signed or encrypted in the same step?
      - Which compression modes include the learned v2 option?
      instructions:
      - text: 'Compress this prompt: {text}.'
        slots:
          text: requestBody.text
      - text: Compress {text} using mode {mode} with fidelity target {fidelity_target}.
        slots:
          text: requestBody.text
          mode: requestBody.mode
          fidelity_target: requestBody.fidelity_target
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/smsh/decompress'].post
  update:
    x-apievangelist-phrasing:
      intent: Decompress an smsh-compressed prompt
      effect: read
      questions:
      - How do I turn an smsh-compressed prompt back into readable text?
      - Does decompression restore the structural dedup backreferences too?
      instructions:
      - text: Decompress {compressed}.
        slots:
          compressed: requestBody.compressed
      - text: 'Expand this smsh output back to plain text: {compressed}.'
        slots:
          compressed: requestBody.compressed
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/smsh/compress/demo'].post
  update:
    x-apievangelist-phrasing:
      intent: Try smsh compression for free
      effect: read
      questions:
      - Can I try prompt compression for free before paying?
      - What is the character limit on the free compression demo?
      instructions:
      - text: Run the free compression demo on {text}.
        slots:
          text: requestBody.text
      - text: Try the demo compressor on {text} in {mode} mode.
        slots:
          text: requestBody.text
          mode: requestBody.mode
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/smsh/health'].get
  update:
    x-apievangelist-phrasing:
      intent: Check smsh service health
      effect: read
      questions:
      - Is the prompt compression service up?
      - How big is the smsh dictionary currently loaded?
      instructions:
      - text: Check the smsh service health.
      - text: Show smsh health, available modes and dictionary size.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/smsh/v1_5/warmup'].get
  update:
    x-apievangelist-phrasing:
      intent: Check or trigger v1.5 model warmup (GET)
      effect: read
      questions:
      - Are the v1.5 compression models loaded yet?
      - Can I check warmup status with a simple GET?
      instructions:
      - text: Check the v1.5 warmup status via GET.
      - text: GET the smsh v1.5 warmup endpoint to see if models are loaded.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/smsh/v1_5/warmup'].post
  update:
    x-apievangelist-phrasing:
      intent: Pre-load v1.5 compression models (POST)
      effect: write
      questions:
      - How do I warm up the compression models after a deploy to avoid a slow first call?
      - Is it safe to POST the warmup more than once?
      instructions:
      - text: POST to warm up the smsh v1.5 models.
      - text: Pre-load the v1.5 compression models into memory with a POST.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/smsh/dictionary'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the smsh boilerplate dictionary
      effect: read
      questions:
      - Which boilerplate phrases does smsh replace with sentinels?
      - Can I download the full compression dictionary?
      instructions:
      - text: Get the smsh boilerplate dictionary.
      - text: Show me all sentinel mappings used for compression.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/smsh/modes'].get
  update:
    x-apievangelist-phrasing:
      intent: List smsh compression modes
      effect: read
      questions:
      - What compression modes are available and what ratio does each target?
      - Which smsh modes are v1 versus v2?
      instructions:
      - text: List all smsh compression modes.
      - text: Show the target ratio and description of each compression mode.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/smsh/bench/summary'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the latest smsh benchmark summary
      effect: read
      questions:
      - How well does smsh compression perform in the latest benchmark?
      - Where can I get the live benchmark numbers for prompt compression?
      instructions:
      - text: Get the latest smsh benchmark summary.
      - text: Show me the most recent compression bench results.
      method: generated
      generated: '2026-09-26'