Adobe Suite · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Sensei Machine Learning Models API
10 actions
10 updates
phrasing
extends
openapi/adobe-suite-models-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.
What the actions change
x-apievangelist-phrasing
Targets 10
$.info
$.paths['/models'].get
$.paths['/models'].post
$.paths['/models/{modelId}'].get
$.paths['/models/{modelId}'].put
$.paths['/models/{modelId}'].delete
$.paths['/models/{modelId}/artifact'].get
$.paths['/models/{modelId}/transcodings'].get
$.paths['/models/{modelId}/transcodings'].post
$.paths['/models/{modelId}/transcodings/{modelTranscodingId}'].get
OpenAPI Overlay
# 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 Models API
version: 1.0.0
extends: openapi/adobe-suite-models-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: 9
- target: $.paths['/models'].get
update:
x-apievangelist-phrasing:
intent: List machine learning models
effect: read
questions:
- What trained models exist in my Adobe Experience Platform sandbox?
- Can I page, sort and filter the list of models?
instructions:
- text: List all my models.
- text: List models where {property}, ordered by {orderby}, limit {limit}.
slots:
property: query.property
orderby: query.orderby
limit: query.limit
method: generated
generated: '2026-09-26'
- target: $.paths['/models'].post
update:
x-apievangelist-phrasing:
intent: Create a model for an engine and ML instance
effect: write
questions:
- How do I register a new model for an engine and ML instance?
- Can I upload a model artifact when creating the model?
instructions:
- text: Create a model from {model}.
slots:
model: requestBody.model
- text: Create a model {model} and attach the artifact {modelArtifact}.
slots:
model: requestBody.model
modelArtifact: requestBody.modelArtifact
method: generated
generated: '2026-09-26'
- target: $.paths['/models/{modelId}'].get
update:
x-apievangelist-phrasing:
intent: Get one model's details
effect: read
questions:
- How do I look up the metadata for a specific model?
- What state is a given model in right now?
instructions:
- text: Show model {modelId}.
slots:
modelId: path.modelId
- text: Get the details and state of model {modelId}.
slots:
modelId: path.modelId
method: generated
generated: '2026-09-26'
- target: $.paths['/models/{modelId}'].put
update:
x-apievangelist-phrasing:
intent: Update an existing model
effect: write
questions:
- How do I rename a model or change its description?
- Which experiment run must I reference when updating a model?
instructions:
- text: Update model {modelId} for experiment run {experimentRunId}.
slots:
modelId: path.modelId
experimentRunId: requestBody.experimentRunId
- text: Rename model {modelId} to {name} for run {experimentRunId}.
slots:
modelId: path.modelId
name: requestBody.name
experimentRunId: requestBody.experimentRunId
method: generated
generated: '2026-09-26'
- target: $.paths['/models/{modelId}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a model
effect: destructive
questions:
- How do I permanently remove a model I no longer need?
- Can I delete a single trained model by its ID?
instructions:
- text: Delete model {modelId}.
slots:
modelId: path.modelId
- text: Remove the model {modelId} from the sandbox.
slots:
modelId: path.modelId
method: generated
generated: '2026-09-26'
- target: $.paths['/models/{modelId}/artifact'].get
update:
x-apievangelist-phrasing:
intent: Download a model's binary artifact
effect: read
questions:
- How do I download the binary file behind a trained model?
- Can I get the raw model artifact rather than its metadata?
instructions:
- text: Download the artifact for model {modelId}.
slots:
modelId: path.modelId
- text: Fetch the binary file of model {modelId}.
slots:
modelId: path.modelId
method: generated
generated: '2026-09-26'
- target: $.paths['/models/{modelId}/transcodings'].get
update:
x-apievangelist-phrasing:
intent: List a model's transcodings
effect: read
questions:
- Which format conversions have been made for a model?
- Can I page through a model's transcodings?
instructions:
- text: List the transcodings of model {modelId}.
slots:
modelId: path.modelId
- text: Show the first {limit} transcodings of model {modelId}.
slots:
limit: query.limit
modelId: path.modelId
method: generated
generated: '2026-09-26'
- target: $.paths['/models/{modelId}/transcodings'].post
update:
x-apievangelist-phrasing:
intent: Transcode a model into another format
effect: write
questions:
- How do I convert a model into a different target format?
- What do I need to request a new transcoding of a model?
instructions:
- text: Transcode model {modelId} to {targetFormat}.
slots:
modelId: path.modelId
targetFormat: requestBody.targetFormat
- text: Create a new transcoding for model {modelId}.
slots:
modelId: path.modelId
method: generated
generated: '2026-09-26'
- target: $.paths['/models/{modelId}/transcodings/{modelTranscodingId}'].get
update:
x-apievangelist-phrasing:
intent: Get one model transcoding
effect: read
questions:
- How do I check a specific transcoding of a model?
- What target format does a particular model transcoding have?
instructions:
- text: Show transcoding {modelTranscodingId} of model {modelId}.
slots:
modelTranscodingId: path.modelTranscodingId
modelId: path.modelId
- text: Get details of model {modelId} transcoding {modelTranscodingId}.
slots:
modelId: path.modelId
modelTranscodingId: path.modelTranscodingId
method: generated
generated: '2026-09-26'