# 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 SearchIndexClient Documents API
  version: 1.0.0
extends: openapi/microsoft-azure-documents-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: 9
- target: $.paths['/docs/$count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count documents in a search index
      effect: read
      questions:
      - How many documents are in my Azure Search index right now?
      - Is there a quick way to get just the document total for an index?
      instructions:
      - text: Count the documents in this search index using API version {api_version}.
        slots:
          api_version: query.api-version
      - text: Tell me the total number of documents in the index.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/docs'].get
  update:
    x-apievangelist-phrasing:
      intent: Search documents in an index with a GET query
      effect: read
      questions:
      - How do I run a full-text search over my Azure Search index from a URL?
      - Can I get facets and highlighted matches back in the query-string version of search?
      instructions:
      - text: Search the index via GET for {search}.
        slots:
          search: query.search
      - text: Search the index via query string for {search} filtered by {filter}, top {top} results.
        slots:
          search: query.search
          filter: query.$filter
          top: query.$top
      - text: Run a GET search for {search} ordered by {orderby}.
        slots:
          search: query.search
          orderby: query.$orderby
      method: generated
      generated: '2026-09-26'
- target: $.paths['/docs/search.post.search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search documents in an index with a POST body
      effect: read
      questions:
      - Can I send a long or complex search query in a request body instead of the URL?
      - Which search options can I pass in the JSON body of a POST search?
      instructions:
      - text: POST a search request for {search} to the index.
        slots:
          search: requestBody.search
      - text: Send a body search for {search} with filter {filter} and scoring profile {scoringProfile}.
        slots:
          search: requestBody.search
          filter: requestBody.filter
          scoringProfile: requestBody.scoringProfile
      method: generated
      generated: '2026-09-26'
- target: $.paths['/docs(\'{key}\')'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a document by its key
      effect: read
      questions:
      - How do I fetch a single document from the search index by its key?
      - Can I return only certain fields when retrieving one indexed document?
      instructions:
      - text: Get the indexed document with key {key}.
        slots:
          key: path.key
      - text: Fetch document {key} returning only fields {select}.
        slots:
          key: path.key
          select: query.$select
      method: generated
      generated: '2026-09-26'
- target: $.paths['/docs/search.suggest'].get
  update:
    x-apievangelist-phrasing:
      intent: Suggest matching documents with a GET query
      effect: read
      questions:
      - How do I build search-as-you-type document suggestions from a URL query?
      - Can suggestions tolerate typos in what the user typed so far?
      instructions:
      - text: Suggest documents via GET matching {search} using suggester {suggesterName}.
        slots:
          search: query.search
          suggesterName: query.suggesterName
      - text: Give up to {top} fuzzy document suggestions for {search} from suggester {suggesterName} via query string.
        slots:
          top: query.$top
          search: query.search
          suggesterName: query.suggesterName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/docs/search.post.suggest'].post
  update:
    x-apievangelist-phrasing:
      intent: Suggest matching documents with a POST body
      effect: read
      questions:
      - Can I request document suggestions with the options in a JSON body?
      - Which fields can I filter on when posting a suggestions request?
      instructions:
      - text: POST a suggestions request for {search} with suggester {suggesterName}.
        slots:
          search: requestBody.search
          suggesterName: requestBody.suggesterName
      - text: Send a body suggest call for {search} filtered by {filter}.
        slots:
          search: requestBody.search
          filter: requestBody.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/docs/search.index'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload, merge or delete documents in an index
      effect: write
      questions:
      - How do I add or update a batch of documents in my Azure Search index?
      - Can one request mix uploads, merges and deletes of index documents?
      instructions:
      - text: 'Send this batch of document actions to the index: {value}.'
        slots:
          value: requestBody.value
      - text: Upload and merge documents {value} into the search index.
        slots:
          value: requestBody.value
      method: generated
      generated: '2026-09-26'
- target: $.paths['/docs/search.autocomplete'].get
  update:
    x-apievangelist-phrasing:
      intent: Autocomplete query terms with a GET query
      effect: read
      questions:
      - How do I complete a partially typed search term from the index vocabulary using a URL?
      - Can autocomplete suggest the next word as well as finish the current one?
      instructions:
      - text: Autocomplete {search} via GET using suggester {suggesterName}.
        slots:
          search: query.search
          suggesterName: query.suggesterName
      - text: Complete the term {search} with suggester {suggesterName} in mode {autocompleteMode} via query string.
        slots:
          search: query.search
          suggesterName: query.suggesterName
          autocompleteMode: query.autocompleteMode
      method: generated
      generated: '2026-09-26'
- target: $.paths['/docs/search.post.autocomplete'].post
  update:
    x-apievangelist-phrasing:
      intent: Autocomplete query terms with a POST body
      effect: read
      questions:
      - Can I send autocomplete options in a request body rather than the URL?
      - What autocomplete modes can I set in a POST request?
      instructions:
      - text: POST an autocomplete request for {search} with suggester {suggesterName}.
        slots:
          search: requestBody.search
          suggesterName: requestBody.suggesterName
      - text: Send a body autocomplete for {search} in mode {autocompleteMode}, returning {top} terms.
        slots:
          search: requestBody.search
          autocompleteMode: requestBody.autocompleteMode
          top: requestBody.top
      method: generated
      generated: '2026-09-26'