Generated by API Evangelist
Written by API Evangelist tooling for Qlik Sense's API. It is a proposal applied on top of the contract, not a document Qlik Sense publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Qliksense Search API
version: 1.0.0
extends: openapi/qliksense-search-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: 2
- target: $.paths['/api/v1/assistants/{assistantId}/actions/search'].post
update:
x-apievangelist-phrasing:
intent: Search an assistant's knowledge
effect: read
questions:
- How do I run a semantic search over the content behind one of my assistants?
- What is the most chunks an assistant search can return?
- Can I use hybrid search with reranking instead of plain semantic search?
instructions:
- text: Search assistant {assistantId} for {prompt}.
slots:
assistantId: path.assistantId
prompt: requestBody.prompt
- text: Search assistant {assistantId} for {prompt} in {searchMode} mode, returning {topN} chunks.
slots:
assistantId: path.assistantId
prompt: requestBody.prompt
searchMode: requestBody.searchMode
topN: requestBody.topN
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/knowledgebases/{id}/actions/search'].post
update:
x-apievangelist-phrasing:
intent: Search chunks in a knowledge base
effect: read
questions:
- Can I run a semantic search directly against one knowledge base?
- What is the difference between SIMPLE and FULL knowledge base search?
instructions:
- text: Search knowledge base {id} for {prompt}.
slots:
id: path.id
prompt: requestBody.prompt
- text: Search knowledge base {id} for {prompt} in {searchMode} mode, top {topN} chunks.
slots:
id: path.id
prompt: requestBody.prompt
searchMode: requestBody.searchMode
topN: requestBody.topN
method: generated
generated: '2026-10-01'
Discovery needs no key. Ratings and market analysis are Pro.
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.