Amazon SageMaker · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Amazon SageMaker Endpoints API

5 actions 5 updates phrasing extends openapi/amazon-sagemaker-endpoints-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Amazon SageMaker's API. It is a proposal applied on top of the contract, not a document Amazon SageMaker publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info
$.paths['/#CreateEndpoint'].post
$.paths['/#DescribeEndpoint'].post
$.paths['/#ListEndpoints'].post
$.paths['/#CreateEndpointConfig'].post

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 Amazon SageMaker Endpoints API
  version: 1.0.0
extends: openapi/amazon-sagemaker-endpoints-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: 4
- target: $.paths['/#CreateEndpoint'].post
  update:
    x-apievangelist-phrasing:
      intent: Deploy a model to a live hosting endpoint
      effect: write
      questions:
      - How do I put a trained model behind a live SageMaker endpoint for real-time predictions?
      - Which endpoint configuration does a new endpoint need before it can start serving?
      - Can I tag an endpoint when I first stand it up?
      instructions:
      - text: Create endpoint {endpoint_name} using endpoint configuration {config_name}.
        slots:
          endpoint_name: requestBody.EndpointName
          config_name: requestBody.EndpointConfigName
      - text: Stand up a new hosting endpoint called {endpoint_name} from config {config_name} and tag it with {tags}.
        slots:
          endpoint_name: requestBody.EndpointName
          config_name: requestBody.EndpointConfigName
          tags: requestBody.Tags
      method: generated
      generated: '2026-10-01'
- target: $.paths['/#DescribeEndpoint'].post
  update:
    x-apievangelist-phrasing:
      intent: Check the details and status of one endpoint
      effect: read
      questions:
      - Is my inference endpoint finished provisioning and ready to take traffic?
      - What configuration is a specific endpoint currently running with?
      instructions:
      - text: Show me the details of endpoint {endpoint_name}.
        slots:
          endpoint_name: requestBody.EndpointName
      - text: Tell me whether endpoint {endpoint_name} is in service yet.
        slots:
          endpoint_name: requestBody.EndpointName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/#ListEndpoints'].post
  update:
    x-apievangelist-phrasing:
      intent: List hosting endpoints in the account
      effect: read
      questions:
      - Which inference endpoints do I have running in my account right now?
      - Can I see only the endpoints that are failed or still being created?
      - What order can the endpoint list be sorted in?
      instructions:
      - text: List all of my SageMaker endpoints.
      - text: List endpoints with status {status}, sorted by {sort_by}.
        slots:
          status: requestBody.StatusEquals
          sort_by: requestBody.SortBy
      - text: Show the first {max_results} endpoints in {sort_order} order.
        slots:
          max_results: requestBody.MaxResults
          sort_order: requestBody.SortOrder
      method: generated
      generated: '2026-10-01'
- target: $.paths['/#CreateEndpointConfig'].post
  update:
    x-apievangelist-phrasing:
      intent: Define instances and model variants for hosting
      effect: write
      questions:
      - How do I choose the instance types and model variants an endpoint will deploy?
      - Can one endpoint configuration list more than one production variant?
      - What has to exist before I can create an endpoint that serves my model?
      instructions:
      - text: Create endpoint configuration {config_name} with production variants {variants}.
        slots:
          config_name: requestBody.EndpointConfigName
          variants: requestBody.ProductionVariants
      - text: Set up a hosting config named {config_name} that deploys {variants} and tag it {tags}.
        slots:
          config_name: requestBody.EndpointConfigName
          variants: requestBody.ProductionVariants
          tags: requestBody.Tags
      method: generated
      generated: '2026-10-01'