Assistants

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://your-tenant.us.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.assistants.getAssistants({})

This API is not included yet in qlik-cli

curl "https://your-tenant.us.qlikcloud.com/api/v1/assistants" \
-H "Authorization: Bearer <access_token>"

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://your-tenant.us.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.assistants.createAssistant({
  customProperties: {
    customErrors: {
      outsideScopeError: 'Outside of scope error',
      complexQuestionError:
        'Complex question error',
      promptInjectionError:
        'Prompt injection error',
    },
  },
  defaultPromptType: 'thread',
  description: 'This assistant is used for...',
  knowledgeBases: ['507f191e810c19729de860ea'],
  name: 'Organization-wide assistant',
  orderedStarterIds: [
    '507f191e810c19729de860ea',

    '787f191e810c19729de860er',
  ],
  spaceId: '507f191e810c19729de860ea',
  systemMessage:
    'You are helpful Sales assistant. Provide concise and actionable insights.',
  tags: ['Red', 'Sales'],
  title: 'Assistant for Sales activities',
  welcomeMessage:
    'Welcome to Sales process support Assistant.',
})

This API is not included yet in qlik-cli

curl "https://your-tenant.us.qlikcloud.com/api/v1/assistants" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"name":"Organization-wide assistant","tags":["Red","Sales"],"title":"Assistant for Sales activities","spaceId":"507f191e810c19729de860ea","description":"This assistant is used for...","systemMessage":"You are helpful Sales assistant. Provide concise and actionable insights.","knowledgeBases":["507f191e810c19729de860ea"],"welcomeMessage":"Welcome to Sales process support Assistant.","customProperties":{"customErrors":{"outsideScopeError":"Outside of scope error","complexQuestionError":"Complex question error","promptInjectionError":"Prompt injection error"}},"defaultPromptType":"thread","orderedStarterIds":["507f191e810c19729de860ea","787f191e810c19729de860er"]}'

// qlik-api has not implemented support for `POST /api/v1/assistants/{assistantId}/actions/search` yet.
// In the meantime, you can use fetch like this:

const response = await fetch(
  '/api/v1/assistants/{assistantId}/actions/search',
  {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      topN: 20,
      prompt: 'What is LLM?',
      searchMode: 'SIMPLE',
    }),
  },
)

This API is not included yet in qlik-cli

curl "https://your-tenant.us.qlikcloud.com/api/v1/assistants/{assistantId}/actions/search" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"topN":20,"prompt":"What is LLM?","searchMode":"SIMPLE"}'

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://your-tenant.us.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.assistants.getAssistantFeedback(
  '507f191e810c19729de860ea',
)

This API is not included yet in qlik-cli

curl "https://your-tenant.us.qlikcloud.com/api/v1/assistants/{assistantId}/feedback" \
-H "Authorization: Bearer <access_token>"

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://your-tenant.us.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.assistants.getAssistantSources(
  '507f191e810c19729de860ea',
  {
    chunkIds: [
      'c2ef42d9-7164-4fb0-bdbb-6534ae37263e',

      '486ada2c-f895-4961-8ba5-7995f1026d26',
    ],
  },
)

This API is not included yet in qlik-cli

curl "https://your-tenant.us.qlikcloud.com/api/v1/assistants/{assistantId}/sources/plaintexts" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"chunkIds":["c2ef42d9-7164-4fb0-bdbb-6534ae37263e","486ada2c-f895-4961-8ba5-7995f1026d26"]}'

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://your-tenant.us.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.assistants.getAssistantStarters(
  '507f191e810c19729de860ea',
  {},
)

This API is not included yet in qlik-cli

curl "https://your-tenant.us.qlikcloud.com/api/v1/assistants/{assistantId}/starters" \
-H "Authorization: Bearer <access_token>"

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://your-tenant.us.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.assistants.createAssistantStarter(
  '507f191e810c19729de860ea',
  {
    additionalContext: 'string',
    followups: [
      {
        additionalContext: 'string',
        id: '507f191e810c19729de860ea',
        question:
          'Where was Genghis Khan buried?',
        recommendedAnswer: {
          content: 'string',
          contentType: 'text | markdown | html',
        },
      },
    ],
    question: 'Where was Genghis Khan buried?',
    recommendedAnswer: {
      content: 'string',
      contentType: 'text | markdown | html',
    },
  },
)

This API is not included yet in qlik-cli

curl "https://your-tenant.us.qlikcloud.com/api/v1/assistants/{assistantId}/starters" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"question":"Where was Genghis Khan buried?","followups":[{"id":"507f191e810c19729de860ea","question":"Where was Genghis Khan buried?","additionalContext":"string","recommendedAnswer":{"content":"string","contentType":"text | markdown | html"}}],"additionalContext":"string","recommendedAnswer":{"content":"string","contentType":"text | markdown | html"}}'

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://your-tenant.us.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.assistants.getAssistantStarter(
  '507f191e810c19729de860ea',
  '507f191e810c19729de860ea',
)

This API is not included yet in qlik-cli

curl "https://your-tenant.us.qlikcloud.com/api/v1/assistants/{assistantId}/starters/{starterId}" \
-H "Authorization: Bearer <access_token>"

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://your-tenant.us.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.assistants.updateAssistantStarter(
  '507f191e810c19729de860ea',
  '507f191e810c19729de860ea',
  {
    additionalContext: 'string',
    followups: [
      {
        additionalContext: 'string',
        id: '507f191e810c19729de860ea',
        question:
          'Where was Genghis Khan buried?',
        recommendedAnswer: {
          content: 'string',
          contentType: 'text | markdown | html',
        },
      },
    ],
    id: '507f191e810c19729de860ea',
    question: 'Where was Genghis Khan buried?',
    recommendedAnswer: {
      content: 'string',
      contentType: 'text | markdown | html',
    },
  },
)