API Evangelist conversational phrasing for cdp-api Parent Segment Configurations API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for cdp-api Parent Segment Configurations API
  version: 1.0.0
extends: openapi/treasure-data-parent-segment-configurations-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: 12
- target: $.paths['/audiences'].get
  update:
    x-apievangelist-phrasing:
      intent: List parent segment configurations
      effect: read
      questions:
      - Which parent segments are configured in my Treasure Data account?
      - Can I see every parent segment with its schedule, owner and population at once?
      instructions:
      - text: List all my parent segment configurations.
      - text: Show every parent segment along with its schedule and who created it.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/audiences'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a parent segment configuration
      effect: write
      questions:
      - How do I set up a new parent segment for building audiences?
      - Can a new parent segment be put on a schedule in a particular timezone when I create it?
      instructions:
      - text: Create a new parent segment named {name}.
        slots:
          name: requestBody.name
      - text: Create parent segment {name} with a {scheduleType} schedule in timezone {timezone}.
        slots:
          name: requestBody.name
          scheduleType: requestBody.scheduleType
          timezone: requestBody.timezone
      method: generated
      generated: '2026-09-26'
- target: $.paths['/audiences/{audienceId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one parent segment configuration
      effect: read
      questions:
      - What is configured on a specific parent segment?
      - Can I pull up a single parent segment's master table, attributes and behaviors by its ID?
      instructions:
      - text: Show parent segment {audienceId}.
        slots:
          audienceId: path.audienceId
      - text: Get the full configuration of parent segment {audienceId}.
        slots:
          audienceId: path.audienceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/audiences/{audienceId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a parent segment configuration
      effect: write
      questions:
      - Can I rename an existing parent segment without touching its attributes and behaviors?
      - What happens to attributes and behaviors if I include the master table when editing a parent segment?
      instructions:
      - text: Rename parent segment {audienceId} to {name}.
        slots:
          audienceId: path.audienceId
          name: requestBody.name
      - text: Change the description of parent segment {audienceId} named {name} to {description}.
        slots:
          audienceId: path.audienceId
          name: requestBody.name
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/audiences/{audienceId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a parent segment configuration
      effect: destructive
      questions:
      - How do I remove a parent segment I no longer use?
      - Is deleting a parent segment configuration permanent?
      instructions:
      - text: Delete parent segment {audienceId}.
        slots:
          audienceId: path.audienceId
      - text: Remove the parent segment configuration {audienceId} from my account.
        slots:
          audienceId: path.audienceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/audiences/{audienceId}/attributes'].get
  update:
    x-apievangelist-phrasing:
      intent: List a parent segment's attributes
      effect: read
      questions:
      - Which customer attributes are defined on a parent segment?
      - Can I see the attributes of a parent segment and how sensitive ones are shown?
      instructions:
      - text: List the attributes of parent segment {audienceId}.
        slots:
          audienceId: path.audienceId
      - text: Show me what attributes parent segment {audienceId} exposes.
        slots:
          audienceId: path.audienceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/audiences/{audienceId}/behaviors'].get
  update:
    x-apievangelist-phrasing:
      intent: List a parent segment's behaviors
      effect: read
      questions:
      - What behavior tables are attached to a parent segment?
      - Can I list only the realtime behaviors of a parent segment?
      instructions:
      - text: List the behaviors of parent segment {audienceId}.
        slots:
          audienceId: path.audienceId
      - text: Show behaviors of parent segment {audienceId} with realtime set to {realtime}.
        slots:
          audienceId: path.audienceId
          realtime: query.realtime
      method: generated
      generated: '2026-09-26'
- target: $.paths['/audiences/{audienceId}/run'].post
  update:
    x-apievangelist-phrasing:
      intent: Regenerate a parent segment
      effect: write
      questions:
      - How do I refresh a parent segment so it picks up new data?
      - Can I kick off the workflow that rebuilds a parent segment on demand?
      instructions:
      - text: Run the workflow to regenerate parent segment {audienceId}.
        slots:
          audienceId: path.audienceId
      - text: Rebuild parent segment {audienceId} now.
        slots:
          audienceId: path.audienceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/audiences/{audienceId}/executions'].get
  update:
    x-apievangelist-phrasing:
      intent: List a parent segment's workflow runs
      effect: read
      questions:
      - Did the last parent segment refresh succeed or fail?
      - Where can I see the history of workflow executions for one parent segment?
      instructions:
      - text: List the workflow executions for parent segment {audienceId}.
        slots:
          audienceId: path.audienceId
      - text: Show me whether recent runs of parent segment {audienceId} succeeded.
        slots:
          audienceId: path.audienceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/audiences/{audienceId}/statistics'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a parent segment's population history
      effect: read
      questions:
      - How has the number of profiles in a parent segment changed day by day?
      - Can I get population counts for a parent segment between two dates?
      instructions:
      - text: Show the daily population history of parent segment {audienceId}.
        slots:
          audienceId: path.audienceId
      - text: Get population statistics for parent segment {audienceId} from {from} to {to}.
        slots:
          audienceId: path.audienceId
          from: query.from
          to: query.to
      method: generated
      generated: '2026-09-26'
- target: $.paths['/audiences/{audienceId}/sample_values'].get
  update:
    x-apievangelist-phrasing:
      intent: Sample values of a parent segment attribute
      effect: read
      questions:
      - What kind of values does an attribute column in my parent segment contain?
      - Can I preview a limited number of sample values for one attribute column?
      instructions:
      - text: Show sample values of attribute column {column} in parent segment {audienceId}.
        slots:
          column: query.column
          audienceId: path.audienceId
      - text: Get up to {limit} sample values for attribute {column} of parent segment {audienceId}.
        slots:
          limit: query.limit
          column: query.column
          audienceId: path.audienceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/audiences/{audienceId}/behaviors/{audienceBehaviorId}/sample_values'].get
  update:
    x-apievangelist-phrasing:
      intent: Sample values of a parent segment behavior
      effect: read
      questions:
      - What do the values in a behavior column look like before I build a segment on it?
      - Can I see sample data from one behavior of a parent segment?
      instructions:
      - text: Show sample values of column {column} in behavior {audienceBehaviorId} of parent segment {audienceId}.
        slots:
          column: query.column
          audienceBehaviorId: path.audienceBehaviorId
          audienceId: path.audienceId
      - text: Get {limit} sample values from behavior {audienceBehaviorId} column {column} in parent segment {audienceId}.
        slots:
          limit: query.limit
          audienceBehaviorId: path.audienceBehaviorId
          column: query.column
          audienceId: path.audienceId
      method: generated
      generated: '2026-09-26'