-
Notifications
You must be signed in to change notification settings - Fork 2.1k
/
base.ts
207 lines (183 loc) Β· 6.22 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
// Default generic "any" values are for backwards compatibility.
// Replace with "string" when we are comfortable with a breaking change.
import type {
InputValues,
PartialValues,
StringWithAutocomplete,
} from "../utils/types.js";
import { type BasePromptValueInterface } from "../prompt_values.js";
import { BaseOutputParser } from "../output_parsers/index.js";
import type { SerializedFields } from "../load/map_keys.js";
import { Runnable } from "../runnables/base.js";
import { BaseCallbackConfig } from "../callbacks/manager.js";
import type { SerializedBasePromptTemplate } from "../prompts/serde.js";
export type TypedPromptInputValues<RunInput> = InputValues<
StringWithAutocomplete<Extract<keyof RunInput, string>>
>;
export type Example = Record<string, string>;
/**
* Input common to all prompt templates.
*/
export interface BasePromptTemplateInput<
// eslint-disable-next-line @typescript-eslint/no-explicit-any
InputVariables extends InputValues = any,
// eslint-disable-next-line @typescript-eslint/no-explicit-any
PartialVariableName extends string = any
> {
/**
* A list of variable names the prompt template expects
*/
inputVariables: Array<Extract<keyof InputVariables, string>>;
/**
* How to parse the output of calling an LLM on this formatted prompt
*/
outputParser?: BaseOutputParser;
/** Partial variables */
partialVariables?: PartialValues<PartialVariableName>;
}
/**
* Base class for prompt templates. Exposes a format method that returns a
* string prompt given a set of input values.
*/
export abstract class BasePromptTemplate<
// eslint-disable-next-line @typescript-eslint/no-explicit-any
RunInput extends InputValues = any,
RunOutput extends BasePromptValueInterface = BasePromptValueInterface,
// eslint-disable-next-line @typescript-eslint/no-explicit-any
PartialVariableName extends string = any
>
extends Runnable<RunInput, RunOutput>
implements BasePromptTemplateInput
{
declare PromptValueReturnType: RunOutput;
lc_serializable = true;
lc_namespace = ["langchain_core", "prompts", this._getPromptType()];
get lc_attributes(): SerializedFields | undefined {
return {
partialVariables: undefined, // python doesn't support this yet
};
}
inputVariables: Array<Extract<keyof RunInput, string>>;
outputParser?: BaseOutputParser;
partialVariables: PartialValues<PartialVariableName>;
constructor(input: BasePromptTemplateInput) {
super(input);
const { inputVariables } = input;
if (inputVariables.includes("stop")) {
throw new Error(
"Cannot have an input variable named 'stop', as it is used internally, please rename."
);
}
Object.assign(this, input);
}
abstract partial(
values: PartialValues
): Promise<BasePromptTemplate<RunInput, RunOutput, PartialVariableName>>;
/**
* Merges partial variables and user variables.
* @param userVariables The user variables to merge with the partial variables.
* @returns A Promise that resolves to an object containing the merged variables.
*/
async mergePartialAndUserVariables(
userVariables: TypedPromptInputValues<RunInput>
): Promise<
InputValues<Extract<keyof RunInput, string> | PartialVariableName>
> {
const partialVariables = this.partialVariables ?? {};
const partialValues: Record<string, string> = {};
for (const [key, value] of Object.entries(partialVariables)) {
if (typeof value === "string") {
partialValues[key] = value;
} else {
partialValues[key] = await (value as () => Promise<string>)();
}
}
const allKwargs = {
...(partialValues as Record<PartialVariableName, string>),
...userVariables,
};
return allKwargs;
}
/**
* Invokes the prompt template with the given input and options.
* @param input The input to invoke the prompt template with.
* @param options Optional configuration for the callback.
* @returns A Promise that resolves to the output of the prompt template.
*/
async invoke(
input: RunInput,
options?: BaseCallbackConfig
): Promise<RunOutput> {
return this._callWithConfig(
(input: RunInput) => this.formatPromptValue(input),
input,
{ ...options, runType: "prompt" }
);
}
/**
* Format the prompt given the input values.
*
* @param values - A dictionary of arguments to be passed to the prompt template.
* @returns A formatted prompt string.
*
* @example
* ```ts
* prompt.format({ foo: "bar" });
* ```
*/
abstract format(values: TypedPromptInputValues<RunInput>): Promise<string>;
/**
* Format the prompt given the input values and return a formatted prompt value.
* @param values
* @returns A formatted PromptValue.
*/
abstract formatPromptValue(
values: TypedPromptInputValues<RunInput>
): Promise<RunOutput>;
/**
* Return the string type key uniquely identifying this class of prompt template.
*/
abstract _getPromptType(): string;
/**
* Return a json-like object representing this prompt template.
* @deprecated
*/
serialize(): SerializedBasePromptTemplate {
throw new Error("Use .toJSON() instead");
}
/**
* @deprecated
* Load a prompt template from a json-like object describing it.
*
* @remarks
* Deserializing needs to be async because templates (e.g. {@link FewShotPromptTemplate}) can
* reference remote resources that we read asynchronously with a web
* request.
*/
static async deserialize(
data: SerializedBasePromptTemplate
): Promise<
BasePromptTemplate<InputValues, BasePromptValueInterface, string>
> {
switch (data._type) {
case "prompt": {
const { PromptTemplate } = await import("./prompt.js");
return PromptTemplate.deserialize(data);
}
case undefined: {
const { PromptTemplate } = await import("./prompt.js");
return PromptTemplate.deserialize({ ...data, _type: "prompt" });
}
case "few_shot": {
const { FewShotPromptTemplate } = await import("./few_shot.js");
return FewShotPromptTemplate.deserialize(data);
}
default:
throw new Error(
`Invalid prompt type in config: ${
(data as SerializedBasePromptTemplate)._type
}`
);
}
}
}