Lytics · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for V1 Lytics Segment ML API

5 actions 5 updates phrasing extends openapi/lytics-segmentml-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Lytics's API. It is a proposal applied on top of the contract, not a document Lytics publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info

$.paths['/api/segmentml/{id}'].get

$.paths['/api/segmentml/{id}'].delete

$.paths['/api/segmentml'].post

$.paths['/api/segmentml/_dependencies/{modelname}'].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 V1 Lytics Segment ML API
  version: 1.0.0
extends: openapi/lytics-segmentml-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['/api/segmentml/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a SegmentML model
      effect: read
      questions:
      - Can I see the features and accuracy of a lookalike model I built?
      - What does a completed SegmentML model return?
      instructions:
      - text: Show SegmentML model {id}.
        slots:
          id: path.id
      - text: Fetch the results of model {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/segmentml/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a SegmentML model
      effect: destructive
      questions:
      - Can I delete a SegmentML model I no longer need?
      - Is it possible to remove a lookalike model?
      instructions:
      - text: Delete SegmentML model {id}.
        slots:
          id: path.id
      - text: Remove machine learning model {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/segmentml'].post
  update:
    x-apievangelist-phrasing:
      intent: Build a SegmentML lookalike model
      effect: write
      questions:
      - Can I build a model that predicts which users look like a target segment?
      - Can the model re-run every week automatically?
      - Can I build a model without scoring every user?
      instructions:
      - text: Build a SegmentML model from source segment {source} to target {target}.
        slots:
          source: query.source
          target: query.target
      - text: 'Train a model from {source} predicting field {target_field}, using behavioral scores: {use_scores}.'
        slots:
          source: query.source
          target_field: query.target_field
          use_scores: query.use_scores
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/segmentml/_dependencies/{modelname}'].get
  update:
    x-apievangelist-phrasing:
      intent: List what depends on a SegmentML model
      effect: read
      questions:
      - What depends on a particular SegmentML model?
      - Can I check a model's dependencies before deleting it?
      instructions:
      - text: Show the dependencies of model {modelname}.
        slots:
          modelname: path.modelname
      - text: List what uses SegmentML model {modelname}.
        slots:
          modelname: path.modelname
      method: generated
      generated: '2026-10-01'