Amazon Pinpoint · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Amazon Pinpoint Recommenders API

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

What the actions change

x-apievangelist-phrasing

Targets 6

$.info
$.paths['/v1/recommenders'].get
$.paths['/v1/recommenders'].post
$.paths['/v1/recommenders/{recommender-id}'].get
$.paths['/v1/recommenders/{recommender-id}'].put
$.paths['/v1/recommenders/{recommender-id}'].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 Amazon Pinpoint Recommenders API
  version: 1.0.0
extends: openapi/amazon-pinpoint-recommenders-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: 5
- target: $.paths['/v1/recommenders'].get
  update:
    x-apievangelist-phrasing:
      intent: List recommender model configurations
      effect: read
      questions:
      - Which recommender models are connected to my Amazon Pinpoint account?
      - Can I page through all my recommender configurations?
      instructions:
      - text: List all of my recommender configurations.
      - text: Show {page_size} recommender configurations per page.
        slots:
          page_size: query.page-size
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/recommenders'].post
  update:
    x-apievangelist-phrasing:
      intent: Connect a recommender model
      effect: write
      questions:
      - How do I add personalized product recommendations to my messages?
      - Can I hook a machine learning recommender model up to my messaging?
      instructions:
      - text: Create a recommender configuration with {settings}.
        slots:
          settings: requestBody.CreateRecommenderConfiguration
      - text: Connect a new recommender model using {settings} for message personalization.
        slots:
          settings: requestBody.CreateRecommenderConfiguration
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/recommenders/{recommender-id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one recommender configuration
      effect: read
      questions:
      - What settings does a specific recommender configuration use?
      - Can I look up a recommender by its Recommender ID?
      instructions:
      - text: Show recommender configuration {recommender}.
        slots:
          recommender: path.recommender-id
      - text: Get the details of recommender {recommender}.
        slots:
          recommender: path.recommender-id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/recommenders/{recommender-id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a recommender configuration
      effect: write
      questions:
      - How do I change the settings on a recommender I already connected?
      - Can I edit how recommendation data is processed for an existing recommender?
      instructions:
      - text: Update recommender {recommender} with {settings}.
        slots:
          recommender: path.recommender-id
          settings: requestBody.UpdateRecommenderConfiguration
      - text: Change the configuration of existing recommender {recommender}.
        slots:
          recommender: path.recommender-id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/recommenders/{recommender-id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a recommender configuration
      effect: destructive
      questions:
      - How do I disconnect a recommender model I no longer use?
      - Can I remove a recommender configuration permanently?
      instructions:
      - text: Delete recommender configuration {recommender}.
        slots:
          recommender: path.recommender-id
      - text: Remove recommender {recommender} from my account.
        slots:
          recommender: path.recommender-id
      method: generated
      generated: '2026-09-26'