API Evangelist conversational phrasing for Edge Impulse Optimization API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Edge Impulse Optimization API
  version: 1.0.0
extends: openapi/edge-impulse-optimization-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 18
- target: $.paths['/api/{projectId}/optimize/runs'].get
  update:
    x-apievangelist-phrasing:
      intent: List EON Tuner runs for a project
      effect: read
      questions:
      - What EON Tuner runs have been executed on my Edge Impulse project?
      - Can I see the history of every hyperparameter tuning run in a project?
      instructions:
      - text: List all EON Tuner runs for project {projectId}.
        slots:
          projectId: path.projectId
      - text: Show the tuner run history of project {projectId}.
        slots:
          projectId: path.projectId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/{projectId}/optimize/config'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the EON Tuner configuration
      effect: read
      questions:
      - What target device and latency is the EON Tuner currently configured for?
      - Which tuning algorithm and trial limits are set for my project's optimizer?
      instructions:
      - text: Get the EON Tuner configuration for project {projectId}.
        slots:
          projectId: path.projectId
      - text: Show the current optimization settings of project {projectId}.
        slots:
          projectId: path.projectId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/{projectId}/optimize/config'].post
  update:
    x-apievangelist-phrasing:
      intent: Configure the EON Tuner
      effect: write
      questions:
      - How do I set a target device and latency budget for the EON Tuner?
      - Can I cap the maximum number of trials and parallel workers the tuner uses?
      - Is there a way to enable early stopping so the tuner quits when results stop improving?
      instructions:
      - text: Configure the EON Tuner for project {projectId} to target {targetDevice} with {targetLatency} ms latency.
        slots:
          projectId: path.projectId
          targetDevice: requestBody.targetDevice
          targetLatency: requestBody.targetLatency
      - text: Set project {projectId} tuner to target {targetDevice} at {targetLatency} ms, max {tuningMaxTrials} trials.
        slots:
          projectId: path.projectId
          targetDevice: requestBody.targetDevice
          targetLatency: requestBody.targetLatency
          tuningMaxTrials: requestBody.tuningMaxTrials
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/{projectId}/optimize/all-learn-blocks'].get
  update:
    x-apievangelist-phrasing:
      intent: List learn blocks available to the tuner
      effect: read
      questions:
      - Which learning blocks can the EON Tuner choose from in my project?
      - What learn blocks are available for hyperparameter search?
      instructions:
      - text: List all available learn blocks for project {projectId}.
        slots:
          projectId: path.projectId
      - text: Show the learn blocks the optimizer can use in project {projectId}.
        slots:
          projectId: path.projectId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/{projectId}/optimize/window-settings'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the tuner's window settings
      effect: read
      questions:
      - What window size and stride settings will the EON Tuner explore?
      - Can I check the time-series window settings used by the optimizer?
      instructions:
      - text: Get the EON Tuner window settings for project {projectId}.
        slots:
          projectId: path.projectId
      - text: Show the windowing options the optimizer uses in project {projectId}.
        slots:
          projectId: path.projectId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/{projectId}/optimize/score-trial'].post
  update:
    x-apievangelist-phrasing:
      intent: Score a candidate tuner trial
      effect: read
      questions:
      - Can I estimate how a combination of input, DSP and learn blocks would score before running it?
      - How do I get a score for a proposed EON Tuner trial configuration?
      instructions:
      - text: Score a trial in project {projectId} using learn blocks {learnBlocks}.
        slots:
          projectId: path.projectId
          learnBlocks: requestBody.learnBlocks
      - text: Evaluate proposed trial {id} for project {projectId} with DSP blocks {dspBlocks}.
        slots:
          id: requestBody.id
          projectId: path.projectId
          dspBlocks: requestBody.dspBlocks
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/{projectId}/optimize/{jobId}/create-trial'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a trial within a tuner job
      effect: write
      questions:
      - How do I add a new trial to an EON Tuner job that's already running?
      - Can I launch a trial with my own choice of DSP and learn blocks inside a tuner job?
      instructions:
      - text: Create a trial in tuner job {jobId} of project {projectId}.
        slots:
          jobId: path.jobId
          projectId: path.projectId
      - text: Add trial {id} to job {jobId} in project {projectId} using learn blocks {learnBlocks}.
        slots:
          id: requestBody.id
          jobId: path.jobId
          projectId: path.projectId
          learnBlocks: requestBody.learnBlocks
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/{projectId}/optimize/{jobId}/complete-search'].post
  update:
    x-apievangelist-phrasing:
      intent: Mark an EON Tuner run as complete
      effect: write
      questions:
      - How do I finish an EON Tuner run and record whether it succeeded?
      - Can I mark a tuner search job as completed from my own coordinator?
      instructions:
      - text: Complete tuner job {jobId} in project {projectId} with success set to {success}.
        slots:
          jobId: path.jobId
          projectId: path.projectId
          success: requestBody.success
      - text: Mark the EON Tuner search {jobId} for project {projectId} as finished, success {success}.
        slots:
          jobId: path.jobId
          projectId: path.projectId
          success: requestBody.success
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/{projectId}/optimize/space'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the EON Tuner search space
      effect: read
      questions:
      - What range of impulse designs is the EON Tuner going to search over?
      - Can I inspect the search space the optimizer explores for my project?
      instructions:
      - text: Get the EON Tuner search space for project {projectId}.
        slots:
          projectId: path.projectId
      - text: Show which impulse variations the tuner will search in project {projectId}.
        slots:
          projectId: path.projectId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/{projectId}/optimize/state'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the project's current EON Tuner state
      effect: read
      questions:
      - What is the EON Tuner doing right now in my project, and which trials has it produced?
      - Can I check the overall tuner state for a project without picking a run?
      instructions:
      - text: Get the current EON Tuner state for project {projectId}.
        slots:
          projectId: path.projectId
      - text: Show the latest optimizer status and trials of project {projectId}.
        slots:
          projectId: path.projectId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/{projectId}/optimize/state'].delete
  update:
    x-apievangelist-phrasing:
      intent: Clear the project's EON Tuner state
      effect: destructive
      questions:
      - How do I wipe all EON Tuner results and start optimization over?
      - Can I reset the tuner state for a project completely?
      instructions:
      - text: Clear the EON Tuner state for project {projectId}.
        slots:
          projectId: path.projectId
      - text: Reset all tuner results in project {projectId} from scratch.
        slots:
          projectId: path.projectId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/{projectId}/optimize/dsp-parameters'].get
  update:
    x-apievangelist-phrasing:
      intent: Get parameters of an organization DSP block
      effect: read
      questions:
      - What parameters does a custom organization DSP block expose to the tuner?
      - Can I fetch the configurable settings of my organization's DSP block for optimization?
      instructions:
      - text: Get the parameters of DSP block {organizationDspId} from organization {organizationId} in project {projectId}.
        slots:
          organizationDspId: query.organizationDspId
          organizationId: query.organizationId
          projectId: path.projectId
      - text: Show tuner parameters for organization {organizationId} DSP block {organizationDspId} in project {projectId}.
        slots:
          organizationId: query.organizationId
          organizationDspId: query.organizationDspId
          projectId: path.projectId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/{projectId}/optimize/transfer-learning-models'].get
  update:
    x-apievangelist-phrasing:
      intent: List transfer learning models for the tuner
      effect: read
      questions:
      - Which pretrained transfer learning models can the optimizer try?
      - What base models are available for transfer learning in my project's tuner?
      instructions:
      - text: List the transfer learning models available in project {projectId}.
        slots:
          projectId: path.projectId
      - text: Show pretrained models the tuner can use for project {projectId}.
        slots:
          projectId: path.projectId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/{projectId}/optimize/trial/{trialId}/stdout'].get
  update:
    x-apievangelist-phrasing:
      intent: Get logs for a tuner trial
      effect: read
      questions:
      - Where can I read the training output of one EON Tuner trial?
      - How do I debug a trial that failed during optimization?
      instructions:
      - text: Get the logs for trial {trialId} in project {projectId}.
        slots:
          trialId: path.trialId
          projectId: path.projectId
      - text: Show stdout from tuner trial {trialId} of project {projectId}.
        slots:
          trialId: path.trialId
          projectId: path.projectId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/{projectId}/optimize//{jobId}/trial/{trialId}/end-trial'].get
  update:
    x-apievangelist-phrasing:
      intent: End an EON Tuner trial early
      effect: destructive
      questions:
      - Can I stop a single tuner trial early, for example to implement my own early stopping?
      - How do I cut short a trial that is clearly underperforming?
      instructions:
      - text: End trial {trialId} of job {jobId} in project {projectId} early.
        slots:
          trialId: path.trialId
          jobId: path.jobId
          projectId: path.projectId
      - text: Stop tuner trial {trialId} in job {jobId} for project {projectId} now.
        slots:
          trialId: path.trialId
          jobId: path.jobId
          projectId: path.projectId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/{projectId}/optimize/{tunerCoordinatorJobId}/state'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the state of a specific tuner run
      effect: read
      questions:
      - What were the results of one particular EON Tuner run, not just the latest?
      - Can I check progress for a tuner run by its coordinator job ID?
      instructions:
      - text: Get the EON Tuner state for run {tunerCoordinatorJobId} in project {projectId}.
        slots:
          tunerCoordinatorJobId: path.tunerCoordinatorJobId
          projectId: path.projectId
      - text: Show results of tuner run {tunerCoordinatorJobId} from project {projectId}.
        slots:
          tunerCoordinatorJobId: path.tunerCoordinatorJobId
          projectId: path.projectId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/{projectId}/optimize/{tunerCoordinatorJobId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Rename a specific tuner run
      effect: write
      questions:
      - How do I give an EON Tuner run a more descriptive name?
      - Can I edit the label of a past tuner run?
      instructions:
      - text: Rename tuner run {tunerCoordinatorJobId} in project {projectId} to {name}.
        slots:
          tunerCoordinatorJobId: path.tunerCoordinatorJobId
          projectId: path.projectId
          name: requestBody.name
      - text: Set the name of EON Tuner run {tunerCoordinatorJobId} for project {projectId} to {name}.
        slots:
          tunerCoordinatorJobId: path.tunerCoordinatorJobId
          projectId: path.projectId
          name: requestBody.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/{projectId}/optimize/all-blocks'].get
  update:
    x-apievangelist-phrasing:
      intent: List all impulse blocks with tuner details
      effect: read
      questions:
      - Which input, DSP and learn blocks can go into an impulse, with the extra info the tuner needs?
      - Can I get the full catalog of impulse blocks for my project in one call?
      instructions:
      - text: List every possible impulse block for project {projectId}.
        slots:
          projectId: path.projectId
      - text: Show all impulse blocks, including tuner metadata, available in project {projectId}.
        slots:
          projectId: path.projectId
      method: generated
      generated: '2026-10-01'