Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Sensei Machine Learning Insights API

5 actions 5 updates phrasing extends openapi/adobe-suite-insights-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 5

$.info

$.paths['/insights'].get

$.paths['/insights'].post

$.paths['/insights/{insightId}'].get

$.paths['/insights/metrics'].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 Insights API
  version: 1.0.0
extends: openapi/adobe-suite-insights-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: 4
- target: $.paths['/insights'].get
  update:
    x-apievangelist-phrasing:
      intent: List model insights from experiment runs
      effect: read
      questions:
      - How do I list insights for all my Sensei experiment runs?
      - Can I sort and page through model insights?
      instructions:
      - text: List all model insights.
      - text: List insights filtered by {property}, ordered by {orderby}, limit {limit}.
        slots:
          property: query.property
          orderby: query.orderby
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/insights'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a model insight
      effect: write
      questions:
      - How do I record a new insight with metrics for a trained model?
      - Can I attach custom evaluation metrics to a model insight?
      instructions:
      - text: Create a model insight with metrics {metrics}.
        slots:
          metrics: requestBody.metrics
      - text: Record a new insight with context {context} and metrics {metrics}.
        slots:
          context: requestBody.context
          metrics: requestBody.metrics
      method: generated
      generated: '2026-09-26'
- target: $.paths['/insights/{insightId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a single model insight
      effect: read
      questions:
      - How do I read one specific insight by ID?
      - Can I view the metrics captured in a particular insight?
      instructions:
      - text: Show insight {insightId}.
        slots:
          insightId: path.insightId
      - text: Get the metrics recorded in insight {insightId}.
        slots:
          insightId: path.insightId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/insights/metrics'].get
  update:
    x-apievangelist-phrasing:
      intent: List default evaluation metrics per algorithm
      effect: read
      questions:
      - What default metrics are available for evaluating a given algorithm?
      - Which metrics does Sensei report by default for classification or regression?
      instructions:
      - text: List default metrics for all algorithms.
      - text: Show the default metrics for algorithm {algorithm}.
        slots:
          algorithm: query.algorithm
      method: generated
      generated: '2026-09-26'