# 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 Deployment API
  version: 1.0.0
extends: openapi/edge-impulse-deployment-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: 16
- target: $.paths['/api/deployment/targets'].get
  update:
    x-apievangelist-phrasing:
      intent: List every deployment target on the platform
      effect: read
      questions:
      - Which hardware and library targets can Edge Impulse models be deployed to?
      - What deployment targets exist across the whole platform, regardless of project?
      instructions:
      - text: List all deployment targets the platform supports.
      - text: Show the global catalog of deployment targets.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/{projectId}/deployment/targets'].get
  update:
    x-apievangelist-phrasing:
      intent: List deployment targets for a project
      effect: read
      questions:
      - Which boards and formats can I deploy my project's impulse to?
      - Can I see deployment targets for a specific impulse in my project?
      instructions:
      - text: List the deployment targets available for project {projectId}.
        slots:
          projectId: path.projectId
      - text: Show deployment targets for impulse {impulseId} in project {projectId}.
        slots:
          impulseId: query.impulseId
          projectId: path.projectId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/{projectId}/deployment/targets/data-sources'].get
  update:
    x-apievangelist-phrasing:
      intent: List deployment targets for the data sources page
      effect: read
      questions:
      - Which Linux deploy targets show up on my project's data sources page?
      - Why does the data sources view hide the mobile phone and computer targets?
      instructions:
      - text: List the data-sources deployment targets for project {projectId}.
        slots:
          projectId: path.projectId
      - text: Show the Linux deploy targets offered on the data sources page of project {projectId}.
        slots:
          projectId: path.projectId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/{projectId}/deployment/evaluate'].get
  update:
    x-apievangelist-phrasing:
      intent: Get performance results for impulse variants
      effect: read
      questions:
      - How does each variant of my impulse perform before I pick one to deploy?
      - Where do I find the detailed evaluation statistics for every model variant?
      instructions:
      - text: Get the evaluate job results for project {projectId}.
        slots:
          projectId: path.projectId
      - text: Show performance stats for every variant of impulse {impulseId} in project {projectId}.
        slots:
          impulseId: query.impulseId
          projectId: path.projectId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/{projectId}/deployment/evaluate/cache'].get
  update:
    x-apievangelist-phrasing:
      intent: Check for cached evaluation results
      effect: read
      questions:
      - Are evaluation results already cached for my project without running a new job?
      - Can I check the cache for variant performance stats and get an error if none exist?
      instructions:
      - text: Check the cache for evaluate job results in project {projectId}.
        slots:
          projectId: path.projectId
      - text: Return cached variant evaluation results for impulse {impulseId} in project {projectId} only if present.
        slots:
          impulseId: query.impulseId
          projectId: path.projectId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/{projectId}/deployment'].get
  update:
    x-apievangelist-phrasing:
      intent: Check whether a deployment is already built
      effect: read
      questions:
      - Has a build already been made for this deployment type in my project?
      - Can I check if a quantized or float build exists for a target before rebuilding?
      instructions:
      - text: Check whether project {projectId} already has a {type} deployment built.
        slots:
          projectId: path.projectId
          type: query.type
      - text: Get deployment info for type {type} with model type {modelType} in project {projectId}.
        slots:
          type: query.type
          modelType: query.modelType
          projectId: path.projectId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/{projectId}/deployment/download'].get
  update:
    x-apievangelist-phrasing:
      intent: Download the current deployment build
      effect: read
      questions:
      - How do I download the built firmware or library for my project?
      - Can I pick the inference engine when downloading build artefacts?
      instructions:
      - text: Download the {type} build artefacts for project {projectId}.
        slots:
          type: query.type
          projectId: path.projectId
      - text: Download the {type} build for project {projectId} using engine {engine}.
        slots:
          type: query.type
          projectId: path.projectId
          engine: query.engine
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/{projectId}/deployment/last'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the last successful deployment build
      effect: read
      questions:
      - What was my most recent successful deployment and is it still valid?
      - Is the last build I made still up to date with my impulse?
      instructions:
      - text: Show the last successful deployment build for project {projectId}.
        slots:
          projectId: path.projectId
      - text: Check whether the latest build for impulse {impulseId} in project {projectId} is still valid.
        slots:
          impulseId: query.impulseId
          projectId: path.projectId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/{projectId}/deployment/syntiant/posterior'].get
  update:
    x-apievangelist-phrasing:
      intent: Get Syntiant posterior parameters
      effect: read
      questions:
      - What posterior parameters are set for my Syntiant deployment?
      - Where can I read the current Syntiant posterior settings?
      instructions:
      - text: Get the Syntiant posterior parameters for project {projectId}.
        slots:
          projectId: path.projectId
      - text: Show the current Syntiant posterior settings for impulse {impulseId} in project {projectId}.
        slots:
          impulseId: query.impulseId
          projectId: path.projectId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/{projectId}/deployment/syntiant/posterior'].post
  update:
    x-apievangelist-phrasing:
      intent: Set Syntiant posterior parameters manually
      effect: write
      questions:
      - How do I manually change the posterior parameters for a Syntiant target?
      - Can I overwrite the Syntiant posterior settings with my own values?
      instructions:
      - text: Set the Syntiant posterior parameters for project {projectId} to {parameters}.
        slots:
          projectId: path.projectId
          parameters: requestBody.parameters
      - text: Save posterior values {parameters} for the Syntiant target of impulse {impulseId} in project {projectId}.
        slots:
          parameters: requestBody.parameters
          impulseId: query.impulseId
          projectId: path.projectId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/{projectId}/jobs/find-syntiant-posterior'].post
  update:
    x-apievangelist-phrasing:
      intent: Auto-tune Syntiant posterior parameters
      effect: write
      questions:
      - Can Edge Impulse automatically find the best Syntiant posterior parameters for my keywords?
      - What reference set and target words does the Syntiant posterior search job need?
      instructions:
      - text: Start a job to find Syntiant posterior parameters for words {targetWords} in project {projectId} using reference set {referenceSet}.
        slots:
          targetWords: requestBody.targetWords
          projectId: path.projectId
          referenceSet: requestBody.referenceSet
      - text: Automatically tune Syntiant posteriors in project {projectId} for {targetWords} against {referenceSet} on target {deploymentTarget}.
        slots:
          projectId: path.projectId
          targetWords: requestBody.targetWords
          referenceSet: requestBody.referenceSet
          deploymentTarget: requestBody.deploymentTarget
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/{projectId}/deployment/history'].get
  update:
    x-apievangelist-phrasing:
      intent: List previously built deployments
      effect: read
      questions:
      - Which deployments have I successfully built for this project over time?
      - Can I filter my deployment history by format?
      instructions:
      - text: List the deployment history for project {projectId}.
        slots:
          projectId: path.projectId
      - text: Show past {deploymentFormat} deployments built in project {projectId}.
        slots:
          deploymentFormat: query.deploymentFormat
          projectId: path.projectId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/{projectId}/deployment/history/{deploymentVersion}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get details of a past deployment version
      effect: read
      questions:
      - What settings were used for an older deployment version of my project?
      - Can I look up information about deployment version 3?
      instructions:
      - text: Get details of deployment version {deploymentVersion} in project {projectId}.
        slots:
          deploymentVersion: path.deploymentVersion
          projectId: path.projectId
      - text: Show what was built in historic deployment {deploymentVersion} of project {projectId}.
        slots:
          deploymentVersion: path.deploymentVersion
          projectId: path.projectId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/{projectId}/deployment/history/{deploymentVersion}/download'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a past deployment version
      effect: read
      questions:
      - How do I re-download an older build of my model instead of the latest one?
      - Can I get the files for a previous deployment version?
      instructions:
      - text: Download deployment version {deploymentVersion} of project {projectId}.
        slots:
          deploymentVersion: path.deploymentVersion
          projectId: path.projectId
      - text: Fetch the build files from historic deployment {deploymentVersion} in project {projectId}.
        slots:
          deploymentVersion: path.deploymentVersion
          projectId: path.projectId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/{projectId}/deployment/public/build'].post
  update:
    x-apievangelist-phrasing:
      intent: Build a WebAssembly deployment of a public project
      effect: write
      questions:
      - Can I build a WebAssembly deployment for someone else's public project?
      - Which deployment types are allowed when building from a public project?
      instructions:
      - text: Build a {deploymentType} deployment of public project {projectId} with model type {modelType}.
        slots:
          deploymentType: requestBody.deploymentType
          projectId: path.projectId
          modelType: requestBody.modelType
      - text: Start a public wasm build for project {projectId} using {modelType} weights as type {deploymentType}.
        slots:
          projectId: path.projectId
          modelType: requestBody.modelType
          deploymentType: requestBody.deploymentType
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/{projectId}/deployment/public/jobs/{jobId}/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a public project build job
      effect: read
      questions:
      - Has the WebAssembly build I started on a public project finished?
      - What is the status of a public deployment build job?
      instructions:
      - text: Get the status of public build job {jobId} for project {projectId}.
        slots:
          jobId: path.jobId
          projectId: path.projectId
      - text: Check whether the public wasm build {jobId} in project {projectId} is done.
        slots:
          jobId: path.jobId
          projectId: path.projectId
      method: generated
      generated: '2026-10-01'