# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Lytics Segments API
  version: 1.0.0
extends: openapi/lytics-segments-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-02'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 7
- target: $.paths['/segment'].get
  update:
    x-apievangelist-phrasing:
      intent: List audience segments
      effect: read
      questions:
      - Which audience segments exist on my account?
      - Can I list only valid segments of a certain kind?
      instructions:
      - text: List all my segments.
      - text: List {kind} segments on table {table} with valid set to {valid}.
        slots:
          kind: query.kind
          table: query.table
          valid: query.valid
      method: generated
      generated: '2026-10-02'
- target: $.paths['/segment'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an audience segment
      effect: write
      questions:
      - How do I build a new audience from a SegmentQL definition?
      - Can I make a segment public with its own public name when creating it?
      instructions:
      - text: Create segment {name} defined as {segment_ql}.
        slots:
          name: requestBody.name
          segment_ql: requestBody.segment_ql
      - text: Create a public segment {name} with slug {slug_name} and tags {tags}.
        slots:
          name: requestBody.name
          slug_name: requestBody.slug_name
          tags: requestBody.tags
      method: generated
      generated: '2026-10-02'
- target: $.paths['/segment/exclude/{operation}'].post
  update:
    x-apievangelist-phrasing:
      intent: Add or remove a segment on the export exclusion list
      effect: write
      questions:
      - Can I exclude everyone in a segment from export jobs?
      - How do I take a segment back off the exclusion list?
      instructions:
      - text: '{operation} segment {segment_id} on the export exclusion list.'
        slots:
          operation: path.operation
          segment_id: query.segment_id
      - text: Apply exclusion operation {operation} for segment {segment_id} in workflow {workflow}.
        slots:
          operation: path.operation
          segment_id: query.segment_id
          workflow: query.workflow
      method: generated
      generated: '2026-10-02'
- target: $.paths['/segment/{ids}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several segments at once
      effect: destructive
      questions:
      - Can I delete a batch of segments in one call?
      - Is there a bulk delete for old audiences?
      instructions:
      - text: Delete segments {ids}.
        slots:
          ids: path.ids
      - text: Bulk remove the audiences with ids {ids}.
        slots:
          ids: path.ids
      method: generated
      generated: '2026-10-02'
- target: $.paths['/segment/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one segment by id or slug
      effect: read
      questions:
      - How many users are in a particular segment?
      - Can I look up a segment by its slug instead of its id?
      instructions:
      - text: Show segment {id}.
        slots:
          id: path.id
      - text: Get segment {id} with sizes {sizes}.
        slots:
          id: path.id
          sizes: query.sizes
      method: generated
      generated: '2026-10-02'
- target: $.paths['/segment/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a segment's definition
      effect: write
      questions:
      - Can I change the rules that define an existing audience?
      - Is it possible to rename a segment or retag it?
      instructions:
      - text: Change segment {id} to be defined as {segment_ql}.
        slots:
          id: path.id
          segment_ql: requestBody.segment_ql
      - text: Rename segment {id} to {name} and set its tags to {tags}.
        slots:
          id: path.id
          name: requestBody.name
          tags: requestBody.tags
      method: generated
      generated: '2026-10-02'
- target: $.paths['/segment/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a single segment
      effect: destructive
      questions:
      - How do I delete one audience segment?
      - Can I remove just a single segment by its id?
      instructions:
      - text: Delete segment {id}.
        slots:
          id: path.id
      - text: Remove only the audience {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-02'