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.
...
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,
"includeHistory": false,
"maxTokens": 7000
}
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
AZURE_GPT_4_TURBO_1106: 7000
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
}
GPT model to be used
languageModel: string
Temperature (chatGPT)
temperature: number
Range: 0-1
Default: 0.5
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
...
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 (1106): AZURE_GPT_4_TURBO_1106:
...
Status
Classification
Last updated
12 Mar 2024