Generated by API Evangelist
Written by API Evangelist tooling for Microsoft Purview's API. It is a proposal applied on top of the contract, not a document Microsoft Purview 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 Purview Discovery API
version: 1.0.0
extends: openapi/microsoft-purview-discovery-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: 3
- target: $.paths['/api/search/query'].post
update:
x-apievangelist-phrasing:
intent: Search the data catalog for assets
effect: read
questions:
- How do I find data assets in Purview by keyword?
- Can I filter catalog search results and get facet counts?
instructions:
- text: Search the catalog for assets matching {keywords}.
slots:
keywords: requestBody.keywords
- text: Find assets for {keywords} filtered by {filter}, returning {limit} results.
slots:
keywords: requestBody.keywords
filter: requestBody.filter
limit: requestBody.limit
method: generated
generated: '2026-10-01'
- target: $.paths['/api/search/suggest'].post
update:
x-apievangelist-phrasing:
intent: Get search suggestions for a query
effect: read
questions:
- Can Purview suggest matching assets while I type a search?
- What suggested results come back for a partial keyword?
instructions:
- text: Suggest catalog assets for {keywords}.
slots:
keywords: requestBody.keywords
- text: Give me {limit} search suggestions for {keywords}.
slots:
limit: requestBody.limit
keywords: requestBody.keywords
method: generated
generated: '2026-10-01'
- target: $.paths['/api/search/autocomplete'].post
update:
x-apievangelist-phrasing:
intent: Autocomplete a search term
effect: read
questions:
- How do I get autocomplete options for a search box over the catalog?
- Which term completions exist for a few typed letters?
instructions:
- text: Autocomplete the search term {keywords}.
slots:
keywords: requestBody.keywords
- text: Return {limit} autocomplete options for {keywords}.
slots:
limit: requestBody.limit
keywords: requestBody.keywords
method: generated
generated: '2026-10-01'
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.