-
-
Notifications
You must be signed in to change notification settings - Fork 86
/
types.ts
200 lines (175 loc) · 6.31 KB
/
types.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
import {GbnfJsonSchema, GbnfJsonSchemaToType} from "./utils/gbnfJson/types.js";
import {LlamaText, BuiltinSpecialTokenValue, LlamaTextJSON} from "./utils/LlamaText.js";
import type {GgufFileInfo} from "./gguf/types/GgufFileInfoTypes.js";
export type Token = number & {
__token: never
};
export type Detokenizer = {
detokenize(tokens: readonly Token[], specialTokens?: boolean, lastTokens?: readonly Token[]): string
}["detokenize"];
export type Tokenizer = {
tokenize(text: string, specialTokens?: boolean, options?: "trimLeadingSpace"): Token[],
tokenize(text: BuiltinSpecialTokenValue, specialTokens: "builtin"): Token[]
}["tokenize"] & {
readonly detokenize: Detokenizer,
isSpecialToken(token: Token): boolean,
isEogToken(token: Token): boolean
};
export type ChatWrapperSettings = {
readonly supportsSystemMessages: boolean,
readonly functions: {
readonly call: {
readonly optionalPrefixSpace: boolean,
readonly prefix: string | LlamaText,
readonly paramsPrefix: string | LlamaText,
readonly suffix: string | LlamaText
},
readonly result: {
/**
* Supported template parameters:
* - <span v-pre>`{{functionName}}`</span>
* - <span v-pre>`{{functionParams}}`</span>
*
* Template parameters can only appear in a string or a string in a `LlamaText`.
*
* Template parameters inside a `SpecialTokensText` inside a `LlamaText` won't be replaced.
*
* Example of supported values:
* - `"text{{functionName}}text"`
* - `LlamaText(["text{{functionName}}text"])`
*
* Example of unsupported values:
* - `LlamaText([new SpecialTokensText("text{{functionName}}text")])`
*/
readonly prefix: string | LlamaText,
/**
* Supported template parameters:
* - <span v-pre>`{{functionName}}`</span>
* - <span v-pre>`{{functionParams}}`</span>
*
* Template parameters can only appear in a string or a string in a `LlamaText`.
*
* Template parameters inside a `SpecialTokensText` inside a `LlamaText` won't be replaced.
*
* Example of **supported** values:
* - `"text{{functionName}}text"`
* - `LlamaText(["text{{functionName}}text"])`
*
* Example of **unsupported** values:
* - `LlamaText([new SpecialTokensText("text{{functionName}}text")])`
*/
readonly suffix: string | LlamaText
},
/** If this field is present, parallel function calling is supported */
readonly parallelism?: {
readonly call: {
readonly sectionPrefix: string | LlamaText,
readonly betweenCalls?: string | LlamaText,
readonly sectionSuffix?: string | LlamaText
},
readonly result?: {
readonly sectionPrefix?: string | LlamaText,
readonly betweenResults?: string | LlamaText,
readonly sectionSuffix?: string | LlamaText
}
}
}
};
export type ChatWrapperGenerateContextStateOptions = {
chatHistory: readonly ChatHistoryItem[],
availableFunctions?: ChatModelFunctions,
documentFunctionParams?: boolean
};
export type ChatWrapperCheckModelCompatibilityParams = {
tokenizer?: Tokenizer,
fileInfo?: GgufFileInfo
};
export type ChatWrapperGeneratedContextState = {
contextText: LlamaText,
stopGenerationTriggers: LlamaText[],
ignoreStartText?: LlamaText[],
functionCall?: {
initiallyEngaged: boolean,
disengageInitiallyEngaged: LlamaText[]
}
};
export type ChatWrapperGenerateInitialHistoryOptions = {
systemPrompt?: string
};
export type ChatHistoryItem = ChatSystemMessage | ChatUserMessage | ChatModelResponse;
export type ChatSystemMessage = {
type: "system",
text: string | LlamaTextJSON
};
export type ChatUserMessage = {
type: "user",
text: string
};
export type ChatModelResponse = {
type: "model",
response: (string | ChatModelFunctionCall)[]
};
export type ChatModelFunctionCall = {
type: "functionCall",
name: string,
description?: string,
params: any,
result: any,
rawCall?: LlamaTextJSON,
/**
* Whether this function call starts a new function calling chunk.
*
* Relevant only when parallel function calling is supported.
*/
startsNewChunk?: boolean
};
export type ChatModelFunctions = {
readonly [name: string]: {
readonly description?: string,
readonly params?: GbnfJsonSchema | undefined | null
}
};
export type ChatSessionModelFunctions = {
readonly [name: string]: ChatSessionModelFunction<any>
};
export type ChatSessionModelFunction<Params extends GbnfJsonSchema | undefined = GbnfJsonSchema | undefined> = {
readonly description?: string,
readonly params?: Params,
readonly handler: (params: GbnfJsonSchemaToType<Params>) => any
};
export function isChatModelResponseFunctionCall(item: ChatModelResponse["response"][number]): item is ChatModelFunctionCall {
if (typeof item === "string")
return false;
return item.type === "functionCall";
}
export type LLamaContextualRepeatPenalty = {
/**
* Number of recent tokens generated by the model to apply penalties to repetition of.
* Defaults to `64`.
*/
lastTokens?: number,
punishTokensFilter?: (tokens: Token[]) => Token[],
/**
* Penalize new line tokens.
* Enabled by default.
*/
penalizeNewLine?: boolean,
/**
* The relative amount to lower the probability of the tokens in `punishTokens` by
* Defaults to `1.1`.
* Set to `1` to disable.
*/
penalty?: number,
/**
* For n time a token is in the `punishTokens` array, lower its probability by `n * frequencyPenalty`
* Disabled by default (`0`).
* Set to a value between `0` and `1` to enable.
*/
frequencyPenalty?: number,
/**
* Lower the probability of all the tokens in the `punishTokens` array by `presencePenalty`
* Disabled by default (`0`).
* Set to a value between `0` and `1` to enable.
*/
presencePenalty?: number
};