API Evangelist conversational phrasing for ml Predictions API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for ml Predictions API
  version: 1.0.0
extends: openapi/qliksense-predictions-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: 12
- target: $.paths['/api/v1/ml/deployments/{deploymentId}/aliases/{aliasName}/realtime-predictions/actions/run'].post
  update:
    x-apievangelist-phrasing:
      intent: Get real-time predictions via a deployment alias
      effect: read
      questions:
      - Can I call a deployed model through an alias to get instant predictions?
      - How do I score rows in real time using a named alias like production?
      - Can alias-based predictions include SHAP values?
      instructions:
      - text: Run real-time predictions on {rows} using alias {aliasName} of deployment {deploymentId}.
        slots:
          rows: requestBody.rows
          aliasName: path.aliasName
          deploymentId: path.deploymentId
      - text: Predict through alias {aliasName} on deployment {deploymentId} with SHAP set to {includeShap}.
        slots:
          aliasName: path.aliasName
          deploymentId: path.deploymentId
          includeShap: query.includeShap
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/ml/deployments/{deploymentId}/batch-predictions'].get
  update:
    x-apievangelist-phrasing:
      intent: List batch prediction configurations
      effect: read
      questions:
      - What batch prediction jobs are set up for my deployment?
      - Can I filter batch prediction configurations on a deployment?
      instructions:
      - text: List batch prediction configurations for deployment {deploymentId}.
        slots:
          deploymentId: path.deploymentId
      - text: Show batch predictions on deployment {deploymentId} matching {filter}.
        slots:
          deploymentId: path.deploymentId
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/ml/deployments/{deploymentId}/batch-predictions'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a batch prediction configuration
      effect: write
      questions:
      - How do I set up a batch prediction job for a deployed model?
      - Can I configure predictions to run over a whole dataset?
      instructions:
      - text: Create a batch prediction configuration on deployment {deploymentId}.
        slots:
          deploymentId: path.deploymentId
      - text: Set up a batch prediction for deployment {deploymentId} with {data}.
        slots:
          deploymentId: path.deploymentId
          data: requestBody.data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/ml/deployments/{deploymentId}/batch-predictions/{batchPredictionId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a batch prediction
      effect: read
      questions:
      - Where can I see the configuration and status of one batch prediction?
      - What does a particular batch prediction job look like?
      instructions:
      - text: Get batch prediction {batchPredictionId} on deployment {deploymentId}.
        slots:
          batchPredictionId: path.batchPredictionId
          deploymentId: path.deploymentId
      - text: Show details of batch prediction {batchPredictionId} for deployment {deploymentId}.
        slots:
          batchPredictionId: path.batchPredictionId
          deploymentId: path.deploymentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/ml/deployments/{deploymentId}/batch-predictions/{batchPredictionId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a batch prediction
      effect: destructive
      questions:
      - How do I remove a batch prediction job I no longer need?
      - Can I delete a batch prediction configuration from a deployment?
      instructions:
      - text: Delete batch prediction {batchPredictionId} from deployment {deploymentId}.
        slots:
          batchPredictionId: path.batchPredictionId
          deploymentId: path.deploymentId
      - text: Remove the batch prediction job {batchPredictionId} on {deploymentId}.
        slots:
          batchPredictionId: path.batchPredictionId
          deploymentId: path.deploymentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/ml/deployments/{deploymentId}/batch-predictions/{batchPredictionId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a batch prediction
      effect: write
      questions:
      - Can I change the settings of an existing batch prediction?
      - How do I edit a batch prediction configuration?
      instructions:
      - text: Update batch prediction {batchPredictionId} on deployment {deploymentId}.
        slots:
          batchPredictionId: path.batchPredictionId
          deploymentId: path.deploymentId
      - text: Edit the configuration of batch prediction {batchPredictionId} in {deploymentId}.
        slots:
          batchPredictionId: path.batchPredictionId
          deploymentId: path.deploymentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/ml/deployments/{deploymentId}/batch-predictions/{batchPredictionId}/actions/predict'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a batch prediction now
      effect: write
      questions:
      - How do I trigger a batch prediction to run immediately?
      - Can I run a configured batch prediction on demand?
      instructions:
      - text: Run batch prediction {batchPredictionId} on deployment {deploymentId}.
        slots:
          batchPredictionId: path.batchPredictionId
          deploymentId: path.deploymentId
      - text: Execute the batch prediction job {batchPredictionId} for {deploymentId} now.
        slots:
          batchPredictionId: path.batchPredictionId
          deploymentId: path.deploymentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/ml/deployments/{deploymentId}/batch-predictions/{batchPredictionId}/schedule'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a batch prediction schedule
      effect: read
      questions:
      - When is my batch prediction scheduled to run?
      - What schedule is attached to a batch prediction?
      instructions:
      - text: Show the schedule of batch prediction {batchPredictionId} on deployment {deploymentId}.
        slots:
          batchPredictionId: path.batchPredictionId
          deploymentId: path.deploymentId
      - text: Get when batch prediction {batchPredictionId} in {deploymentId} runs.
        slots:
          batchPredictionId: path.batchPredictionId
          deploymentId: path.deploymentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/ml/deployments/{deploymentId}/batch-predictions/{batchPredictionId}/schedule'].put
  update:
    x-apievangelist-phrasing:
      intent: Add a schedule to a batch prediction
      effect: write
      questions:
      - How do I make a batch prediction run on a recurring schedule?
      - Can I schedule a batch prediction that has no schedule yet?
      instructions:
      - text: Add a schedule {data} to batch prediction {batchPredictionId} on deployment {deploymentId}.
        slots:
          data: requestBody.data
          batchPredictionId: path.batchPredictionId
          deploymentId: path.deploymentId
      - text: Schedule batch prediction {batchPredictionId} in {deploymentId} to run regularly.
        slots:
          batchPredictionId: path.batchPredictionId
          deploymentId: path.deploymentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/ml/deployments/{deploymentId}/batch-predictions/{batchPredictionId}/schedule'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a batch prediction schedule
      effect: destructive
      questions:
      - How do I stop a batch prediction from running on a schedule?
      - Can I unschedule a batch prediction but keep the job?
      instructions:
      - text: Delete the schedule of batch prediction {batchPredictionId} on deployment {deploymentId}.
        slots:
          batchPredictionId: path.batchPredictionId
          deploymentId: path.deploymentId
      - text: Unschedule batch prediction {batchPredictionId} in {deploymentId}.
        slots:
          batchPredictionId: path.batchPredictionId
          deploymentId: path.deploymentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/ml/deployments/{deploymentId}/batch-predictions/{batchPredictionId}/schedule'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a batch prediction schedule
      effect: write
      questions:
      - Can I change how often a scheduled batch prediction runs?
      - How do I edit the existing schedule on a batch prediction?
      instructions:
      - text: Update the schedule of batch prediction {batchPredictionId} on deployment {deploymentId}.
        slots:
          batchPredictionId: path.batchPredictionId
          deploymentId: path.deploymentId
      - text: Change when batch prediction {batchPredictionId} in {deploymentId} is scheduled.
        slots:
          batchPredictionId: path.batchPredictionId
          deploymentId: path.deploymentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/ml/deployments/{deploymentId}/realtime-predictions/actions/run'].post
  update:
    x-apievangelist-phrasing:
      intent: Get real-time predictions from a deployment
      effect: read
      questions:
      - How do I get instant predictions straight from a deployed model?
      - Can real-time predictions explain why a row was not predicted?
      instructions:
      - text: Run real-time predictions on {rows} with deployment {deploymentId}.
        slots:
          rows: requestBody.rows
          deploymentId: path.deploymentId
      - text: Score rows directly against deployment {deploymentId} including SHAP values {includeShap}.
        slots:
          deploymentId: path.deploymentId
          includeShap: query.includeShap
      method: generated
      generated: '2026-09-26'