# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Segmentation Service Segment jobs API
  version: 1.0.0
extends: openapi/adobe-suite-segment-jobs-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: 5
- target: $.paths['/segment/jobs'].get
  update:
    x-apievangelist-phrasing:
      intent: List segment evaluation jobs
      effect: read
      questions:
      - Which segment jobs have run recently in my sandbox?
      - Can I filter segment jobs by status, like only the failed ones?
      instructions:
      - text: List my segment jobs.
      - text: List segment jobs with status {status}, {limit} per page.
        slots:
          status: query.status
          limit: query.limit
      - text: Find segment jobs for snapshot {snapshot.name}.
        slots:
          snapshot.name: query.snapshot.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/segment/jobs'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a segment evaluation job
      effect: write
      questions:
      - How do I kick off a job that evaluates my segment definitions?
      - Can I run segmentation on demand instead of waiting for the scheduled run?
      instructions:
      - text: Start a segment job for the segment definitions I list.
      - text: Run a segment job against profile instance {x-profile-instance-id}.
        slots:
          x-profile-instance-id: header.x-profile-instance-id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/segment/jobs/{SEGMENT_JOB_ID}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the status of a segment job
      effect: read
      questions:
      - How do I tell whether my segment job has finished?
      - Can I see the details and progress of one segment job?
      instructions:
      - text: Show segment job {SEGMENT_JOB_ID}.
        slots:
          SEGMENT_JOB_ID: path.SEGMENT_JOB_ID
      - text: Check whether segment job {SEGMENT_JOB_ID} succeeded.
        slots:
          SEGMENT_JOB_ID: path.SEGMENT_JOB_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/segment/jobs/{SEGMENT_JOB_ID}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Cancel a segment job
      effect: destructive
      questions:
      - Can I stop a segment job that is still running?
      - How do I cancel a segment evaluation I started by mistake?
      instructions:
      - text: Cancel segment job {SEGMENT_JOB_ID}.
        slots:
          SEGMENT_JOB_ID: path.SEGMENT_JOB_ID
      - text: Stop the running segment job {SEGMENT_JOB_ID}.
        slots:
          SEGMENT_JOB_ID: path.SEGMENT_JOB_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/segment/jobs/bulk-get'].post
  update:
    x-apievangelist-phrasing:
      intent: Fetch several segment jobs by ID
      effect: read
      questions:
      - Can I check the status of many segment jobs in one request?
      - Is there a bulk lookup for segment jobs by ID?
      instructions:
      - text: Fetch segment jobs {ids}.
        slots:
          ids: requestBody.ids
      - text: Bulk get the status of jobs {ids}.
        slots:
          ids: requestBody.ids
      method: generated
      generated: '2026-09-26'