Generated by API Evangelist
Written by API Evangelist tooling for Microsoft Azure's API. It is a proposal applied on top of the contract, not a document Microsoft Azure publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Microsoft Azure Azure OpenAI API version 2023-10-01-preview…
version: 1.0.0
extends: openapi/microsoft-azure-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: 3
- target: $.paths['/extensions/on-your-data/ingestion-jobs/{jobId}'].get
update:
x-apievangelist-phrasing:
intent: Check the status of an ingestion job
effect: read
questions:
- Has my Azure OpenAI On Your Data ingestion job finished yet?
- Can I look up the progress of one ingestion job by its ID?
instructions:
- text: Get the status of ingestion job {job}.
slots:
job: path.jobId
- text: Show progress and errors for On Your Data ingestion job {job}.
slots:
job: path.jobId
method: generated
generated: '2026-09-26'
- target: $.paths['/extensions/on-your-data/ingestion-jobs/{jobId}'].put
update:
x-apievangelist-phrasing:
intent: Start a data ingestion job into a search index
effect: write
questions:
- How do I ingest my blob storage data into an Azure Search index for use with completions?
- Which storage and search service details does an ingestion job need?
- Can I set how often the ingested data refreshes?
instructions:
- text: Start ingestion job {job} from container {container} using connection string {conn} into search service {search}, refreshing every {minutes} minutes.
slots:
job: path.jobId
container: header.storageContainer
conn: header.storageConnectionString
search: header.searchServiceEndpoint
minutes: requestBody.dataRefreshIntervalInMinutes
- text: Create ingestion job {job} with chunk size {chunk} and refresh interval {minutes} minutes.
slots:
job: path.jobId
chunk: requestBody.chunkSize
minutes: requestBody.dataRefreshIntervalInMinutes
method: generated
generated: '2026-09-26'
- target: $.paths['/extensions/on-your-data/ingestion-jobs'].get
update:
x-apievangelist-phrasing:
intent: List recent ingestion jobs
effect: read
questions:
- Which On Your Data ingestion jobs ran in the last 48 hours?
- Can I see the status of all my recent ingestion jobs at once?
instructions:
- text: List all ingestion jobs from the past 48 hours.
- text: Show the status of every recent On Your Data ingestion job using API version {version}.
slots:
version: query.api-version
method: generated
generated: '2026-09-26'
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.