# 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 Indexes API version: 1.0.0 extends: openapi/microsoft-azure-indexes-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: 12 - target: $.paths['/indexes'].get update: x-apievangelist-phrasing: intent: List the latest version of each index asset effect: read questions: - How do I see the newest version of every index registered in my AI project? - Can I page through index assets with a top and skip limit? instructions: - text: List the latest version of each index in my project. - text: Show the first {top} indexes at their latest version. slots: top: query.top method: generated generated: '2026-09-26' - target: $.paths['/indexes'].post update: x-apievangelist-phrasing: intent: Create a new search index effect: write questions: - How do I create an Azure AI Search index with my own fields? - Can I set scoring profiles and custom analyzers when I first create a search index? instructions: - text: Create search index {name} with fields {fields}. slots: name: requestBody.name fields: requestBody.fields - text: Create a new index {name} using scoring profile {defaultScoringProfile} by default. slots: name: requestBody.name defaultScoringProfile: requestBody.defaultScoringProfile method: generated generated: '2026-09-26' - target: $.paths['/indexes/{name}'].get update: x-apievangelist-phrasing: intent: Get the latest version of an index asset effect: read questions: - How do I fetch the most recent version of a named index asset? - What is the current version of the index asset called 'product-docs'? instructions: - text: Get the latest version of index asset {name}. slots: name: path.name - text: Show me the newest registered version of {name}. slots: name: path.name method: generated generated: '2026-09-26' - target: $.paths['/indexes/{name}:getNextVersion'].post update: x-apievangelist-phrasing: intent: Get the next version number for an index asset effect: read questions: - What version number should I use next when registering a new version of an index asset? - Can I ask the service for the next available index version before I create one? instructions: - text: Get the next version number for index asset {name}. slots: name: path.name - text: Tell me which version to use next for index {name}. slots: name: path.name method: generated generated: '2026-09-26' - target: $.paths['/indexes/{name}/versions'].get update: x-apievangelist-phrasing: intent: List all versions of an index asset effect: read questions: - How do I see the full version history of an index asset? - Can I list index versions filtered by tags or include archived ones? instructions: - text: List all versions of index asset {name} with view type {viewType}. slots: name: path.name viewType: query.listViewType - text: Show versions of index {name} tagged {tags}, view type {viewType}. slots: name: path.name tags: query.tags viewType: query.listViewType method: generated generated: '2026-09-26' - target: $.paths['/indexes/{name}/versions/{version}'].get update: x-apievangelist-phrasing: intent: Get a specific version of an index asset effect: read questions: - How do I fetch one particular version of an index asset rather than the latest? - Where is the storage URI for version 3 of my index asset? instructions: - text: Get version {version} of index asset {name}. slots: version: path.version name: path.name - text: Show the storage location of index {name} at version {version}. slots: version: path.version name: path.name method: generated generated: '2026-09-26' - target: $.paths['/indexes/{name}/versions/{version}'].put update: x-apievangelist-phrasing: intent: Create or update an index asset version effect: write questions: - How do I register a new version of an index asset pointing at a storage URI? - Can I update the stage or description of an existing index asset version? instructions: - text: Register version {version} of index asset {name} with id {id}, stage {stage} and storage URI {storageUri}. slots: version: path.version name: path.name id: requestBody.id stage: requestBody.stage storageUri: requestBody.storageUri - text: Set the stage of index {name} version {version} to {stage}. slots: version: path.version name: path.name stage: requestBody.stage method: generated generated: '2026-09-26' - target: $.paths['/indexes(\'{indexName}\')'].get update: x-apievangelist-phrasing: intent: Get a search index definition effect: read questions: - How do I retrieve the field schema of an Azure AI Search index? - Which analyzers and scoring profiles does my search index use? instructions: - text: Get the definition of search index {index}. slots: index: path.indexName - text: Show the fields and suggesters configured on search index {index}. slots: index: path.indexName method: generated generated: '2026-09-26' - target: $.paths['/indexes(\'{indexName}\')'].put update: x-apievangelist-phrasing: intent: Create or update a search index definition effect: write questions: - How do I add fields to an existing search index or create it if missing? - Can I update a search index that requires taking it offline briefly? instructions: - text: Create or update search index {index} with fields {fields}, returning {prefer}. slots: index: path.indexName fields: requestBody.fields prefer: header.Prefer - text: Update search index {index} and allow downtime {allowIndexDowntime} so new analyzers apply. slots: index: path.indexName allowIndexDowntime: query.allowIndexDowntime method: generated generated: '2026-09-26' - target: $.paths['/indexes(\'{indexName}\')'].delete update: x-apievangelist-phrasing: intent: Delete a search index and its documents effect: destructive questions: - What happens to my documents when I delete an Azure AI Search index? - Can a deleted search index be recovered? instructions: - text: Delete search index {index} and all its documents. slots: index: path.indexName - text: Permanently remove search index {index} only if its ETag matches {etag}. slots: index: path.indexName etag: header.If-Match method: generated generated: '2026-09-26' - target: $.paths['/indexes(\'{indexName}\')/search.stats'].get update: x-apievangelist-phrasing: intent: Get document count and storage for a search index effect: read questions: - How many documents are in my search index and how much storage does it use? - Where can I see storage usage statistics for a single search index? instructions: - text: Get document count and storage usage for search index {index}. slots: index: path.indexName - text: Show statistics for search index {index}. slots: index: path.indexName method: generated generated: '2026-09-26' - target: $.paths['/indexes(\'{indexName}\')/search.analyze'].post update: x-apievangelist-phrasing: intent: Test how an analyzer tokenizes text effect: read questions: - How can I see how a search analyzer breaks my text into tokens? - Can I test a custom tokenizer on sample text before using it in my index? instructions: - text: Analyze the text {text} in search index {index} using analyzer {analyzer}. slots: text: requestBody.text index: path.indexName analyzer: requestBody.analyzer - text: Show the tokens tokenizer {tokenizer} produces for {text} in index {index}. slots: tokenizer: requestBody.tokenizer text: requestBody.text index: path.indexName method: generated generated: '2026-09-26'