# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Batch Ingestion API
  version: 1.0.0
extends: openapi/adobe-suite-batch-ingestion-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: 7
- target: $.paths['/batches'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a new ingestion batch for a dataset
      effect: write
      questions:
      - How do I open a batch before uploading files to a dataset?
      - Which input formats can a new ingestion batch accept?
      instructions:
      - text: Create a batch for dataset {datasetId} in format {inputFormat}.
        slots:
          datasetId: requestBody.datasetId
          inputFormat: requestBody.inputFormat
      - text: Start a {inputFormat} batch into dataset {datasetId} tagged {tags}.
        slots:
          inputFormat: requestBody.inputFormat
          datasetId: requestBody.datasetId
          tags: requestBody.tags
      method: generated
      generated: '2026-09-26'
- target: $.paths['/batches/{batchId}/datasets/{datasetId}/files/{filePath}'].put
  update:
    x-apievangelist-phrasing:
      intent: Upload a small file into a batch
      effect: write
      questions:
      - How do I upload a file under 256MB to a dataset in my batch?
      - Does a small file upload overwrite a file already at the same path?
      instructions:
      - text: Upload {filePath} to dataset {datasetId} in batch {batchId}.
        slots:
          filePath: path.filePath
          datasetId: path.datasetId
          batchId: path.batchId
      - text: Put small file {filePath} into batch {batchId} for dataset {datasetId}.
        slots:
          filePath: path.filePath
          batchId: path.batchId
          datasetId: path.datasetId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/batches/{batchId}/datasets/{datasetId}/files/{filePath}'].post
  update:
    x-apievangelist-phrasing:
      intent: Initialize or finish a large file upload
      effect: write
      questions:
      - How do I begin uploading a file larger than 256MB to a batch?
      - What call tells the service my large file parts are all uploaded?
      instructions:
      - text: Initialize a large upload of {filePath} to dataset {datasetId} in batch {batchId}.
        slots:
          filePath: path.filePath
          datasetId: path.datasetId
          batchId: path.batchId
      - text: Mark large file {filePath} in batch {batchId}, dataset {datasetId} with action {action}.
        slots:
          filePath: path.filePath
          batchId: path.batchId
          datasetId: path.datasetId
          action: query.action
      method: generated
      generated: '2026-09-26'
- target: $.paths['/batches/{batchId}/datasets/{datasetId}/files/{filePath}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Upload one part of a large file
      effect: write
      questions:
      - How do I send a chunk of a big file after initializing the upload?
      - Which byte range header do I set when uploading a file part?
      instructions:
      - text: Upload bytes {Content-Range} of {filePath} to batch {batchId}, dataset {datasetId}.
        slots:
          Content-Range: header.Content-Range
          filePath: path.filePath
          batchId: path.batchId
          datasetId: path.datasetId
      - text: Send the next part of large file {filePath} in batch {batchId} for dataset {datasetId}.
        slots:
          filePath: path.filePath
          batchId: path.batchId
          datasetId: path.datasetId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/batches/{batchId}/datasets/{datasetId}/files/{filePath}'].head
  update:
    x-apievangelist-phrasing:
      intent: Check how much of a large file has arrived
      effect: read
      questions:
      - How can I see which byte ranges of my large upload the server has received?
      - Can I check progress before resuming a large file upload?
      instructions:
      - text: Check upload progress of {filePath} in batch {batchId}, dataset {datasetId}.
        slots:
          filePath: path.filePath
          batchId: path.batchId
          datasetId: path.datasetId
      - text: Tell me what bytes of {filePath} have arrived for batch {batchId} dataset {datasetId}.
        slots:
          filePath: path.filePath
          batchId: path.batchId
          datasetId: path.datasetId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/batches/{batchId}/datasets/{datasetId}/preview'].get
  update:
    x-apievangelist-phrasing:
      intent: Preview the data uploaded to a batch
      effect: read
      questions:
      - Can I preview the rows I have uploaded before completing a batch?
      - How do I preview a CSV upload with a custom delimiter?
      instructions:
      - text: Preview dataset {datasetId} in batch {batchId} as {format}.
        slots:
          datasetId: path.datasetId
          batchId: path.batchId
          format: query.format
      - text: Show the first {nrow} rows of batch {batchId} dataset {datasetId} as {format}.
        slots:
          nrow: query.nrow
          batchId: path.batchId
          datasetId: path.datasetId
          format: query.format
      method: generated
      generated: '2026-09-26'
- target: $.paths['/batches/{batchId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Complete a batch to trigger promotion
      effect: write
      questions:
      - How do I signal that all files for a batch are uploaded?
      - What kicks off downstream data promotion for an ingestion batch?
      instructions:
      - text: Complete batch {batchId}.
        slots:
          batchId: path.batchId
      - text: Finish batch {batchId} with action {action}.
        slots:
          batchId: path.batchId
          action: query.action
      method: generated
      generated: '2026-09-26'