Adobe Analytics · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Adobe Analytics Classification Classification Job API

11 actions 11 updates phrasing extends openapi/adobe-analytics-classification-job-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Adobe Analytics's API. It is a proposal applied on top of the contract, not a document Adobe Analytics 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-analytics-classification-job-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: 10
- target: $.paths['/{globalCompanyId}/classification/job/import/commitApiJob/{api_job_id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Commit a classification import job
      effect: write
      questions:
      - After uploading my classification file, how do I start processing the import?
      - How do I tell Analytics an API import job is ready to run?
      instructions:
      - text: Commit classification import job {api_job_id} in company {globalCompanyId} for processing.
        slots:
          globalCompanyId: path.globalCompanyId
          api_job_id: path.api_job_id
      - text: Submit API import job {api_job_id} now that its file is uploaded.
        slots:
          api_job_id: path.api_job_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{globalCompanyId}/classification/job/import/createApiJob/{dataset_id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a file-based classification import job
      effect: write
      questions:
      - How do I begin a classification import that I'll upload a file to afterwards?
      - Can I set the data format and encoding for a classification file import?
      instructions:
      - text: Create an API import job named {jobName} on classification dataset {dataset_id} in company {globalCompanyId}.
        slots:
          globalCompanyId: path.globalCompanyId
          jobName: requestBody.jobName
          dataset_id: path.dataset_id
      - text: Open a {dataFormat} file import job on dataset {dataset_id} with encoding {encoding}.
        slots:
          dataFormat: requestBody.dataFormat
          dataset_id: path.dataset_id
          encoding: requestBody.encoding
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{globalCompanyId}/classification/job/export/{dataset_id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Export classification data
      effect: write
      questions:
      - How do I export the classification values from a dataset?
      - Is there a row limit when exporting classification data?
      - Can I export only the classification keys matching a regex?
      instructions:
      - text: Export classification dataset {dataset_id} in company {globalCompanyId} as job {jobName}.
        slots:
          globalCompanyId: path.globalCompanyId
          dataset_id: path.dataset_id
          jobName: requestBody.jobName
      - text: Export up to {rowLimit} rows from classification dataset {dataset_id} where keys match {keyRegex}.
        slots:
          rowLimit: requestBody.rowLimit
          dataset_id: path.dataset_id
          keyRegex: requestBody.keyRegex
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{globalCompanyId}/classification/job/import/json/{dataset_id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Import classification data as JSON
      effect: write
      questions:
      - Can I send classification values directly as JSON instead of uploading a file?
      - What's the size limit for a JSON classification import?
      instructions:
      - text: Import JSON classification data {data} into dataset {dataset_id} in company {globalCompanyId}.
        slots:
          globalCompanyId: path.globalCompanyId
          data: requestBody.data
          dataset_id: path.dataset_id
      - text: Run a JSON import job {jobName} on classification dataset {dataset_id}.
        slots:
          jobName: requestBody.jobName
          dataset_id: path.dataset_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{globalCompanyId}/classification/job/byDataset/{dataset_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: List classification jobs for a dataset
      effect: read
      questions:
      - What import and export jobs have run on my classification dataset recently?
      - Can I look back a set number of days for classification jobs?
      instructions:
      - text: List classification jobs for dataset {dataset_id} in company {globalCompanyId}.
        slots:
          globalCompanyId: path.globalCompanyId
          dataset_id: path.dataset_id
      - text: Show classification jobs on dataset {dataset_id} from the last {lookbackDays} days.
        slots:
          dataset_id: path.dataset_id
          lookbackDays: query.lookbackDays
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{globalCompanyId}/classification/job/{job_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a classification job's status
      effect: read
      questions:
      - Did my classification import job finish?
      - How do I check on a single classification job by its job ID?
      instructions:
      - text: Get classification job {job_id} in company {globalCompanyId}.
        slots:
          globalCompanyId: path.globalCompanyId
          job_id: path.job_id
      - text: Check the status of classification job {job_id}.
        slots:
          job_id: path.job_id
      method: generated
      generated: '2026-10-01'
- 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 file my classification export job produced?
      - Where do I get the output of a finished classification export?
      instructions:
      - text: Download the export file for classification job {job_id} in company {globalCompanyId}.
        slots:
          globalCompanyId: path.globalCompanyId
          job_id: path.job_id
      - text: Fetch the classification export output of job {job_id}.
        slots:
          job_id: path.job_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{globalCompanyId}/classification/job/export/file/{job_id}/{file_name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Download one named classification export file
      effect: read
      questions:
      - If an export job produced several files, how do I download a specific one by name?
      - Can I grab just one file from a multi-file classification export?
      instructions:
      - text: Download file {file_name} from classification export job {job_id} in company {globalCompanyId}.
        slots:
          globalCompanyId: path.globalCompanyId
          file_name: path.file_name
          job_id: path.job_id
      - text: Get export file {file_name} produced by job {job_id}.
        slots:
          file_name: path.file_name
          job_id: path.job_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{globalCompanyId}/classification/job/export/file/{job_id}/list'].get
  update:
    x-apievangelist-phrasing:
      intent: List files from a classification export
      effect: read
      questions:
      - What files did my classification export job generate?
      - How do I see the file names an export job produced before downloading?
      instructions:
      - text: List the export files for classification job {job_id} in company {globalCompanyId}.
        slots:
          globalCompanyId: path.globalCompanyId
          job_id: path.job_id
      - text: Show the file names created by export job {job_id}.
        slots:
          job_id: path.job_id
      method: generated
      generated: '2026-10-01'
- 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 attach my classification data file to an import job I created?
      - What is the maximum file size for a classification import upload?
      instructions:
      - text: Upload the classification file to import job {api_job_id} in company {globalCompanyId}.
        slots:
          globalCompanyId: path.globalCompanyId
          api_job_id: path.api_job_id
      - text: Attach my data file to API import job {api_job_id}.
        slots:
          api_job_id: path.api_job_id
      method: generated
      generated: '2026-10-01'