An assistant and modules are created and modified via API call. This guide leads you through the calls you have to do and the settings and configurations that can be set.

Token of a user / service-user which has an admin role assigned → <yourToken>
The base URL of your application → <baseUrl>!

Panel

panelIconId	2139
panelIcon	:information_source:
panelIconText	ℹ️
bgColor	#E6FCFF

To get the token and the URL check this: How to get a Token for our APIs

Assistant

Create a new assistant

...

<baseUrl> / <yourToken>
<assistantId>
<updateAssistant> "param1": "<paramValue>" → contains variables that should be updated. Variables that are not contained in <updateAssistant> input remain unchanged

Code Block

curl --location --globoff 'https://gateway.<baseUrl>/chat/graphql' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <yourToken>' \
--data '{"query":"mutation UpdateAssistant($updateAssistantId: String!, $input: AssistantUpdateInput!) {\n  updateAssistant(id: $updateAssistantId, input: $input) {\n    name\n    id\n    languageModel\n    settings\n    chatUpload\n    modules {\n      id\n      name\n      configuration\n    }\n  }\n}","variables":{"updateAssistantId":"<assistantId>","input":{<updateAssistant>,"input":{"param1": "<paramValue>"}}}'

An example command to update the languageModelused to perform function calling and module selection can be updated with the following curl command:

Code Block

curl --location 'https://gateway.<baseUrl>/chat/graphql' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <yourToken>' \
--data '{"query":"mutation UpdateAssistant($updateAssistantId: String!, $input: AssistantUpdateInput!) {\n      updateAssistant(id: $updateAssistantId, input: $input) {\n            name\n            id    \n            languageModel    \n            settings    \n            chatUpload    \n            modules {\n                id\n                name\n                configuration   \n            }\n       }\n}","variables":{"updateAssistantId":"<assistantID>","input":{"languageModel":"AZURE_GPT_4_0613"}}}'

Delete an assistant

To delete an assistant, use the following cURL. Update these placeholders:

...

Code Block

{
  "input": {
    "name": "Internal Knowledge",
    "fallbackModule": "SearchInVectorDB",
    "languageModel": "AZURE_GPT_35_TURBO_0613",
    "chatUpload": "Disabled",
    "settings": {
        "showPdfHighlighting": true,
        "modelChoosing": "BY_FUNCTION_CALL",
        "isPinned": true        
    },
    "modules": {
      "create": [
        {
            "name": "SearchInVectorDB",
            "configuration": {
            },
            "description": null,
            "isExternal": false,
            "weight": 10000
        },
        {
            "name": "Translate",
            "configuration": {
            },
            "description": null,
            "isExternal": false,
            "weight": 6000
        }
      ]
    }
  }
}

Panel

panelIconId	2139
panelIcon	:information_source:
panelIconText	ℹ️
bgColor	#E6FCFF

You can find more about assistants here: Assistants

Module

Create a module

This can be done with this cURL. Just replace the following placeholders:

...

Module

Example

Description

Parameter

Options

SearchInVectorDB

Code Block

"configuration": {
        "languageModel": "AZURE_GPT_4_TURBO_1106",
        "scopeIds": ["scope_1", "scope_2"],
        "searchType": "COMBINED",
        "chunkedSources": true, 
        "scopeToChatOnUpload": true,
        "historyIncluded": false,
        "maxTokens": 7000,
        "ftsSearchLanguage": "english"
}

GPT model to be used

languageModel: string

see below section with GPT-models

default: AZURE_GPT_35_TURBO: GPT-35-turbo (0301)

Scopes that the module can access

scopeIds: object

RAG approach to search for chunks

searchType: string

VECTOR: semantic search (similarity of input and chunk embeddings)

COMBINED: hybrid search combining vector and fulltext search

Describing if chunks of same document are appended as individual sources to GPT content or merged to one source

chunkedSources: boolean

true: each chunk is a separate source

false: chunks from the same document are merged to one source

Scope restriction to documents that are uploaded. If no documents are uploaded, then scopes in scopeIds are relevant.

scopeToChatUpload: boolean

true: Scope restriction on (if document uploaded)

false: Scope restriction off

Flag that allows to include previous chat conversation in GPT-calls only if the new user input is a follow-up question

historyIncluded: boolean

true: History always included

false: History only included for follow-up questions

Max tokens used by sources and previous conversation

maxTokens: integer

Default value depends on the used languageModel

AZURE_GPT_35_TURBO: 3000

AZURE_GPT_35_TURBO_0613: 3000

AZURE_GPT_35_TURBO_16K: 14000

AZURE_GPT_4_0613: 7000

AZURE_GPT_4_32K_0613: 30000

AZURE_GPT_4_VISION_PREVIEW: 7000: 7000

AZURE_GPT_4_TURBO_1106: 126000

AZURE_GPT_4_TURBO_2024_0409: 126000

AZURE_GPT_4o_2024_0513: 126000

AZURE_GPT_44o_TURBO2024_11060806: 7000126000

AZURE_GPT_44o_TURBOMINI_2024_04090718: 7000126000

Specifies the primary language used for full-text search. This should match the predominant language of the documents in the knowledge centre.

ftsSearchLanguage: string

Default: english

ContextMemorySearch

Code Block
"configuration": { "languageModel": "AZURE_GPT_4_TURBO_1106", "chunkedSources": true }

GPT model to be used

languageModel: string

Describing if chunks of same document are appended as individual sources to GPT content or merged to one source

chunkedSources: boolean

true: each chunk is a separate source

false: chunks from the same document are merged to one source

DocumentSummarizer

Code Block
"configuration": { "languageModel": "AZURE_GPT_4_TURBO_1106" }

GPT model to be used

languageModel: string

EmailWriter

Code Block
"configuration": { "languageModel": "AZURE_GPT_4_TURBO_1106" }

GPT model to be used

languageModel: string

ExternalKnowledge

Code Block
"configuration": { "languageModel": "AZURE_GPT_4_TURBO_1106", "temperature": 0.5, "systemPromptExternalKnowledge": "Example system prompt", "maxHistoryInteraction": 2 }

GPT model to be used

languageModel: string

Temperature (chatGPT)

temperature: number

Range: 0-1

Default: 0.5

System prompt

systemPromptExternalKnowledge: string

Default system prompt is (depending of languageModel):

Code Block
You are ChatGPT, a large language model trained by OpenAI, based on the GPT-4 architecture.\nKnowledge cutoff: 2023-04.\nCurrent date: DAYDATE.

Maximum number of user-assistant interactions taken into account in the history.

maxHistoryInteraction: number

Default: 2

InvestmentResearchDocuments

InvestmentResearchTable

LunchSearchV4

Code Block
"configuration": { "languageModel": "AZURE_GPT_4_TURBO_1106" }

GPT model to be used

languageModel: string

QueryTable

Code Block
"configuration": { "languageModel": "AZURE_GPT_4_TURBO_1106", "tableConfig": TableConfig[], "searchExamples": ChatCompletionRequestMessage[], "showTableReference": boolean }

GPT model to be used

languageModel: string

tbd

tableconfig:

tbd

searchExamples:

tbd

showTableReference: boolean

TranscriptInteraction

Code Block
"configuration": { "languageModel": "AZURE_GPT_4_TURBO_1106", "scopeId": "scope_1", "maxTokens": 7000, "templateName": "template.xlsx" }

GPT model to be used

languageModel: string

Scope that the module can access

scopeId: string

Max tokens used by sources and previous conversation

maxTokens: integer

Name of excel template file, that will be filled with extracted values. Need to uploaded to the same scopeId

templateName: string

Translate

Code Block
"configuration": { "languageModel": "AZURE_GPT_4_TURBO_1106" }

GPT model to be used

languageModel: string

WhatsappWriter

Code Block
"configuration": { "languageModel": "AZURE_GPT_4_TURBO_1106" }

GPT model to be used

languageModel: string

...

Model	Key
GPT-35-turbo (0301)	AZURE_GPT_35_TURBO
GPT-35-turbo (0613)	AZURE_GPT_35_TURBO_0613
GPT-35-turbo-16K (0613)	AZURE_GPT_35_TURBO_16K
GPT-4 (0613)	AZURE_GPT_4_0613
GPT-4-32K (0613)	AZURE_GPT_4_32K_0613
GPT-4-turbo (0409)	AZURE_GPT_4_TURBO_2024_0409
GPT-4o (2024-05-130513)	AZURE_GPT_4o_2024_0513
GPT-4o (2024-0806)	AZURE_GPT_4o_2024_05130806
GPT-4o-mini (2024-07-180718)	AZURE_GPT_4o_miniMINI_2024_0718

GPT versions available in Preview mode (not recommended to be used in productive applications):

Model	Key
GPT-4-turbo (1106)	AZURE_GPT_4_TURBO_1106

Panel

panelIconId	2139
panelIcon	:information_source:
panelIconText	ℹ️
bgColor	#E6FCFF

You can find more about modules here: Modules

...

Author	Fabian Schläpfer

Versions Compared

Old Version 14

New Version Current

Key

Assistant

Create a new assistant

Delete an assistant

Module

Create a module

Page Comparison

Versions Compared

Old Version 14

New Version Current

Key

Assistant

Create a new assistant

Delete an assistant

Module

Create a module