@langchain/core 1.1.42 → 1.1.43
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +10 -0
- package/README.md +1 -1
- package/dist/callbacks/base.cjs +5 -0
- package/dist/callbacks/base.cjs.map +1 -1
- package/dist/callbacks/base.d.cts +20 -1
- package/dist/callbacks/base.d.cts.map +1 -1
- package/dist/callbacks/base.d.ts +20 -1
- package/dist/callbacks/base.d.ts.map +1 -1
- package/dist/callbacks/base.js +5 -1
- package/dist/callbacks/base.js.map +1 -1
- package/dist/callbacks/manager.cjs +10 -0
- package/dist/callbacks/manager.cjs.map +1 -1
- package/dist/callbacks/manager.d.cts +2 -0
- package/dist/callbacks/manager.d.cts.map +1 -1
- package/dist/callbacks/manager.d.ts +2 -0
- package/dist/callbacks/manager.d.ts.map +1 -1
- package/dist/callbacks/manager.js +10 -0
- package/dist/callbacks/manager.js.map +1 -1
- package/dist/language_models/base.cjs +1 -1
- package/dist/language_models/base.js +1 -1
- package/dist/language_models/chat_models.cjs +103 -1
- package/dist/language_models/chat_models.cjs.map +1 -1
- package/dist/language_models/chat_models.d.cts +55 -0
- package/dist/language_models/chat_models.d.cts.map +1 -1
- package/dist/language_models/chat_models.d.ts +55 -0
- package/dist/language_models/chat_models.d.ts.map +1 -1
- package/dist/language_models/chat_models.js +104 -2
- package/dist/language_models/chat_models.js.map +1 -1
- package/dist/language_models/compat.cjs +412 -0
- package/dist/language_models/compat.cjs.map +1 -0
- package/dist/language_models/compat.d.cts +20 -0
- package/dist/language_models/compat.d.cts.map +1 -0
- package/dist/language_models/compat.d.ts +20 -0
- package/dist/language_models/compat.d.ts.map +1 -0
- package/dist/language_models/compat.js +404 -0
- package/dist/language_models/compat.js.map +1 -0
- package/dist/language_models/event.cjs +12 -0
- package/dist/language_models/event.cjs.map +1 -0
- package/dist/language_models/event.d.cts +185 -0
- package/dist/language_models/event.d.cts.map +1 -0
- package/dist/language_models/event.d.ts +185 -0
- package/dist/language_models/event.d.ts.map +1 -0
- package/dist/language_models/event.js +7 -0
- package/dist/language_models/event.js.map +1 -0
- package/dist/language_models/stream.cjs +464 -0
- package/dist/language_models/stream.cjs.map +1 -0
- package/dist/language_models/stream.d.cts +106 -0
- package/dist/language_models/stream.d.cts.map +1 -0
- package/dist/language_models/stream.d.ts +106 -0
- package/dist/language_models/stream.d.ts.map +1 -0
- package/dist/language_models/stream.js +453 -0
- package/dist/language_models/stream.js.map +1 -0
- package/dist/load/import_map.cjs +6 -0
- package/dist/load/import_map.cjs.map +1 -1
- package/dist/load/import_map.js +8 -2
- package/dist/load/import_map.js.map +1 -1
- package/dist/load/map_keys.cjs +2 -2
- package/dist/messages/ai.cjs +11 -8
- package/dist/messages/ai.cjs.map +1 -1
- package/dist/messages/ai.d.cts.map +1 -1
- package/dist/messages/ai.d.ts.map +1 -1
- package/dist/messages/ai.js +11 -8
- package/dist/messages/ai.js.map +1 -1
- package/dist/messages/content/index.cjs.map +1 -1
- package/dist/messages/content/index.d.cts +5 -1
- package/dist/messages/content/index.d.cts.map +1 -1
- package/dist/messages/content/index.d.ts +5 -1
- package/dist/messages/content/index.d.ts.map +1 -1
- package/dist/messages/content/index.js.map +1 -1
- package/dist/messages/index.d.cts +2 -2
- package/dist/messages/index.d.ts +2 -2
- package/dist/output_parsers/openai_functions/json_output_functions_parsers.d.cts +1 -1
- package/dist/output_parsers/openai_functions/json_output_functions_parsers.d.ts +1 -1
- package/dist/output_parsers/standard_schema.cjs +3 -0
- package/dist/output_parsers/standard_schema.cjs.map +1 -1
- package/dist/output_parsers/standard_schema.d.cts +2 -0
- package/dist/output_parsers/standard_schema.d.cts.map +1 -1
- package/dist/output_parsers/standard_schema.d.ts +2 -0
- package/dist/output_parsers/standard_schema.d.ts.map +1 -1
- package/dist/output_parsers/standard_schema.js +3 -0
- package/dist/output_parsers/standard_schema.js.map +1 -1
- package/dist/output_parsers/structured.cjs +3 -0
- package/dist/output_parsers/structured.cjs.map +1 -1
- package/dist/output_parsers/structured.d.cts +2 -0
- package/dist/output_parsers/structured.d.cts.map +1 -1
- package/dist/output_parsers/structured.d.ts +2 -0
- package/dist/output_parsers/structured.d.ts.map +1 -1
- package/dist/output_parsers/structured.js +3 -0
- package/dist/output_parsers/structured.js.map +1 -1
- package/dist/prompts/template.cjs +1 -1
- package/dist/singletons/callbacks.cjs +1 -1
- package/dist/tracers/console.cjs +1 -1
- package/dist/types/type-utils.d.cts +2 -1
- package/dist/types/type-utils.d.cts.map +1 -1
- package/dist/types/type-utils.d.ts +2 -1
- package/dist/types/type-utils.d.ts.map +1 -1
- package/dist/utils/async_caller.cjs +3 -2
- package/dist/utils/async_caller.cjs.map +1 -1
- package/dist/utils/async_caller.js +2 -1
- package/dist/utils/async_caller.js.map +1 -1
- package/dist/utils/event_source_parse.cjs +5 -12
- package/dist/utils/event_source_parse.cjs.map +1 -1
- package/dist/utils/event_source_parse.js +5 -12
- package/dist/utils/event_source_parse.js.map +1 -1
- package/dist/utils/uuid/max.d.cts +1 -1
- package/dist/utils/uuid/max.d.ts +1 -1
- package/dist/utils/uuid/nil.d.cts +1 -1
- package/dist/utils/uuid/nil.d.ts +1 -1
- package/language_models/compat.cjs +1 -0
- package/language_models/compat.d.cts +1 -0
- package/language_models/compat.d.ts +1 -0
- package/language_models/compat.js +1 -0
- package/language_models/event.cjs +1 -0
- package/language_models/event.d.cts +1 -0
- package/language_models/event.d.ts +1 -0
- package/language_models/event.js +1 -0
- package/language_models/stream.cjs +1 -0
- package/language_models/stream.d.cts +1 -0
- package/language_models/stream.d.ts +1 -0
- package/language_models/stream.js +1 -0
- package/package.json +34 -1
|
@@ -0,0 +1,185 @@
|
|
|
1
|
+
import { ContentBlock } from "../messages/content/index.cjs";
|
|
2
|
+
import { UsageMetadata } from "../messages/metadata.cjs";
|
|
3
|
+
|
|
4
|
+
//#region src/language_models/event.d.ts
|
|
5
|
+
/**
|
|
6
|
+
* Emitted once at the start of a model response.
|
|
7
|
+
*/
|
|
8
|
+
interface MessageStartEvent {
|
|
9
|
+
event: "message-start";
|
|
10
|
+
/** Optional message ID assigned by the provider. */
|
|
11
|
+
id?: string;
|
|
12
|
+
/**
|
|
13
|
+
* Initial usage snapshot, if the provider reports input token counts
|
|
14
|
+
* before content begins streaming (e.g., Anthropic's `message_start`).
|
|
15
|
+
*/
|
|
16
|
+
usage?: Partial<UsageMetadata>;
|
|
17
|
+
}
|
|
18
|
+
/**
|
|
19
|
+
* Finish reason for a model response.
|
|
20
|
+
*
|
|
21
|
+
* - `"stop"`: Natural end of generation.
|
|
22
|
+
* - `"length"`: Hit max token limit.
|
|
23
|
+
* - `"tool_use"`: Model is requesting tool execution.
|
|
24
|
+
* - `"content_filter"`: Content was filtered by safety systems.
|
|
25
|
+
*/
|
|
26
|
+
type FinishReason = "stop" | "length" | "tool_use" | "content_filter";
|
|
27
|
+
/**
|
|
28
|
+
* Emitted once when the model response is complete.
|
|
29
|
+
*/
|
|
30
|
+
interface MessageFinishEvent {
|
|
31
|
+
event: "message-finish";
|
|
32
|
+
/** Why the model stopped generating. */
|
|
33
|
+
reason?: FinishReason;
|
|
34
|
+
/** Final usage snapshot. */
|
|
35
|
+
usage?: Partial<UsageMetadata>;
|
|
36
|
+
/** Provider-specific response metadata (model name, response ID, headers, etc.). */
|
|
37
|
+
responseMetadata?: Record<string, unknown>;
|
|
38
|
+
}
|
|
39
|
+
/**
|
|
40
|
+
* Emitted when a new content block begins streaming.
|
|
41
|
+
*
|
|
42
|
+
* @example
|
|
43
|
+
* ```ts
|
|
44
|
+
* { event: "content-block-start", index: 0,
|
|
45
|
+
* content: { type: "text", text: "" } }
|
|
46
|
+
* ```
|
|
47
|
+
*/
|
|
48
|
+
interface ContentBlockStartEvent {
|
|
49
|
+
event: "content-block-start";
|
|
50
|
+
/** Positional index of this block within the message. */
|
|
51
|
+
index: number;
|
|
52
|
+
/** Initial state of the content block. */
|
|
53
|
+
content: ContentBlock;
|
|
54
|
+
}
|
|
55
|
+
/**
|
|
56
|
+
* Incremental text content. Append `text` to the active block's `text` field.
|
|
57
|
+
*/
|
|
58
|
+
interface TextDelta {
|
|
59
|
+
type: "text-delta";
|
|
60
|
+
/** The new text to append. */
|
|
61
|
+
text: string;
|
|
62
|
+
}
|
|
63
|
+
/**
|
|
64
|
+
* Incremental reasoning content. Append `reasoning` to the active block's
|
|
65
|
+
* `reasoning` field.
|
|
66
|
+
*/
|
|
67
|
+
interface ReasoningDelta {
|
|
68
|
+
type: "reasoning-delta";
|
|
69
|
+
/** The new reasoning text to append. */
|
|
70
|
+
reasoning: string;
|
|
71
|
+
}
|
|
72
|
+
/**
|
|
73
|
+
* Incremental encoded data. Append `data` to the active multimodal block's
|
|
74
|
+
* data field.
|
|
75
|
+
*/
|
|
76
|
+
interface DataDelta {
|
|
77
|
+
type: "data-delta";
|
|
78
|
+
/** Encoded data chunk to append. */
|
|
79
|
+
data: string;
|
|
80
|
+
/** Encoding for the data chunk. Defaults to `"base64"` when omitted. */
|
|
81
|
+
encoding?: "base64";
|
|
82
|
+
}
|
|
83
|
+
/**
|
|
84
|
+
* Generic content block field update. Shallow-merge `fields` onto the active
|
|
85
|
+
* content block.
|
|
86
|
+
*/
|
|
87
|
+
interface BlockDelta {
|
|
88
|
+
type: "block-delta";
|
|
89
|
+
/** Fields to shallow-merge onto the active content block. */
|
|
90
|
+
fields: {
|
|
91
|
+
type: string;
|
|
92
|
+
} & Record<string, unknown>;
|
|
93
|
+
}
|
|
94
|
+
/**
|
|
95
|
+
* Union of all content block delta types.
|
|
96
|
+
*/
|
|
97
|
+
type ContentBlockDelta = TextDelta | ReasoningDelta | DataDelta | BlockDelta;
|
|
98
|
+
/**
|
|
99
|
+
* Emitted for each incremental update within a content block.
|
|
100
|
+
*
|
|
101
|
+
* The `delta` field carries the incremental content block update.
|
|
102
|
+
* Accumulation rules:
|
|
103
|
+
* - `text-delta` → append `text` to the active block's text field
|
|
104
|
+
* - `reasoning-delta` → append `reasoning` to the active block's reasoning field
|
|
105
|
+
* - `data-delta` → append `data` to the active block's data field
|
|
106
|
+
* - `block-delta` → shallow-merge `fields` onto the active block
|
|
107
|
+
*
|
|
108
|
+
* @example
|
|
109
|
+
* ```ts
|
|
110
|
+
* // Text token
|
|
111
|
+
* { event: "content-block-delta", index: 0,
|
|
112
|
+
* delta: { type: "text-delta", text: " world" } }
|
|
113
|
+
*
|
|
114
|
+
* // Tool call args snapshot
|
|
115
|
+
* { event: "content-block-delta", index: 1,
|
|
116
|
+
* delta: { type: "block-delta",
|
|
117
|
+
* fields: { type: "tool_call_chunk", args: '{"q":"wea' } } } }
|
|
118
|
+
*
|
|
119
|
+
* // Provider-specific field (e.g., signature)
|
|
120
|
+
* { event: "content-block-delta", index: 0,
|
|
121
|
+
* delta: { type: "block-delta",
|
|
122
|
+
* fields: { type: "reasoning", signature: "sig_abc" } } }
|
|
123
|
+
* ```
|
|
124
|
+
*/
|
|
125
|
+
interface ContentBlockDeltaEvent {
|
|
126
|
+
event: "content-block-delta";
|
|
127
|
+
/** Positional index of the block being updated. */
|
|
128
|
+
index: number;
|
|
129
|
+
/** Incremental content block delta. */
|
|
130
|
+
delta: ContentBlockDelta;
|
|
131
|
+
}
|
|
132
|
+
/**
|
|
133
|
+
* Emitted when a content block is complete.
|
|
134
|
+
*
|
|
135
|
+
* @example
|
|
136
|
+
* ```ts
|
|
137
|
+
* { event: "content-block-finish", index: 0,
|
|
138
|
+
* content: { type: "text", text: "Hello world" } }
|
|
139
|
+
* ```
|
|
140
|
+
*/
|
|
141
|
+
interface ContentBlockFinishEvent {
|
|
142
|
+
event: "content-block-finish";
|
|
143
|
+
/** Positional index of the completed block. */
|
|
144
|
+
index: number;
|
|
145
|
+
/** Finalized content block. */
|
|
146
|
+
content: ContentBlock;
|
|
147
|
+
}
|
|
148
|
+
/**
|
|
149
|
+
* Emitted whenever the provider reports updated usage information.
|
|
150
|
+
* Each event carries a **running snapshot** (not an additive delta).
|
|
151
|
+
*/
|
|
152
|
+
interface UsageUpdateEvent {
|
|
153
|
+
event: "usage";
|
|
154
|
+
/** Current usage snapshot. */
|
|
155
|
+
usage: Partial<UsageMetadata>;
|
|
156
|
+
}
|
|
157
|
+
/**
|
|
158
|
+
* Passthrough for native provider events that don't map to standard types.
|
|
159
|
+
*/
|
|
160
|
+
interface ProviderEvent {
|
|
161
|
+
event: "provider";
|
|
162
|
+
/** Provider identifier (e.g., `"openai"`, `"anthropic"`, `"google"`). */
|
|
163
|
+
provider: string;
|
|
164
|
+
/** Raw event type name from the provider SDK. */
|
|
165
|
+
name: string;
|
|
166
|
+
/** Raw event payload from the provider SDK. */
|
|
167
|
+
payload: unknown;
|
|
168
|
+
}
|
|
169
|
+
/**
|
|
170
|
+
* Emitted on unrecoverable stream errors.
|
|
171
|
+
*/
|
|
172
|
+
interface StreamErrorEvent {
|
|
173
|
+
event: "error";
|
|
174
|
+
/** Human-readable error message. */
|
|
175
|
+
message: string;
|
|
176
|
+
/** Optional error code for programmatic handling. */
|
|
177
|
+
code?: string;
|
|
178
|
+
}
|
|
179
|
+
/**
|
|
180
|
+
* Union of all chat model stream event types.
|
|
181
|
+
*/
|
|
182
|
+
type ChatModelStreamEvent = MessageStartEvent | MessageFinishEvent | ContentBlockStartEvent | ContentBlockDeltaEvent | ContentBlockFinishEvent | UsageUpdateEvent | ProviderEvent | StreamErrorEvent;
|
|
183
|
+
//#endregion
|
|
184
|
+
export { BlockDelta, ChatModelStreamEvent, ContentBlockDelta, ContentBlockDeltaEvent, ContentBlockFinishEvent, ContentBlockStartEvent, DataDelta, FinishReason, MessageFinishEvent, MessageStartEvent, ProviderEvent, ReasoningDelta, StreamErrorEvent, TextDelta, UsageUpdateEvent };
|
|
185
|
+
//# sourceMappingURL=event.d.cts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"event.d.cts","names":[],"sources":["../../src/language_models/event.ts"],"mappings":";;;;AA4FA;;;AAAA,UA9CiB,iBAAA;EACf,KAAA;EAgDA;EA9CA,EAAA;EAgDS;;;AAQX;EAnDE,KAAA,GAAQ,OAAA,CAAQ,aAAA;AAAA;;;AA6DlB;;;;;AAUA;KA5DY,YAAA;;;;UAKK,kBAAA;EACf,KAAA;EA2DQ;EAzDR,MAAA,GAAS,YAAA;EAgEM;EA9Df,KAAA,GAAQ,OAAA,CAAQ,aAAA;;EAEhB,gBAAA,GAAmB,MAAA;AAAA;;;;;;AAqErB;;;;UAtDiB,sBAAA;EACf,KAAA;EAyDE;EAvDF,KAAA;EAuDY;EArDZ,OAAA,EAAS,YAAA;AAAA;;;;UAQM,SAAA;EACf,IAAA;EAyEqC;EAvErC,IAAA;AAAA;;;;;UAOe,cAAA;EACf,IAAA;EAgFe;EA9Ef,SAAA;AAAA;;;;;UAOe,SAAA;EACf,IAAA;EA2EqB;EAzErB,IAAA;EAkF+B;EAhF/B,QAAA;AAAA;;;;;UAOe,UAAA;EACf,IAAA;EAmFe;EAjFf,MAAA;IAAU,IAAA;EAAA,IAAiB,MAAA;AAAA;;;;KAMjB,iBAAA,GACR,SAAA,GACA,cAAA,GACA,SAAA,GACA,UAAA;;AAsFJ;;;;;;;;;AAaA;;;;;;;;;;;;;;;;;UAtEiB,sBAAA;EACf,KAAA;EA4EE;EA1EF,KAAA;EA2EkB;EAzElB,KAAA,EAAO,iBAAA;AAAA;;;;;;;;;;UAYQ,uBAAA;EACf,KAAA;;EAEA,KAAA;;EAEA,OAAA,EAAS,YAAA;AAAA;;;;;UASM,gBAAA;EACf,KAAA;;EAEA,KAAA,EAAO,OAAA,CAAQ,aAAA;AAAA;;;;UAQA,aAAA;EACf,KAAA;;EAEA,QAAA;;EAEA,IAAA;;EAEA,OAAA;AAAA;;;;UAQe,gBAAA;EACf,KAAA;;EAEA,OAAA;;EAEA,IAAA;AAAA;;;;KAQU,oBAAA,GACR,iBAAA,GACA,kBAAA,GACA,sBAAA,GACA,sBAAA,GACA,uBAAA,GACA,gBAAA,GACA,aAAA,GACA,gBAAA"}
|
|
@@ -0,0 +1,185 @@
|
|
|
1
|
+
import { ContentBlock } from "../messages/content/index.js";
|
|
2
|
+
import { UsageMetadata } from "../messages/metadata.js";
|
|
3
|
+
|
|
4
|
+
//#region src/language_models/event.d.ts
|
|
5
|
+
/**
|
|
6
|
+
* Emitted once at the start of a model response.
|
|
7
|
+
*/
|
|
8
|
+
interface MessageStartEvent {
|
|
9
|
+
event: "message-start";
|
|
10
|
+
/** Optional message ID assigned by the provider. */
|
|
11
|
+
id?: string;
|
|
12
|
+
/**
|
|
13
|
+
* Initial usage snapshot, if the provider reports input token counts
|
|
14
|
+
* before content begins streaming (e.g., Anthropic's `message_start`).
|
|
15
|
+
*/
|
|
16
|
+
usage?: Partial<UsageMetadata>;
|
|
17
|
+
}
|
|
18
|
+
/**
|
|
19
|
+
* Finish reason for a model response.
|
|
20
|
+
*
|
|
21
|
+
* - `"stop"`: Natural end of generation.
|
|
22
|
+
* - `"length"`: Hit max token limit.
|
|
23
|
+
* - `"tool_use"`: Model is requesting tool execution.
|
|
24
|
+
* - `"content_filter"`: Content was filtered by safety systems.
|
|
25
|
+
*/
|
|
26
|
+
type FinishReason = "stop" | "length" | "tool_use" | "content_filter";
|
|
27
|
+
/**
|
|
28
|
+
* Emitted once when the model response is complete.
|
|
29
|
+
*/
|
|
30
|
+
interface MessageFinishEvent {
|
|
31
|
+
event: "message-finish";
|
|
32
|
+
/** Why the model stopped generating. */
|
|
33
|
+
reason?: FinishReason;
|
|
34
|
+
/** Final usage snapshot. */
|
|
35
|
+
usage?: Partial<UsageMetadata>;
|
|
36
|
+
/** Provider-specific response metadata (model name, response ID, headers, etc.). */
|
|
37
|
+
responseMetadata?: Record<string, unknown>;
|
|
38
|
+
}
|
|
39
|
+
/**
|
|
40
|
+
* Emitted when a new content block begins streaming.
|
|
41
|
+
*
|
|
42
|
+
* @example
|
|
43
|
+
* ```ts
|
|
44
|
+
* { event: "content-block-start", index: 0,
|
|
45
|
+
* content: { type: "text", text: "" } }
|
|
46
|
+
* ```
|
|
47
|
+
*/
|
|
48
|
+
interface ContentBlockStartEvent {
|
|
49
|
+
event: "content-block-start";
|
|
50
|
+
/** Positional index of this block within the message. */
|
|
51
|
+
index: number;
|
|
52
|
+
/** Initial state of the content block. */
|
|
53
|
+
content: ContentBlock;
|
|
54
|
+
}
|
|
55
|
+
/**
|
|
56
|
+
* Incremental text content. Append `text` to the active block's `text` field.
|
|
57
|
+
*/
|
|
58
|
+
interface TextDelta {
|
|
59
|
+
type: "text-delta";
|
|
60
|
+
/** The new text to append. */
|
|
61
|
+
text: string;
|
|
62
|
+
}
|
|
63
|
+
/**
|
|
64
|
+
* Incremental reasoning content. Append `reasoning` to the active block's
|
|
65
|
+
* `reasoning` field.
|
|
66
|
+
*/
|
|
67
|
+
interface ReasoningDelta {
|
|
68
|
+
type: "reasoning-delta";
|
|
69
|
+
/** The new reasoning text to append. */
|
|
70
|
+
reasoning: string;
|
|
71
|
+
}
|
|
72
|
+
/**
|
|
73
|
+
* Incremental encoded data. Append `data` to the active multimodal block's
|
|
74
|
+
* data field.
|
|
75
|
+
*/
|
|
76
|
+
interface DataDelta {
|
|
77
|
+
type: "data-delta";
|
|
78
|
+
/** Encoded data chunk to append. */
|
|
79
|
+
data: string;
|
|
80
|
+
/** Encoding for the data chunk. Defaults to `"base64"` when omitted. */
|
|
81
|
+
encoding?: "base64";
|
|
82
|
+
}
|
|
83
|
+
/**
|
|
84
|
+
* Generic content block field update. Shallow-merge `fields` onto the active
|
|
85
|
+
* content block.
|
|
86
|
+
*/
|
|
87
|
+
interface BlockDelta {
|
|
88
|
+
type: "block-delta";
|
|
89
|
+
/** Fields to shallow-merge onto the active content block. */
|
|
90
|
+
fields: {
|
|
91
|
+
type: string;
|
|
92
|
+
} & Record<string, unknown>;
|
|
93
|
+
}
|
|
94
|
+
/**
|
|
95
|
+
* Union of all content block delta types.
|
|
96
|
+
*/
|
|
97
|
+
type ContentBlockDelta = TextDelta | ReasoningDelta | DataDelta | BlockDelta;
|
|
98
|
+
/**
|
|
99
|
+
* Emitted for each incremental update within a content block.
|
|
100
|
+
*
|
|
101
|
+
* The `delta` field carries the incremental content block update.
|
|
102
|
+
* Accumulation rules:
|
|
103
|
+
* - `text-delta` → append `text` to the active block's text field
|
|
104
|
+
* - `reasoning-delta` → append `reasoning` to the active block's reasoning field
|
|
105
|
+
* - `data-delta` → append `data` to the active block's data field
|
|
106
|
+
* - `block-delta` → shallow-merge `fields` onto the active block
|
|
107
|
+
*
|
|
108
|
+
* @example
|
|
109
|
+
* ```ts
|
|
110
|
+
* // Text token
|
|
111
|
+
* { event: "content-block-delta", index: 0,
|
|
112
|
+
* delta: { type: "text-delta", text: " world" } }
|
|
113
|
+
*
|
|
114
|
+
* // Tool call args snapshot
|
|
115
|
+
* { event: "content-block-delta", index: 1,
|
|
116
|
+
* delta: { type: "block-delta",
|
|
117
|
+
* fields: { type: "tool_call_chunk", args: '{"q":"wea' } } } }
|
|
118
|
+
*
|
|
119
|
+
* // Provider-specific field (e.g., signature)
|
|
120
|
+
* { event: "content-block-delta", index: 0,
|
|
121
|
+
* delta: { type: "block-delta",
|
|
122
|
+
* fields: { type: "reasoning", signature: "sig_abc" } } }
|
|
123
|
+
* ```
|
|
124
|
+
*/
|
|
125
|
+
interface ContentBlockDeltaEvent {
|
|
126
|
+
event: "content-block-delta";
|
|
127
|
+
/** Positional index of the block being updated. */
|
|
128
|
+
index: number;
|
|
129
|
+
/** Incremental content block delta. */
|
|
130
|
+
delta: ContentBlockDelta;
|
|
131
|
+
}
|
|
132
|
+
/**
|
|
133
|
+
* Emitted when a content block is complete.
|
|
134
|
+
*
|
|
135
|
+
* @example
|
|
136
|
+
* ```ts
|
|
137
|
+
* { event: "content-block-finish", index: 0,
|
|
138
|
+
* content: { type: "text", text: "Hello world" } }
|
|
139
|
+
* ```
|
|
140
|
+
*/
|
|
141
|
+
interface ContentBlockFinishEvent {
|
|
142
|
+
event: "content-block-finish";
|
|
143
|
+
/** Positional index of the completed block. */
|
|
144
|
+
index: number;
|
|
145
|
+
/** Finalized content block. */
|
|
146
|
+
content: ContentBlock;
|
|
147
|
+
}
|
|
148
|
+
/**
|
|
149
|
+
* Emitted whenever the provider reports updated usage information.
|
|
150
|
+
* Each event carries a **running snapshot** (not an additive delta).
|
|
151
|
+
*/
|
|
152
|
+
interface UsageUpdateEvent {
|
|
153
|
+
event: "usage";
|
|
154
|
+
/** Current usage snapshot. */
|
|
155
|
+
usage: Partial<UsageMetadata>;
|
|
156
|
+
}
|
|
157
|
+
/**
|
|
158
|
+
* Passthrough for native provider events that don't map to standard types.
|
|
159
|
+
*/
|
|
160
|
+
interface ProviderEvent {
|
|
161
|
+
event: "provider";
|
|
162
|
+
/** Provider identifier (e.g., `"openai"`, `"anthropic"`, `"google"`). */
|
|
163
|
+
provider: string;
|
|
164
|
+
/** Raw event type name from the provider SDK. */
|
|
165
|
+
name: string;
|
|
166
|
+
/** Raw event payload from the provider SDK. */
|
|
167
|
+
payload: unknown;
|
|
168
|
+
}
|
|
169
|
+
/**
|
|
170
|
+
* Emitted on unrecoverable stream errors.
|
|
171
|
+
*/
|
|
172
|
+
interface StreamErrorEvent {
|
|
173
|
+
event: "error";
|
|
174
|
+
/** Human-readable error message. */
|
|
175
|
+
message: string;
|
|
176
|
+
/** Optional error code for programmatic handling. */
|
|
177
|
+
code?: string;
|
|
178
|
+
}
|
|
179
|
+
/**
|
|
180
|
+
* Union of all chat model stream event types.
|
|
181
|
+
*/
|
|
182
|
+
type ChatModelStreamEvent = MessageStartEvent | MessageFinishEvent | ContentBlockStartEvent | ContentBlockDeltaEvent | ContentBlockFinishEvent | UsageUpdateEvent | ProviderEvent | StreamErrorEvent;
|
|
183
|
+
//#endregion
|
|
184
|
+
export { BlockDelta, ChatModelStreamEvent, ContentBlockDelta, ContentBlockDeltaEvent, ContentBlockFinishEvent, ContentBlockStartEvent, DataDelta, FinishReason, MessageFinishEvent, MessageStartEvent, ProviderEvent, ReasoningDelta, StreamErrorEvent, TextDelta, UsageUpdateEvent };
|
|
185
|
+
//# sourceMappingURL=event.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"event.d.ts","names":[],"sources":["../../src/language_models/event.ts"],"mappings":";;;;AA4FA;;;AAAA,UA9CiB,iBAAA;EACf,KAAA;EAgDA;EA9CA,EAAA;EAgDS;;;AAQX;EAnDE,KAAA,GAAQ,OAAA,CAAQ,aAAA;AAAA;;;AA6DlB;;;;;AAUA;KA5DY,YAAA;;;;UAKK,kBAAA;EACf,KAAA;EA2DQ;EAzDR,MAAA,GAAS,YAAA;EAgEM;EA9Df,KAAA,GAAQ,OAAA,CAAQ,aAAA;;EAEhB,gBAAA,GAAmB,MAAA;AAAA;;;;;;AAqErB;;;;UAtDiB,sBAAA;EACf,KAAA;EAyDE;EAvDF,KAAA;EAuDY;EArDZ,OAAA,EAAS,YAAA;AAAA;;;;UAQM,SAAA;EACf,IAAA;EAyEqC;EAvErC,IAAA;AAAA;;;;;UAOe,cAAA;EACf,IAAA;EAgFe;EA9Ef,SAAA;AAAA;;;;;UAOe,SAAA;EACf,IAAA;EA2EqB;EAzErB,IAAA;EAkF+B;EAhF/B,QAAA;AAAA;;;;;UAOe,UAAA;EACf,IAAA;EAmFe;EAjFf,MAAA;IAAU,IAAA;EAAA,IAAiB,MAAA;AAAA;;;;KAMjB,iBAAA,GACR,SAAA,GACA,cAAA,GACA,SAAA,GACA,UAAA;;AAsFJ;;;;;;;;;AAaA;;;;;;;;;;;;;;;;;UAtEiB,sBAAA;EACf,KAAA;EA4EE;EA1EF,KAAA;EA2EkB;EAzElB,KAAA,EAAO,iBAAA;AAAA;;;;;;;;;;UAYQ,uBAAA;EACf,KAAA;;EAEA,KAAA;;EAEA,OAAA,EAAS,YAAA;AAAA;;;;;UASM,gBAAA;EACf,KAAA;;EAEA,KAAA,EAAO,OAAA,CAAQ,aAAA;AAAA;;;;UAQA,aAAA;EACf,KAAA;;EAEA,QAAA;;EAEA,IAAA;;EAEA,OAAA;AAAA;;;;UAQe,gBAAA;EACf,KAAA;;EAEA,OAAA;;EAEA,IAAA;AAAA;;;;KAQU,oBAAA,GACR,iBAAA,GACA,kBAAA,GACA,sBAAA,GACA,sBAAA,GACA,uBAAA,GACA,gBAAA,GACA,aAAA,GACA,gBAAA"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"event.js","names":[],"sources":["../../src/language_models/event.ts"],"sourcesContent":["/**\n * Chat model streaming event protocol.\n *\n * Defines a content-block-centric event model for streaming chat model responses.\n * Events carry LangChain {@link ContentBlock} types on lifecycle boundaries\n * and explicit delta variants for incremental updates during streaming.\n *\n * ## Design Principles\n *\n * 1. **Content-block deltas have explicit merge semantics.** Text,\n * reasoning, and data deltas append to named fields. Generic block deltas\n * shallow-merge fields onto the active content block.\n *\n * 2. **Lifecycle completeness.** Every streamable entity has explicit start and finish\n * events. Consumers never need to infer boundaries from absence of events.\n *\n * 3. **Interleaving allowed.** Content blocks may interleave (e.g., parallel tool calls).\n * The only invariant: a block's start precedes its deltas, and its deltas precede\n * its finish. No ordering constraint between different blocks.\n *\n * 4. **Provider passthrough.** Native provider events that don't map to standard types\n * are forwarded as {@link ProviderEvent} rather than silently dropped.\n *\n * ## Lifecycle Contract\n *\n * ```\n * MessageStart\n * -> ContentBlockStart(index=0, content=...)\n * -> ContentBlockDelta(index=0, delta={ type: \"text-delta\", text: \"Hello\" })\n * -> ContentBlockDelta(index=0, delta={ type: \"text-delta\", text: \" world\" })\n * -> ContentBlockFinish(index=0, content=...)\n * -> UsageUpdate(...)\n * -> MessageFinish(reason, usage?)\n * ```\n *\n * @module\n */\n\nimport type { ContentBlock } from \"../messages/content/index.js\";\nimport type { UsageMetadata } from \"../messages/metadata.js\";\n\n// ─── Message Lifecycle ──────────────────────────────────────────\n\n/**\n * Emitted once at the start of a model response.\n */\nexport interface MessageStartEvent {\n event: \"message-start\";\n /** Optional message ID assigned by the provider. */\n id?: string;\n /**\n * Initial usage snapshot, if the provider reports input token counts\n * before content begins streaming (e.g., Anthropic's `message_start`).\n */\n usage?: Partial<UsageMetadata>;\n}\n\n/**\n * Finish reason for a model response.\n *\n * - `\"stop\"`: Natural end of generation.\n * - `\"length\"`: Hit max token limit.\n * - `\"tool_use\"`: Model is requesting tool execution.\n * - `\"content_filter\"`: Content was filtered by safety systems.\n */\nexport type FinishReason = \"stop\" | \"length\" | \"tool_use\" | \"content_filter\";\n\n/**\n * Emitted once when the model response is complete.\n */\nexport interface MessageFinishEvent {\n event: \"message-finish\";\n /** Why the model stopped generating. */\n reason?: FinishReason;\n /** Final usage snapshot. */\n usage?: Partial<UsageMetadata>;\n /** Provider-specific response metadata (model name, response ID, headers, etc.). */\n responseMetadata?: Record<string, unknown>;\n}\n\n// ─── Content Block Lifecycle ────────────────────────────────────\n// See https://github.com/langchain-ai/agent-protocol/blob/main/streaming/protocol.cddl\n\n/**\n * Emitted when a new content block begins streaming.\n *\n * @example\n * ```ts\n * { event: \"content-block-start\", index: 0,\n * content: { type: \"text\", text: \"\" } }\n * ```\n */\nexport interface ContentBlockStartEvent {\n event: \"content-block-start\";\n /** Positional index of this block within the message. */\n index: number;\n /** Initial state of the content block. */\n content: ContentBlock;\n}\n\n// ─── Content Block Deltas ───────────────────────────────────────\n\n/**\n * Incremental text content. Append `text` to the active block's `text` field.\n */\nexport interface TextDelta {\n type: \"text-delta\";\n /** The new text to append. */\n text: string;\n}\n\n/**\n * Incremental reasoning content. Append `reasoning` to the active block's\n * `reasoning` field.\n */\nexport interface ReasoningDelta {\n type: \"reasoning-delta\";\n /** The new reasoning text to append. */\n reasoning: string;\n}\n\n/**\n * Incremental encoded data. Append `data` to the active multimodal block's\n * data field.\n */\nexport interface DataDelta {\n type: \"data-delta\";\n /** Encoded data chunk to append. */\n data: string;\n /** Encoding for the data chunk. Defaults to `\"base64\"` when omitted. */\n encoding?: \"base64\";\n}\n\n/**\n * Generic content block field update. Shallow-merge `fields` onto the active\n * content block.\n */\nexport interface BlockDelta {\n type: \"block-delta\";\n /** Fields to shallow-merge onto the active content block. */\n fields: { type: string } & Record<string, unknown>;\n}\n\n/**\n * Union of all content block delta types.\n */\nexport type ContentBlockDelta =\n | TextDelta\n | ReasoningDelta\n | DataDelta\n | BlockDelta;\n\n/**\n * Emitted for each incremental update within a content block.\n *\n * The `delta` field carries the incremental content block update.\n * Accumulation rules:\n * - `text-delta` → append `text` to the active block's text field\n * - `reasoning-delta` → append `reasoning` to the active block's reasoning field\n * - `data-delta` → append `data` to the active block's data field\n * - `block-delta` → shallow-merge `fields` onto the active block\n *\n * @example\n * ```ts\n * // Text token\n * { event: \"content-block-delta\", index: 0,\n * delta: { type: \"text-delta\", text: \" world\" } }\n *\n * // Tool call args snapshot\n * { event: \"content-block-delta\", index: 1,\n * delta: { type: \"block-delta\",\n * fields: { type: \"tool_call_chunk\", args: '{\"q\":\"wea' } } } }\n *\n * // Provider-specific field (e.g., signature)\n * { event: \"content-block-delta\", index: 0,\n * delta: { type: \"block-delta\",\n * fields: { type: \"reasoning\", signature: \"sig_abc\" } } }\n * ```\n */\nexport interface ContentBlockDeltaEvent {\n event: \"content-block-delta\";\n /** Positional index of the block being updated. */\n index: number;\n /** Incremental content block delta. */\n delta: ContentBlockDelta;\n}\n\n/**\n * Emitted when a content block is complete.\n *\n * @example\n * ```ts\n * { event: \"content-block-finish\", index: 0,\n * content: { type: \"text\", text: \"Hello world\" } }\n * ```\n */\nexport interface ContentBlockFinishEvent {\n event: \"content-block-finish\";\n /** Positional index of the completed block. */\n index: number;\n /** Finalized content block. */\n content: ContentBlock;\n}\n\n// ─── Usage ──────────────────────────────────────────────────────\n\n/**\n * Emitted whenever the provider reports updated usage information.\n * Each event carries a **running snapshot** (not an additive delta).\n */\nexport interface UsageUpdateEvent {\n event: \"usage\";\n /** Current usage snapshot. */\n usage: Partial<UsageMetadata>;\n}\n\n// ─── Provider Passthrough ───────────────────────────────────────\n\n/**\n * Passthrough for native provider events that don't map to standard types.\n */\nexport interface ProviderEvent {\n event: \"provider\";\n /** Provider identifier (e.g., `\"openai\"`, `\"anthropic\"`, `\"google\"`). */\n provider: string;\n /** Raw event type name from the provider SDK. */\n name: string;\n /** Raw event payload from the provider SDK. */\n payload: unknown;\n}\n\n// ─── Error ──────────────────────────────────────────────────────\n\n/**\n * Emitted on unrecoverable stream errors.\n */\nexport interface StreamErrorEvent {\n event: \"error\";\n /** Human-readable error message. */\n message: string;\n /** Optional error code for programmatic handling. */\n code?: string;\n}\n\n// ─── Union ──────────────────────────────────────────────────────\n\n/**\n * Union of all chat model stream event types.\n */\nexport type ChatModelStreamEvent =\n | MessageStartEvent\n | MessageFinishEvent\n | ContentBlockStartEvent\n | ContentBlockDeltaEvent\n | ContentBlockFinishEvent\n | UsageUpdateEvent\n | ProviderEvent\n | StreamErrorEvent;\n"],"mappings":""}
|