Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Adobe Analytics Classification Classification Job API

11 actions 11 updates phrasing extends openapi/adobe-suite-classification-job-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 11

$.info
$.paths['/{globalCompanyId}/classification/job/import/commitApiJob/{api_job_id}'].post
$.paths['/{globalCompanyId}/classification/job/import/createApiJob/{dataset_id}'].post
$.paths['/{globalCompanyId}/classification/job/export/{dataset_id}'].post
$.paths['/{globalCompanyId}/classification/job/import/json/{dataset_id}'].post
$.paths['/{globalCompanyId}/classification/job/byDataset/{dataset_id}'].get
$.paths['/{globalCompanyId}/classification/job/{job_id}'].get
$.paths['/{globalCompanyId}/classification/job/export/file/{job_id}'].get
$.paths['/{globalCompanyId}/classification/job/export/file/{job_id}/{file_name}'].get
$.paths['/{globalCompanyId}/classification/job/export/file/{job_id}/list'].get
$.paths['/{globalCompanyId}/classification/job/import/uploadFile/{api_job_id}'].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 Adobe Analytics Classification Classification Job API
  version: 1.0.0
extends: openapi/adobe-suite-classification-job-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: 10
- target: $.paths['/{globalCompanyId}/classification/job/import/commitApiJob/{api_job_id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Commit an import job for processing
      effect: write
      questions:
      - After uploading my classification file, how do I tell the import job to start processing?
      - What step finalizes an API import job so its data gets applied?
      instructions:
      - text: Commit import job {job} in company {company} for processing.
        slots:
          job: path.api_job_id
          company: path.globalCompanyId
      - text: Start processing the uploaded classification import {job}.
        slots:
          job: path.api_job_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{globalCompanyId}/classification/job/import/createApiJob/{dataset_id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a file-based classification import job
      effect: write
      questions:
      - How do I set up an import job on a classification dataset before uploading a file?
      - Can I choose the data format and encoding when creating a classification import job?
      instructions:
      - text: Create an import job named {name} on classification dataset {dataset} in company {company}.
        slots:
          name: requestBody.jobName
          dataset: path.dataset_id
          company: path.globalCompanyId
      - text: Open a new file import job on dataset {dataset} using format {format}.
        slots:
          dataset: path.dataset_id
          format: requestBody.dataFormat
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{globalCompanyId}/classification/job/export/{dataset_id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Export a classification dataset
      effect: write
      questions:
      - How do I export the rows of a classification dataset to a file?
      - Is there a row limit on classification exports, and can I filter by date?
      instructions:
      - text: Export classification dataset {dataset} in company {company}.
        slots:
          dataset: path.dataset_id
          company: path.globalCompanyId
      - text: Export up to {limit} rows of dataset {dataset} changed between {start} and {end}.
        slots:
          limit: requestBody.rowLimit
          dataset: path.dataset_id
          start: requestBody.dateFilterStart
          end: requestBody.dateFilterEnd
      - text: Export only keys matching {regex} from dataset {dataset}.
        slots:
          regex: requestBody.keyRegex
          dataset: path.dataset_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{globalCompanyId}/classification/job/import/json/{dataset_id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Import classification data as inline JSON
      effect: write
      questions:
      - Can I send classification rows directly as JSON instead of uploading a file?
      - What is the size limit for a JSON classification import?
      instructions:
      - text: Import this JSON data {data} into classification dataset {dataset} in company {company}.
        slots:
          data: requestBody.data
          dataset: path.dataset_id
          company: path.globalCompanyId
      - text: Run a JSON import job named {name} on dataset {dataset}.
        slots:
          name: requestBody.jobName
          dataset: path.dataset_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{globalCompanyId}/classification/job/byDataset/{dataset_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: List classification jobs for a dataset
      effect: read
      questions:
      - Which import and export jobs have run against a classification dataset?
      - Can I limit the dataset job history to the last few days?
      instructions:
      - text: List classification jobs for dataset {dataset} in company {company}.
        slots:
          dataset: path.dataset_id
          company: path.globalCompanyId
      - text: Show jobs on dataset {dataset} from the last {days} days.
        slots:
          dataset: path.dataset_id
          days: query.lookbackDays
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{globalCompanyId}/classification/job/{job_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a classification job's status
      effect: read
      questions:
      - How do I check whether my classification import or export job finished?
      - Can I look up one classification job by its job ID?
      instructions:
      - text: Get classification job {job} in company {company}.
        slots:
          job: path.job_id
          company: path.globalCompanyId
      - text: Tell me the current state of classification job {job}.
        slots:
          job: path.job_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{globalCompanyId}/classification/job/export/file/{job_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a classification export file
      effect: read
      questions:
      - How do I download the output of a finished classification export?
      - Where do I get the exported file once the export job completes?
      instructions:
      - text: Download the export file for job {job} in company {company}.
        slots:
          job: path.job_id
          company: path.globalCompanyId
      - text: Get the exported classification data from job {job}.
        slots:
          job: path.job_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{globalCompanyId}/classification/job/export/file/{job_id}/{file_name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a named file from a classification export
      effect: read
      questions:
      - When an export produced several files, how do I download one of them by name?
      - Can I fetch a specific export file from a classification job?
      instructions:
      - text: Download file {file} from export job {job} in company {company}.
        slots:
          file: path.file_name
          job: path.job_id
          company: path.globalCompanyId
      - text: Fetch the export part named {file} for job {job}.
        slots:
          file: path.file_name
          job: path.job_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{globalCompanyId}/classification/job/export/file/{job_id}/list'].get
  update:
    x-apievangelist-phrasing:
      intent: List the files produced by a classification export
      effect: read
      questions:
      - Which files did my classification export job produce?
      - Can I see the file names from an export before downloading them?
      instructions:
      - text: List the export files for job {job} in company {company}.
        slots:
          job: path.job_id
          company: path.globalCompanyId
      - text: Show me the file names generated by export {job}.
        slots:
          job: path.job_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{globalCompanyId}/classification/job/import/uploadFile/{api_job_id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload a file to a classification import job
      effect: write
      questions:
      - How do I upload my classification data file to an import job?
      - What is the maximum file size for a classification import upload?
      instructions:
      - text: Upload my classification file to import job {job} in company {company}.
        slots:
          job: path.api_job_id
          company: path.globalCompanyId
      - text: Attach this data file to import job {job}.
        slots:
          job: path.api_job_id
      method: generated
      generated: '2026-09-26'