API Evangelist conversational phrasing for Query Suggestions API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Query Suggestions API
  version: 1.0.0
extends: openapi/algolia-query-suggestions-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['/{path}'].get
  update:
    x-apievangelist-phrasing:
      intent: Send a custom GET request to Query Suggestions
      effect: read
      questions:
      - Can I call a Query Suggestions endpoint the client library doesn't wrap yet with a raw GET?
      - Is there a generic way to read from an arbitrary Query Suggestions API path?
      instructions:
      - text: Send a raw GET request to the Query Suggestions API path {path}.
        slots:
          path: path.path
      - text: Call GET on Query Suggestions endpoint {path} with query parameters {parameters}.
        slots:
          path: path.path
          parameters: query.parameters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{path}'].put
  update:
    x-apievangelist-phrasing:
      intent: Send a custom PUT request to Query Suggestions
      effect: write
      questions:
      - How can I send a PUT to a Query Suggestions API path that has no dedicated method?
      - Can I replace something at a custom Query Suggestions endpoint using a raw PUT call?
      instructions:
      - text: Send a raw PUT request to the Query Suggestions API path {path}.
        slots:
          path: path.path
      - text: Issue a PUT to Query Suggestions endpoint {path} with query parameters {parameters}.
        slots:
          path: path.path
          parameters: query.parameters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{path}'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a custom POST request to Query Suggestions
      effect: write
      questions:
      - What's the way to POST to a new Query Suggestions endpoint before the SDK supports it?
      - Can I make a raw POST call to any Query Suggestions path?
      instructions:
      - text: Send a raw POST request to the Query Suggestions API path {path}.
        slots:
          path: path.path
      - text: POST to Query Suggestions endpoint {path} passing query parameters {parameters}.
        slots:
          path: path.path
          parameters: query.parameters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{path}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Send a custom DELETE request to Query Suggestions
      effect: destructive
      questions:
      - How do I send a raw DELETE to a Query Suggestions API path the client doesn't cover?
      - Can I call DELETE on an arbitrary Query Suggestions endpoint?
      instructions:
      - text: Send a raw DELETE request to the Query Suggestions API path {path}.
        slots:
          path: path.path
      - text: Issue a DELETE against Query Suggestions endpoint {path} with query parameters {parameters}.
        slots:
          path: path.path
          parameters: query.parameters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/1/configs'].get
  update:
    x-apievangelist-phrasing:
      intent: List all Query Suggestions configurations
      effect: read
      questions:
      - Which Query Suggestions configurations exist in my Algolia application?
      - How do I see every autocomplete suggestions setup I've created?
      instructions:
      - text: List all my Query Suggestions configurations.
      - text: Show every query suggestions index configured in this application.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/1/configs'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a Query Suggestions configuration
      effect: write
      questions:
      - How do I set up query suggestions built from my product index?
      - How many Query Suggestions configurations can one application have?
      - Can I exclude certain words or enable personalization when generating suggestions?
      instructions:
      - text: Create a Query Suggestions configuration using source indices {sourceIndices}.
        slots:
          sourceIndices: requestBody.sourceIndices
      - text: Set up a new suggestions index {indexName} fed from {sourceIndices}.
        slots:
          indexName: requestBody.indexName
          sourceIndices: requestBody.sourceIndices
      - text: Create query suggestions from {sourceIndices} in languages {languages}, excluding {exclude}.
        slots:
          sourceIndices: requestBody.sourceIndices
          languages: requestBody.languages
          exclude: requestBody.exclude
      method: generated
      generated: '2026-09-26'
- target: $.paths['/1/configs/{indexName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a Query Suggestions configuration
      effect: read
      questions:
      - How can I see the settings behind one of my query suggestions indices?
      - Which source indices does a given suggestions configuration use?
      instructions:
      - text: Get the Query Suggestions configuration for index {indexName}.
        slots:
          indexName: path.indexName
      - text: Show me the source indices and languages configured for suggestions index {indexName}.
        slots:
          indexName: path.indexName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/1/configs/{indexName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a Query Suggestions configuration
      effect: write
      questions:
      - How do I change the source indices of an existing query suggestions configuration?
      - Can I turn on personalization for suggestions I already set up?
      instructions:
      - text: Update suggestions index {indexName} to use source indices {sourceIndices}.
        slots:
          indexName: path.indexName
          sourceIndices: requestBody.sourceIndices
      - text: Change the languages of existing Query Suggestions config {indexName} to {languages}.
        slots:
          indexName: path.indexName
          languages: requestBody.languages
      method: generated
      generated: '2026-09-26'
- target: $.paths['/1/configs/{indexName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Query Suggestions configuration
      effect: destructive
      questions:
      - How do I stop a query suggestions index from being updated?
      - Does deleting a Query Suggestions configuration also delete the suggestions index itself?
      instructions:
      - text: Delete the Query Suggestions configuration for {indexName}.
        slots:
          indexName: path.indexName
      - text: Stop generating suggestions for index {indexName} by removing its configuration.
        slots:
          indexName: path.indexName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/1/configs/{indexName}/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a Query Suggestions index's build status
      effect: read
      questions:
      - Is my query suggestions index currently being built?
      - When was my suggestions index last built successfully?
      instructions:
      - text: Check the build status of suggestions index {indexName}.
        slots:
          indexName: path.indexName
      - text: Tell me whether Query Suggestions index {indexName} is running or finished.
        slots:
          indexName: path.indexName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/1/logs/{indexName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve logs for a Query Suggestions index
      effect: read
      questions:
      - Where can I find the build logs for a query suggestions index?
      - Why did my suggestions index build fail, and what do the logs say?
      instructions:
      - text: Get the logs for Query Suggestions index {indexName}.
        slots:
          indexName: path.indexName
      - text: Show me the latest log entries from building suggestions index {indexName}.
        slots:
          indexName: path.indexName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/setClientApiKey'].get
  update:
    x-apievangelist-phrasing:
      intent: Switch the API key the Query Suggestions client uses
      effect: write
      questions:
      - Can I change which API key my Query Suggestions client authenticates with?
      - Is it possible to rotate the key used for suggestions configuration calls at runtime?
      instructions:
      - text: Switch the Query Suggestions client to authenticate with API key {apiKey}.
        slots:
          apiKey: query.apiKey
      - text: Use {apiKey} as the key for subsequent Query Suggestions requests.
        slots:
          apiKey: query.apiKey
      method: generated
      generated: '2026-09-26'