Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Sensei Machine Learning Engines API

7 actions 7 updates phrasing extends openapi/adobe-suite-engines-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['/engines'].get
$.paths['/engines'].post
$.paths['/engines/dockerRegistry'].get
$.paths['/engines/{engineId}'].get
$.paths['/engines/{engineId}'].put
$.paths['/engines/{engineId}'].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 Engines API
  version: 1.0.0
extends: openapi/adobe-suite-engines-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['/engines'].get
  update:
    x-apievangelist-phrasing:
      intent: List Sensei ML engines
      effect: read
      questions:
      - Which machine learning engines have been onboarded in my organization?
      - Can I filter and sort the list of Sensei engines?
      instructions:
      - text: List all Sensei engines.
      - text: Show {limit} engines matching {property}, sorted by {orderby}.
        slots:
          limit: query.limit
          property: query.property
          orderby: query.orderby
      method: generated
      generated: '2026-09-26'
- target: $.paths['/engines'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a Sensei ML engine
      effect: write
      questions:
      - How do I onboard a new ML engine with a JAR or EGG artifact?
      - Can I supply a separate artifact just for the train step?
      instructions:
      - text: Create an engine described by {engine} using artifact {defaultArtifact}.
        slots:
          engine: requestBody.engine
          defaultArtifact: requestBody.defaultArtifact
      - text: Create engine {engine} with default artifact {defaultArtifact} and training artifact {trainOverrideArtifact}.
        slots:
          engine: requestBody.engine
          defaultArtifact: requestBody.defaultArtifact
          trainOverrideArtifact: requestBody.trainOverrideArtifact
      method: generated
      generated: '2026-09-26'
- target: $.paths['/engines/dockerRegistry'].get
  update:
    x-apievangelist-phrasing:
      intent: Get Docker registry details for engines
      effect: read
      questions:
      - What Docker registry should I push my engine images to?
      - Where do I find the registry credentials for Sensei engine containers?
      instructions:
      - text: Get the Docker registry information for Sensei engines in sandbox {sandbox}.
        slots:
          sandbox: header.x-sandbox-name
      - text: Show me the container registry I should use for my ML engine images.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/engines/{engineId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Sensei ML engine
      effect: read
      questions:
      - What algorithm and language does a particular engine use?
      - Can I look up one engine by its ID?
      instructions:
      - text: Show engine {engineId}.
        slots:
          engineId: path.engineId
      - text: Get the details of Sensei engine {engineId}.
        slots:
          engineId: path.engineId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/engines/{engineId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a Sensei ML engine
      effect: write
      questions:
      - How do I rename an existing engine or change its description?
      - Can I update an engine's documentation URL?
      instructions:
      - text: Rename engine {engineId} to {name}.
        slots:
          engineId: path.engineId
          name: requestBody.name
      - text: Update engine {engineId} with name {name} and docs at {documentationUrl}.
        slots:
          engineId: path.engineId
          name: requestBody.name
          documentationUrl: requestBody.documentationUrl
      method: generated
      generated: '2026-09-26'
- target: $.paths['/engines/{engineId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Sensei ML engine
      effect: destructive
      questions:
      - How do I remove an engine I no longer need?
      - Can I delete a specific Sensei engine by ID?
      instructions:
      - text: Delete engine {engineId}.
        slots:
          engineId: path.engineId
      - text: Remove Sensei engine {engineId}.
        slots:
          engineId: path.engineId
      method: generated
      generated: '2026-09-26'