-
Notifications
You must be signed in to change notification settings - Fork 2.1k
/
base.ts
329 lines (293 loc) Β· 9.01 KB
/
base.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
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
import { Serializable, SerializedConstructor } from "../load/serializable.js";
import { StringWithAutocomplete } from "../utils/types/index.js";
export interface StoredMessageData {
content: string;
role: string | undefined;
name: string | undefined;
tool_call_id: string | undefined;
// eslint-disable-next-line @typescript-eslint/no-explicit-any
additional_kwargs?: Record<string, any>;
/** Response metadata. For example: response headers, logprobs, token counts. */
// eslint-disable-next-line @typescript-eslint/no-explicit-any
response_metadata?: Record<string, any>;
}
export interface StoredMessage {
type: string;
data: StoredMessageData;
}
export interface StoredGeneration {
text: string;
message?: StoredMessage;
}
export interface StoredMessageV1 {
type: string;
role: string | undefined;
text: string;
}
export type MessageType =
| "human"
| "ai"
| "generic"
| "system"
| "function"
| "tool";
export type ImageDetail = "auto" | "low" | "high";
export type MessageContentText = {
type: "text";
text: string;
};
export type MessageContentImageUrl = {
type: "image_url";
image_url: string | { url: string; detail?: ImageDetail };
};
export type MessageContentComplex =
| MessageContentText
| MessageContentImageUrl
// eslint-disable-next-line @typescript-eslint/no-explicit-any
| (Record<string, any> & { type?: "text" | "image_url" | string })
// eslint-disable-next-line @typescript-eslint/no-explicit-any
| (Record<string, any> & { type?: never });
export type MessageContent = string | MessageContentComplex[];
export interface FunctionCall {
/**
* The arguments to call the function with, as generated by the model in JSON
* format. Note that the model does not always generate valid JSON, and may
* hallucinate parameters not defined by your function schema. Validate the
* arguments in your code before calling your function.
*/
arguments: string;
/**
* The name of the function to call.
*/
name: string;
}
/**
* @deprecated
* Import as "OpenAIToolCall" instead
*/
export interface ToolCall {
/**
* The ID of the tool call.
*/
id: string;
/**
* The function that the model called.
*/
function: FunctionCall;
/**
* The type of the tool. Currently, only `function` is supported.
*/
type: "function";
}
export type BaseMessageFields = {
content: MessageContent;
name?: string;
additional_kwargs?: {
function_call?: FunctionCall;
tool_calls?: ToolCall[];
[key: string]: unknown;
};
/** Response metadata. For example: response headers, logprobs, token counts. */
// eslint-disable-next-line @typescript-eslint/no-explicit-any
response_metadata?: Record<string, any>;
};
export function mergeContent(
firstContent: MessageContent,
secondContent: MessageContent
): MessageContent {
// If first content is a string
if (typeof firstContent === "string") {
if (typeof secondContent === "string") {
return firstContent + secondContent;
} else {
return [{ type: "text", text: firstContent }, ...secondContent];
}
// If both are arrays
} else if (Array.isArray(secondContent)) {
return [...firstContent, ...secondContent];
// If the first content is a list and second is a string
} else {
// Otherwise, add the second content as a new element of the list
return [...firstContent, { type: "text", text: secondContent }];
}
}
/**
* Base class for all types of messages in a conversation. It includes
* properties like `content`, `name`, and `additional_kwargs`. It also
* includes methods like `toDict()` and `_getType()`.
*/
export abstract class BaseMessage
extends Serializable
implements BaseMessageFields
{
lc_namespace = ["langchain_core", "messages"];
lc_serializable = true;
get lc_aliases(): Record<string, string> {
// exclude snake case conversion to pascal case
return {
additional_kwargs: "additional_kwargs",
response_metadata: "response_metadata",
};
}
/**
* @deprecated
* Use {@link BaseMessage.content} instead.
*/
get text(): string {
return typeof this.content === "string" ? this.content : "";
}
/** The content of the message. */
content: MessageContent;
/** The name of the message sender in a multi-user chat. */
name?: string;
/** Additional keyword arguments */
additional_kwargs: NonNullable<BaseMessageFields["additional_kwargs"]>;
/** Response metadata. For example: response headers, logprobs, token counts. */
response_metadata: NonNullable<BaseMessageFields["response_metadata"]>;
/** The type of the message. */
abstract _getType(): MessageType;
constructor(
fields: string | BaseMessageFields,
/** @deprecated */
kwargs?: Record<string, unknown>
) {
if (typeof fields === "string") {
// eslint-disable-next-line no-param-reassign
fields = {
content: fields,
additional_kwargs: kwargs,
response_metadata: {},
};
}
// Make sure the default value for additional_kwargs is passed into super() for serialization
if (!fields.additional_kwargs) {
// eslint-disable-next-line no-param-reassign
fields.additional_kwargs = {};
}
if (!fields.response_metadata) {
// eslint-disable-next-line no-param-reassign
fields.response_metadata = {};
}
super(fields);
this.name = fields.name;
this.content = fields.content;
this.additional_kwargs = fields.additional_kwargs;
this.response_metadata = fields.response_metadata;
}
toDict(): StoredMessage {
return {
type: this._getType(),
data: (this.toJSON() as SerializedConstructor)
.kwargs as StoredMessageData,
};
}
}
// TODO: Deprecate when SDK typing is updated
export type OpenAIToolCall = ToolCall & {
index: number;
};
export function isOpenAIToolCallArray(
value?: unknown
): value is OpenAIToolCall[] {
return (
Array.isArray(value) &&
value.every((v) => typeof (v as OpenAIToolCall).index === "number")
);
}
export function _mergeDicts(
// eslint-disable-next-line @typescript-eslint/no-explicit-any
left: Record<string, any>,
// eslint-disable-next-line @typescript-eslint/no-explicit-any
right: Record<string, any>
// eslint-disable-next-line @typescript-eslint/no-explicit-any
): Record<string, any> {
const merged = { ...left };
for (const [key, value] of Object.entries(right)) {
if (merged[key] == null) {
merged[key] = value;
} else if (value == null) {
continue;
} else if (
typeof merged[key] !== typeof value ||
Array.isArray(merged[key]) !== Array.isArray(value)
) {
throw new Error(
`field[${key}] already exists in the message chunk, but with a different type.`
);
} else if (typeof merged[key] === "string") {
merged[key] = (merged[key] as string) + value;
} else if (!Array.isArray(merged[key]) && typeof merged[key] === "object") {
merged[key] = _mergeDicts(merged[key], value);
} else if (Array.isArray(merged[key])) {
merged[key] = _mergeLists(merged[key], value);
} else if (merged[key] === value) {
continue;
} else {
console.warn(
`field[${key}] already exists in this message chunk and value has unsupported type.`
);
}
}
return merged;
}
// eslint-disable-next-line @typescript-eslint/no-explicit-any
export function _mergeLists(left?: any[], right?: any[]) {
if (left === undefined && right === undefined) {
return undefined;
} else if (left === undefined || right === undefined) {
return left || right;
} else {
const merged = [...left];
for (const item of right) {
if (
typeof item === "object" &&
"index" in item &&
typeof item.index === "number"
) {
const toMerge = merged.findIndex(
(leftItem) => leftItem.index === item.index
);
if (toMerge !== -1) {
merged[toMerge] = _mergeDicts(merged[toMerge], item);
} else {
merged.push(item);
}
} else {
merged.push(item);
}
}
return merged;
}
}
/**
* Represents a chunk of a message, which can be concatenated with other
* message chunks. It includes a method `_merge_kwargs_dict()` for merging
* additional keyword arguments from another `BaseMessageChunk` into this
* one. It also overrides the `__add__()` method to support concatenation
* of `BaseMessageChunk` instances.
*/
export abstract class BaseMessageChunk extends BaseMessage {
abstract concat(chunk: BaseMessageChunk): BaseMessageChunk;
}
export type BaseMessageLike =
| BaseMessage
| [
StringWithAutocomplete<
MessageType | "user" | "assistant" | "placeholder"
>,
MessageContent
]
| string;
export function isBaseMessage(
messageLike?: unknown
): messageLike is BaseMessage {
return typeof (messageLike as BaseMessage)?._getType === "function";
}
export function isBaseMessageChunk(
messageLike?: unknown
): messageLike is BaseMessageChunk {
return (
isBaseMessage(messageLike) &&
typeof (messageLike as BaseMessageChunk).concat === "function"
);
}