API Evangelist conversational phrasing for Knowledgebases API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Knowledgebases API
  version: 1.0.0
extends: openapi/qliksense-knowledge-bases-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: 17
- target: $.paths['/api/v1/knowledgebases'].get
  update:
    x-apievangelist-phrasing:
      intent: List knowledge bases
      effect: read
      questions:
      - Which knowledge bases do I have access to?
      - Can I page through and sort my knowledge bases?
      instructions:
      - text: List my knowledge bases.
      - text: List {limit} knowledge bases sorted by {sort}.
        slots:
          limit: query.limit
          sort: query.sort
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/knowledgebases'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a knowledge base
      effect: write
      questions:
      - Can I create a new knowledge base to feed an assistant?
      - Does a knowledge base have to live in a space?
      instructions:
      - text: Create knowledge base {name} in space {spaceId}.
        slots:
          name: requestBody.name
          spaceId: requestBody.spaceId
      - text: Create knowledge base {name} in space {spaceId} with advanced indexing {advancedIndexing}.
        slots:
          name: requestBody.name
          spaceId: requestBody.spaceId
          advancedIndexing: requestBody.advancedIndexing
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/knowledgebases/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a knowledge base
      effect: read
      questions:
      - Can I view the details and datasources of one knowledge base?
      - Where do I look up a single knowledge base by ID?
      instructions:
      - text: Show knowledge base {id}.
        slots:
          id: path.id
      - text: Get the details of knowledge base {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/knowledgebases/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a knowledge base
      effect: destructive
      questions:
      - Can I delete a whole knowledge base?
      - Are all datasources removed when a knowledge base is deleted?
      instructions:
      - text: Delete knowledge base {id}.
        slots:
          id: path.id
      - text: Remove knowledge base {id} and all of its resources.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/knowledgebases/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a knowledge base
      effect: write
      questions:
      - Can I rename a knowledge base or change its description?
      - Is a partial update of knowledge base properties supported?
      instructions:
      - text: Update knowledge base {id}.
        slots:
          id: path.id
      - text: Patch the properties of knowledge base {id} if it matches {ifMatch}.
        slots:
          id: path.id
          ifMatch: header.if-match
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/knowledgebases/{id}/datasources'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a datasource to a knowledge base
      effect: write
      questions:
      - Can I add a folder of documents as a source for a knowledge base?
      - What types of datasource can a knowledge base pull from?
      instructions:
      - text: Add datasource {name} of type {type} to knowledge base {id}.
        slots:
          name: requestBody.name
          type: requestBody.type
          id: path.id
      - text: Attach a new {type} source named {name} to knowledge base {id}.
        slots:
          type: requestBody.type
          name: requestBody.name
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/knowledgebases/{id}/datasources/{datasourceId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a knowledge base datasource
      effect: write
      questions:
      - Can I change the chunking or file settings of an existing knowledge base source?
      - Which fields are required when replacing a knowledge base datasource?
      instructions:
      - text: Update datasource {datasourceId} in knowledge base {id}.
        slots:
          datasourceId: path.datasourceId
          id: path.id
      - text: Change chunking of source {datasourceId} in knowledge base {id} to {chunking}.
        slots:
          datasourceId: path.datasourceId
          id: path.id
          chunking: requestBody.chunking
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/knowledgebases/{id}/datasources/{datasourceId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a datasource from a knowledge base
      effect: destructive
      questions:
      - Can I remove one source from a knowledge base without deleting the whole thing?
      - What happens to indexed content when a datasource is deleted?
      instructions:
      - text: Delete datasource {datasourceId} from knowledge base {id}.
        slots:
          datasourceId: path.datasourceId
          id: path.id
      - text: Remove source {datasourceId} and its resources from knowledge base {id}.
        slots:
          datasourceId: path.datasourceId
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/knowledgebases/{id}/datasources/{datasourceId}/actions/cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel a datasource sync
      effect: destructive
      questions:
      - Can I stop a knowledge base datasource sync that is still running?
      - Is there a way to abort an in-progress source sync?
      instructions:
      - text: Cancel the sync of datasource {datasourceId} in knowledge base {id}.
        slots:
          datasourceId: path.datasourceId
          id: path.id
      - text: Abort the running sync for source {datasourceId} of knowledge base {id}.
        slots:
          datasourceId: path.datasourceId
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/knowledgebases/{id}/datasources/{datasourceId}/actions/download'].post
  update:
    x-apievangelist-phrasing:
      intent: Download a datasource reference document
      effect: read
      questions:
      - Can I download the original document a knowledge base source references?
      - Which path do I give to download a referenced file?
      instructions:
      - text: Download reference {path} from datasource {datasourceId} in knowledge base {id}.
        slots:
          path: requestBody.path
          datasourceId: path.datasourceId
          id: path.id
      - text: Get the source file at {path} behind datasource {datasourceId} of knowledge base {id}.
        slots:
          path: requestBody.path
          datasourceId: path.datasourceId
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/knowledgebases/{id}/datasources/{datasourceId}/actions/sync'].post
  update:
    x-apievangelist-phrasing:
      intent: Sync a datasource into a knowledge base
      effect: write
      questions:
      - Can I trigger a fresh sync of one knowledge base source?
      - Is there an option to migrate the index while syncing a source?
      instructions:
      - text: Sync datasource {datasourceId} into knowledge base {id}.
        slots:
          datasourceId: path.datasourceId
          id: path.id
      - text: Start a sync of source {datasourceId} in knowledge base {id} with migrate {migrate}.
        slots:
          datasourceId: path.datasourceId
          id: path.id
          migrate: query.migrate
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/knowledgebases/{id}/datasources/{datasourceId}/histories'].get
  update:
    x-apievangelist-phrasing:
      intent: List sync history of a datasource
      effect: read
      questions:
      - When was one knowledge base source last synced, and did those syncs succeed?
      - Why would a datasource sync history request return a 404?
      instructions:
      - text: List sync history for datasource {datasourceId} in knowledge base {id}.
        slots:
          datasourceId: path.datasourceId
          id: path.id
      - text: Show the last {limit} syncs of source {datasourceId} in knowledge base {id}.
        slots:
          limit: query.limit
          datasourceId: path.datasourceId
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/knowledgebases/{id}/datasources/{datasourceId}/histories/{syncId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get details of one datasource sync
      effect: read
      questions:
      - Can I see the detailed result of one specific datasource sync run?
      - What went wrong in one particular knowledge base sync?
      instructions:
      - text: Get sync {syncId} of datasource {datasourceId} in knowledge base {id}.
        slots:
          syncId: path.syncId
          datasourceId: path.datasourceId
          id: path.id
      - text: Show the detailed outcome of sync run {syncId} for source {datasourceId} in knowledge base {id}.
        slots:
          syncId: path.syncId
          datasourceId: path.datasourceId
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/knowledgebases/{id}/datasources/{datasourceId}/schedules'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a datasource sync schedule
      effect: read
      questions:
      - Is a knowledge base source set to sync automatically on a schedule?
      - What calendar or interval does a datasource schedule use?
      instructions:
      - text: Show the sync schedule of datasource {datasourceId} in knowledge base {id}.
        slots:
          datasourceId: path.datasourceId
          id: path.id
      - text: Check when source {datasourceId} of knowledge base {id} is scheduled to sync.
        slots:
          datasourceId: path.datasourceId
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/knowledgebases/{id}/datasources/{datasourceId}/schedules'].post
  update:
    x-apievangelist-phrasing:
      intent: Schedule a datasource sync
      effect: write
      questions:
      - Can I make a knowledge base source resync automatically?
      - Can a source sync schedule use calendars or fixed intervals?
      instructions:
      - text: Schedule datasource {datasourceId} in knowledge base {id} to sync every {intervals}.
        slots:
          datasourceId: path.datasourceId
          id: path.id
          intervals: requestBody.intervals
      - text: Set a calendar schedule {calendars} for source {datasourceId} of knowledge base {id}.
        slots:
          calendars: requestBody.calendars
          datasourceId: path.datasourceId
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/knowledgebases/{id}/datasources/{datasourceId}/schedules'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a datasource sync schedule
      effect: destructive
      questions:
      - Can I stop a knowledge base source from syncing on a schedule?
      - Does deleting a schedule remove the datasource itself?
      instructions:
      - text: Delete the sync schedule of datasource {datasourceId} in knowledge base {id}.
        slots:
          datasourceId: path.datasourceId
          id: path.id
      - text: Turn off scheduled syncing for source {datasourceId} of knowledge base {id}.
        slots:
          datasourceId: path.datasourceId
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/knowledgebases/{id}/histories'].get
  update:
    x-apievangelist-phrasing:
      intent: Get sync history of a whole knowledge base
      effect: read
      questions:
      - When was a knowledge base last synced across all its sources?
      - Can I page through every sync recorded for a knowledge base?
      instructions:
      - text: Show the sync history for knowledge base {id}.
        slots:
          id: path.id
      - text: List {limit} sync runs across all sources of knowledge base {id}.
        slots:
          limit: query.limit
          id: path.id
      method: generated
      generated: '2026-10-01'