# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for BlueConic REST API v2 Models API
  version: 1.0.0
extends: openapi/blueconic-models-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: 6
- target: $.paths['/models'].get
  update:
    x-apievangelist-phrasing:
      intent: List all machine learning models
      effect: read
      questions:
      - Which models have been uploaded to BlueConic?
      - Can I list models without downloading their binaries?
      instructions:
      - text: List all models.
      - text: Show {count} models starting at index {startIndex}.
        slots:
          count: query.count
          startIndex: query.startIndex
      method: generated
      generated: '2026-10-01'
- target: $.paths['/models'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload a new model
      effect: write
      questions:
      - How do I upload a new machine learning model?
      - Can I create a model with just metadata and add the binary later?
      instructions:
      - text: Create a model with metadata {metadata}.
        slots:
          metadata: requestBody.metadata
      - text: Upload new model {model} with metadata {metadata}.
        slots:
          model: requestBody.model
          metadata: requestBody.metadata
      method: generated
      generated: '2026-10-01'
- target: $.paths['/models/{model}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a model's metadata
      effect: read
      questions:
      - What metadata is stored for one particular model?
      - Can I inspect a model's details without fetching the binary file?
      instructions:
      - text: Get the metadata of model {model}.
        slots:
          model: path.model
      - text: Show me the details of model {model}.
        slots:
          model: path.model
      method: generated
      generated: '2026-10-01'
- target: $.paths['/models/{model}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a model's metadata or binary
      effect: write
      questions:
      - Can I swap in a retrained binary for an existing model?
      - What do I send to change the metadata of a model I already uploaded?
      instructions:
      - text: Update the metadata of model {model} to {metadata}.
        slots:
          model: path.model
          metadata: requestBody.metadata
      - text: Replace the binary of existing model {model} with {newModel}.
        slots:
          model: path.model
          newModel: requestBody.model
      method: generated
      generated: '2026-10-01'
- target: $.paths['/models/{model}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a model
      effect: destructive
      questions:
      - How do I remove a model we no longer use?
      - Is deleting a model permanent?
      instructions:
      - text: Delete model {model}.
        slots:
          model: path.model
      - text: Remove model {model} from BlueConic.
        slots:
          model: path.model
      method: generated
      generated: '2026-10-01'
- target: $.paths['/models/{model}/model'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a model's ONNX binary
      effect: read
      questions:
      - Can I download the ONNX file of a model?
      - Is there a way to skip the download if the model binary hasn't changed?
      instructions:
      - text: Download the binary of model {model}.
        slots:
          model: path.model
      - text: Fetch the binary of model {model} only if it differs from etag {etag}.
        slots:
          model: path.model
          etag: query.etag
      method: generated
      generated: '2026-10-01'