# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Sensei Machine Learning Experiments API
  version: 1.0.0
extends: openapi/adobe-suite-experiments-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: 10
- target: $.paths['/experiments'].get
  update:
    x-apievangelist-phrasing:
      intent: List machine learning experiments
      effect: read
      questions:
      - Which Sensei ML experiments exist for my MLInstances?
      - Can I filter experiments by a property and sort them?
      instructions:
      - text: List all my ML experiments.
      - text: Show {limit} experiments matching {property}, sorted by {orderby}.
        slots:
          limit: query.limit
          property: query.property
          orderby: query.orderby
      method: generated
      generated: '2026-09-26'
- target: $.paths['/experiments'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a machine learning experiment
      effect: write
      questions:
      - How do I create a new experiment for an MLInstance?
      - Can I tag an experiment when I create it?
      instructions:
      - text: Create an experiment named {name} for MLInstance {mlInstanceId}.
        slots:
          name: requestBody.name
          mlInstanceId: requestBody.mlInstanceId
      - text: Create experiment {name} described as {description} with tags {tags}.
        slots:
          name: requestBody.name
          description: requestBody.description
          tags: requestBody.tags
      method: generated
      generated: '2026-09-26'
- target: $.paths['/experiments'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete all experiments for an MLInstance
      effect: destructive
      questions:
      - Can I wipe out every experiment belonging to one MLInstance in one call?
      - What's the bulk way to clear experiments for an MLInstance?
      instructions:
      - text: Delete all experiments for MLInstance {mlInstanceId}.
        slots:
          mlInstanceId: query.mlInstanceId
      - text: Clear every experiment under MLInstance {mlInstanceId}.
        slots:
          mlInstanceId: query.mlInstanceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/experiments/{experimentId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a machine learning experiment
      effect: read
      questions:
      - What MLInstance and workflow is a particular experiment tied to?
      - Can I look up one experiment by its ID?
      instructions:
      - text: Show experiment {experimentId}.
        slots:
          experimentId: path.experimentId
      - text: Get the details of ML experiment {experimentId}.
        slots:
          experimentId: path.experimentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/experiments/{experimentId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a machine learning experiment
      effect: write
      questions:
      - How do I rename an existing experiment?
      - Can I guard an experiment update with an ETag so I don't overwrite someone else's change?
      instructions:
      - text: Rename experiment {experimentId} to {name}.
        slots:
          experimentId: path.experimentId
          name: requestBody.name
      - text: Update experiment {experimentId} with name {name} and description {description}.
        slots:
          experimentId: path.experimentId
          name: requestBody.name
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/experiments/{experimentId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a machine learning experiment
      effect: destructive
      questions:
      - How do I delete just one experiment?
      - Can I remove a single experiment without touching the others on its MLInstance?
      instructions:
      - text: Delete experiment {experimentId}.
        slots:
          experimentId: path.experimentId
      - text: Remove the single ML experiment {experimentId}.
        slots:
          experimentId: path.experimentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/experiments/{experimentId}/runs'].get
  update:
    x-apievangelist-phrasing:
      intent: List runs of an experiment
      effect: read
      questions:
      - Which training or scoring runs have been executed for an experiment?
      - Can I page through the runs of one experiment?
      instructions:
      - text: List the runs of experiment {experimentId}.
        slots:
          experimentId: path.experimentId
      - text: Show {limit} runs of experiment {experimentId} ordered by {orderby}.
        slots:
          limit: query.limit
          experimentId: path.experimentId
          orderby: query.orderby
      method: generated
      generated: '2026-09-26'
- target: $.paths['/experiments/{experimentId}/runs'].post
  update:
    x-apievangelist-phrasing:
      intent: Start an experiment run
      effect: write
      questions:
      - How do I kick off a training run for an experiment?
      - Can I choose the run mode when starting an experiment run?
      instructions:
      - text: Start a run of experiment {experimentId}.
        slots:
          experimentId: path.experimentId
      - text: Create a {mode} run for experiment {experimentId} with tasks {tasks}.
        slots:
          mode: requestBody.mode
          experimentId: path.experimentId
          tasks: requestBody.tasks
      method: generated
      generated: '2026-09-26'
- target: $.paths['/experiments/{experimentId}/runs/{experimentRunId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an experiment run
      effect: read
      questions:
      - What tasks did a specific experiment run include?
      - Can I see the full details of one run of an experiment?
      instructions:
      - text: Show run {experimentRunId} of experiment {experimentId}.
        slots:
          experimentRunId: path.experimentRunId
          experimentId: path.experimentId
      - text: Get the information for experiment run {experimentRunId} under {experimentId}.
        slots:
          experimentRunId: path.experimentRunId
          experimentId: path.experimentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/experiments/{experimentId}/runs/{experimentRunId}/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check an experiment run's status
      effect: read
      questions:
      - Has my experiment run finished or is it still running?
      - Did a particular experiment run fail?
      instructions:
      - text: Check the status of run {experimentRunId} in experiment {experimentId}.
        slots:
          experimentRunId: path.experimentRunId
          experimentId: path.experimentId
      - text: Tell me whether experiment run {experimentRunId} of {experimentId} is done.
        slots:
          experimentRunId: path.experimentRunId
          experimentId: path.experimentId
      method: generated
      generated: '2026-09-26'