# 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 Performance Calibration API
  version: 1.0.0
extends: openapi/edge-impulse-performancecalibration-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: 11
- target: $.paths['/api/{projectId}/performance-calibration/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Get performance calibration status
      effect: read
      questions:
      - Is performance calibration still running on my project?
      - Can I check calibration status for a specific impulse?
      instructions:
      - text: Get the performance calibration status for project {project}.
        slots:
          project: path.projectId
      - text: Check calibration progress of impulse {impulse} in project {project}.
        slots:
          project: path.projectId
          impulse: query.impulseId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/{projectId}/performance-calibration/ground-truth'].get
  update:
    x-apievangelist-phrasing:
      intent: Get calibration ground truth data
      effect: read
      questions:
      - What ground truth labels did performance calibration use?
      - Can I retrieve the reference labels for a calibration run?
      instructions:
      - text: Get the performance calibration ground truth for project {project}.
        slots:
          project: path.projectId
      - text: Show calibration ground truth for impulse {impulse} of project {project}.
        slots:
          project: path.projectId
          impulse: query.impulseId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/{projectId}/performance-calibration/raw-result'].get
  update:
    x-apievangelist-phrasing:
      intent: Get raw calibration results
      effect: read
      questions:
      - Can I see the unprocessed output of a performance calibration run?
      - Where are the raw model results from calibration?
      instructions:
      - text: Get the raw performance calibration result for project {project}.
        slots:
          project: path.projectId
      - text: Fetch raw calibration output for impulse {impulse} in project {project}.
        slots:
          project: path.projectId
          impulse: query.impulseId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/{projectId}/performance-calibration/parameter-sets'].get
  update:
    x-apievangelist-phrasing:
      intent: List calibration parameter sets
      effect: read
      questions:
      - Which post-processing parameter sets did calibration suggest?
      - Can I compare candidate parameter sets from performance calibration?
      instructions:
      - text: List performance calibration parameter sets for project {project}.
        slots:
          project: path.projectId
      - text: Show suggested parameter sets for impulse {impulse} of project {project}.
        slots:
          project: path.projectId
          impulse: query.impulseId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/{projectId}/performance-calibration/parameters'].get
  update:
    x-apievangelist-phrasing:
      intent: Get saved calibration parameters
      effect: read
      questions:
      - Which performance calibration parameters are currently saved for my project?
      - Can I read the stored calibration settings for one impulse?
      instructions:
      - text: Get the saved performance calibration parameters for project {project}.
        slots:
          project: path.projectId
      - text: Show stored calibration parameters for impulse {impulse} in project {project}.
        slots:
          project: path.projectId
          impulse: query.impulseId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/{projectId}/performance-calibration/parameters'].post
  update:
    x-apievangelist-phrasing:
      intent: Save performance calibration parameters
      effect: write
      questions:
      - How do I keep a chosen set of performance calibration parameters?
      - Can I store calibration parameters for a particular impulse?
      instructions:
      - text: Save calibration parameters {params} for project {project}.
        slots:
          project: path.projectId
          params: requestBody.params
      - text: Store parameters {params} as the calibration settings of impulse {impulse} in project {project}.
        slots:
          project: path.projectId
          params: requestBody.params
          impulse: query.impulseId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/{projectId}/performance-calibration/parameters'].delete
  update:
    x-apievangelist-phrasing:
      intent: Clear saved calibration parameters
      effect: destructive
      questions:
      - Can I remove the calibration parameters I saved?
      - Is there a way to reset only the stored calibration parameters?
      instructions:
      - text: Clear the saved calibration parameters for project {project}.
        slots:
          project: path.projectId
      - text: Delete stored calibration parameters of impulse {impulse} in project {project}.
        slots:
          project: path.projectId
          impulse: query.impulseId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/{projectId}/performance-calibration/wav'].get
  update:
    x-apievangelist-phrasing:
      intent: Download the synthetic calibration WAV
      effect: read
      questions:
      - Can I listen to the synthetic audio sample used for calibration?
      - What format is the synthetic calibration sample delivered in?
      instructions:
      - text: Get the synthetic calibration sample as a WAV for project {project}.
        slots:
          project: path.projectId
      - text: Download the calibration WAV file for impulse {impulse} of project {project}.
        slots:
          project: path.projectId
          impulse: query.impulseId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/{projectId}/performance-calibration/files'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload labeled audio for calibration
      effect: write
      questions:
      - Can I run performance calibration on my own labeled recording?
      - What should the zip contain when uploading audio for calibration?
      instructions:
      - text: Upload calibration zip {zip} with a WAV and labels to project {project}.
        slots:
          project: path.projectId
          zip: requestBody.zip
      - text: Run performance calibration on my labeled audio zip {zip} for impulse {impulse} in project {project}.
        slots:
          project: path.projectId
          zip: requestBody.zip
          impulse: query.impulseId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/{projectId}/performance-calibration/clear'].post
  update:
    x-apievangelist-phrasing:
      intent: Clear all performance calibration state
      effect: destructive
      questions:
      - How do I wipe every bit of performance calibration state and start over?
      - Does clearing calibration state remove more than the saved parameters?
      instructions:
      - text: Clear all performance calibration state for project {project}.
        slots:
          project: path.projectId
      - text: Reset calibration completely for impulse {impulse} in project {project}.
        slots:
          project: path.projectId
          impulse: query.impulseId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/{projectId}/post-processing/results'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the latest post-processing results
      effect: read
      questions:
      - What did the most recent post-processing run produce?
      - Can I get post-processing results for a non-default impulse?
      instructions:
      - text: Get the latest post-processing results for project {project}.
        slots:
          project: path.projectId
      - text: Show post-processing output for impulse {impulse} of project {project}.
        slots:
          project: path.projectId
          impulse: query.impulseId
      method: generated
      generated: '2026-10-01'