Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Sensei Machine Learning ML Instances API

7 actions 7 updates phrasing extends openapi/adobe-suite-mlinstances-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Adobe Suite's API. It is a proposal applied on top of the contract, not a document Adobe Suite publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 7

$.info
$.paths['/mlInstances'].get
$.paths['/mlInstances'].post
$.paths['/mlInstances'].delete
$.paths['/mlInstances/{mlInstanceId}'].get
$.paths['/mlInstances/{mlInstanceId}'].put
$.paths['/mlInstances/{mlInstanceId}'].delete

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Sensei Machine Learning ML Instances API
  version: 1.0.0
extends: openapi/adobe-suite-mlinstances-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: 6
- target: $.paths['/mlInstances'].get
  update:
    x-apievangelist-phrasing:
      intent: List ML instances
      effect: read
      questions:
      - How do I see all the ML instances I've set up?
      - Can I search ML instances by name or tag?
      instructions:
      - text: List my ML instances.
      - text: Find ML instances where {property}, showing {limit} results.
        slots:
          property: query.property
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/mlInstances'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an ML instance of an engine
      effect: write
      questions:
      - How can I create a new MLInstance from an existing engine?
      - What's required to add an ML instance, and can I tag it?
      instructions:
      - text: Create an ML instance named {name} for engine {engineId}.
        slots:
          name: requestBody.name
          engineId: requestBody.engineId
      - text: Add ML instance {name} with description {description} and tags {tags}.
        slots:
          name: requestBody.name
          description: requestBody.description
          tags: requestBody.tags
      method: generated
      generated: '2026-09-26'
- target: $.paths['/mlInstances'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete all ML instances for an engine
      effect: destructive
      questions:
      - Can I remove every ML instance built on one engine at once?
      - Is there a bulk delete of ML instances by engine?
      instructions:
      - text: Delete all ML instances for engine {engineId}.
        slots:
          engineId: query.engineId
      - text: Wipe out every MLInstance that belongs to engine {engineId}.
        slots:
          engineId: query.engineId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/mlInstances/{mlInstanceId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an ML instance
      effect: read
      questions:
      - How do I look up one ML instance's details?
      - What configuration does a specific MLInstance hold?
      instructions:
      - text: Show ML instance {mlInstanceId}.
        slots:
          mlInstanceId: path.mlInstanceId
      - text: Get the configuration of MLInstance {mlInstanceId}.
        slots:
          mlInstanceId: path.mlInstanceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/mlInstances/{mlInstanceId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an ML instance
      effect: write
      questions:
      - Can I rename or retag an existing ML instance?
      - Does updating an ML instance support an If-Match check?
      instructions:
      - text: Rename ML instance {mlInstanceId} to {name}.
        slots:
          mlInstanceId: path.mlInstanceId
          name: requestBody.name
      - text: Update MLInstance {mlInstanceId} with name {name} and tags {tags}.
        slots:
          mlInstanceId: path.mlInstanceId
          name: requestBody.name
          tags: requestBody.tags
      method: generated
      generated: '2026-09-26'
- target: $.paths['/mlInstances/{mlInstanceId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete one ML instance
      effect: destructive
      questions:
      - How do I delete a single ML instance?
      - Can I remove one MLInstance by ID without affecting others on the same engine?
      instructions:
      - text: Delete ML instance {mlInstanceId}.
        slots:
          mlInstanceId: path.mlInstanceId
      - text: Remove just the MLInstance {mlInstanceId}.
        slots:
          mlInstanceId: path.mlInstanceId
      method: generated
      generated: '2026-09-26'