manager.cjs 38 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890
  1. "use strict";
  2. Object.defineProperty(exports, "__esModule", { value: true });
  3. exports.traceAsGroup = exports.TraceGroup = exports.ensureHandler = exports.CallbackManager = exports.CallbackManagerForToolRun = exports.CallbackManagerForChainRun = exports.CallbackManagerForLLMRun = exports.CallbackManagerForRetrieverRun = exports.BaseRunManager = exports.BaseCallbackManager = exports.parseCallbackConfigArg = void 0;
  4. const uuid_1 = require("uuid");
  5. const base_js_1 = require("./base.cjs");
  6. const console_js_1 = require("../tracers/console.cjs");
  7. const utils_js_1 = require("../messages/utils.cjs");
  8. const env_js_1 = require("../utils/env.cjs");
  9. const tracer_langchain_js_1 = require("../tracers/tracer_langchain.cjs");
  10. const promises_js_1 = require("./promises.cjs");
  11. const callbacks_js_1 = require("../utils/callbacks.cjs");
  12. const base_js_2 = require("../tracers/base.cjs");
  13. const context_js_1 = require("../singletons/async_local_storage/context.cjs");
  14. function parseCallbackConfigArg(arg) {
  15. if (!arg) {
  16. return {};
  17. }
  18. else if (Array.isArray(arg) || "name" in arg) {
  19. return { callbacks: arg };
  20. }
  21. else {
  22. return arg;
  23. }
  24. }
  25. exports.parseCallbackConfigArg = parseCallbackConfigArg;
  26. /**
  27. * Manage callbacks from different components of LangChain.
  28. */
  29. class BaseCallbackManager {
  30. setHandler(handler) {
  31. return this.setHandlers([handler]);
  32. }
  33. }
  34. exports.BaseCallbackManager = BaseCallbackManager;
  35. /**
  36. * Base class for run manager in LangChain.
  37. */
  38. class BaseRunManager {
  39. constructor(runId, handlers, inheritableHandlers, tags, inheritableTags, metadata, inheritableMetadata, _parentRunId) {
  40. Object.defineProperty(this, "runId", {
  41. enumerable: true,
  42. configurable: true,
  43. writable: true,
  44. value: runId
  45. });
  46. Object.defineProperty(this, "handlers", {
  47. enumerable: true,
  48. configurable: true,
  49. writable: true,
  50. value: handlers
  51. });
  52. Object.defineProperty(this, "inheritableHandlers", {
  53. enumerable: true,
  54. configurable: true,
  55. writable: true,
  56. value: inheritableHandlers
  57. });
  58. Object.defineProperty(this, "tags", {
  59. enumerable: true,
  60. configurable: true,
  61. writable: true,
  62. value: tags
  63. });
  64. Object.defineProperty(this, "inheritableTags", {
  65. enumerable: true,
  66. configurable: true,
  67. writable: true,
  68. value: inheritableTags
  69. });
  70. Object.defineProperty(this, "metadata", {
  71. enumerable: true,
  72. configurable: true,
  73. writable: true,
  74. value: metadata
  75. });
  76. Object.defineProperty(this, "inheritableMetadata", {
  77. enumerable: true,
  78. configurable: true,
  79. writable: true,
  80. value: inheritableMetadata
  81. });
  82. Object.defineProperty(this, "_parentRunId", {
  83. enumerable: true,
  84. configurable: true,
  85. writable: true,
  86. value: _parentRunId
  87. });
  88. }
  89. get parentRunId() {
  90. return this._parentRunId;
  91. }
  92. async handleText(text) {
  93. await Promise.all(this.handlers.map((handler) => (0, promises_js_1.consumeCallback)(async () => {
  94. try {
  95. await handler.handleText?.(text, this.runId, this._parentRunId, this.tags);
  96. }
  97. catch (err) {
  98. const logFunction = handler.raiseError
  99. ? console.error
  100. : console.warn;
  101. logFunction(`Error in handler ${handler.constructor.name}, handleText: ${err}`);
  102. if (handler.raiseError) {
  103. throw err;
  104. }
  105. }
  106. }, handler.awaitHandlers)));
  107. }
  108. async handleCustomEvent(eventName,
  109. // eslint-disable-next-line @typescript-eslint/no-explicit-any
  110. data, _runId, _tags,
  111. // eslint-disable-next-line @typescript-eslint/no-explicit-any
  112. _metadata) {
  113. await Promise.all(this.handlers.map((handler) => (0, promises_js_1.consumeCallback)(async () => {
  114. try {
  115. await handler.handleCustomEvent?.(eventName, data, this.runId, this.tags, this.metadata);
  116. }
  117. catch (err) {
  118. const logFunction = handler.raiseError
  119. ? console.error
  120. : console.warn;
  121. logFunction(`Error in handler ${handler.constructor.name}, handleCustomEvent: ${err}`);
  122. if (handler.raiseError) {
  123. throw err;
  124. }
  125. }
  126. }, handler.awaitHandlers)));
  127. }
  128. }
  129. exports.BaseRunManager = BaseRunManager;
  130. /**
  131. * Manages callbacks for retriever runs.
  132. */
  133. class CallbackManagerForRetrieverRun extends BaseRunManager {
  134. getChild(tag) {
  135. // eslint-disable-next-line @typescript-eslint/no-use-before-define
  136. const manager = new CallbackManager(this.runId);
  137. manager.setHandlers(this.inheritableHandlers);
  138. manager.addTags(this.inheritableTags);
  139. manager.addMetadata(this.inheritableMetadata);
  140. if (tag) {
  141. manager.addTags([tag], false);
  142. }
  143. return manager;
  144. }
  145. async handleRetrieverEnd(documents) {
  146. await Promise.all(this.handlers.map((handler) => (0, promises_js_1.consumeCallback)(async () => {
  147. if (!handler.ignoreRetriever) {
  148. try {
  149. await handler.handleRetrieverEnd?.(documents, this.runId, this._parentRunId, this.tags);
  150. }
  151. catch (err) {
  152. const logFunction = handler.raiseError
  153. ? console.error
  154. : console.warn;
  155. logFunction(`Error in handler ${handler.constructor.name}, handleRetriever`);
  156. if (handler.raiseError) {
  157. throw err;
  158. }
  159. }
  160. }
  161. }, handler.awaitHandlers)));
  162. }
  163. async handleRetrieverError(err) {
  164. await Promise.all(this.handlers.map((handler) => (0, promises_js_1.consumeCallback)(async () => {
  165. if (!handler.ignoreRetriever) {
  166. try {
  167. await handler.handleRetrieverError?.(err, this.runId, this._parentRunId, this.tags);
  168. }
  169. catch (error) {
  170. const logFunction = handler.raiseError
  171. ? console.error
  172. : console.warn;
  173. logFunction(`Error in handler ${handler.constructor.name}, handleRetrieverError: ${error}`);
  174. if (handler.raiseError) {
  175. throw err;
  176. }
  177. }
  178. }
  179. }, handler.awaitHandlers)));
  180. }
  181. }
  182. exports.CallbackManagerForRetrieverRun = CallbackManagerForRetrieverRun;
  183. class CallbackManagerForLLMRun extends BaseRunManager {
  184. async handleLLMNewToken(token, idx, _runId, _parentRunId, _tags, fields) {
  185. await Promise.all(this.handlers.map((handler) => (0, promises_js_1.consumeCallback)(async () => {
  186. if (!handler.ignoreLLM) {
  187. try {
  188. await handler.handleLLMNewToken?.(token, idx ?? { prompt: 0, completion: 0 }, this.runId, this._parentRunId, this.tags, fields);
  189. }
  190. catch (err) {
  191. const logFunction = handler.raiseError
  192. ? console.error
  193. : console.warn;
  194. logFunction(`Error in handler ${handler.constructor.name}, handleLLMNewToken: ${err}`);
  195. if (handler.raiseError) {
  196. throw err;
  197. }
  198. }
  199. }
  200. }, handler.awaitHandlers)));
  201. }
  202. async handleLLMError(err, _runId, _parentRunId, _tags, extraParams) {
  203. await Promise.all(this.handlers.map((handler) => (0, promises_js_1.consumeCallback)(async () => {
  204. if (!handler.ignoreLLM) {
  205. try {
  206. await handler.handleLLMError?.(err, this.runId, this._parentRunId, this.tags, extraParams);
  207. }
  208. catch (err) {
  209. const logFunction = handler.raiseError
  210. ? console.error
  211. : console.warn;
  212. logFunction(`Error in handler ${handler.constructor.name}, handleLLMError: ${err}`);
  213. if (handler.raiseError) {
  214. throw err;
  215. }
  216. }
  217. }
  218. }, handler.awaitHandlers)));
  219. }
  220. async handleLLMEnd(output, _runId, _parentRunId, _tags, extraParams) {
  221. await Promise.all(this.handlers.map((handler) => (0, promises_js_1.consumeCallback)(async () => {
  222. if (!handler.ignoreLLM) {
  223. try {
  224. await handler.handleLLMEnd?.(output, this.runId, this._parentRunId, this.tags, extraParams);
  225. }
  226. catch (err) {
  227. const logFunction = handler.raiseError
  228. ? console.error
  229. : console.warn;
  230. logFunction(`Error in handler ${handler.constructor.name}, handleLLMEnd: ${err}`);
  231. if (handler.raiseError) {
  232. throw err;
  233. }
  234. }
  235. }
  236. }, handler.awaitHandlers)));
  237. }
  238. }
  239. exports.CallbackManagerForLLMRun = CallbackManagerForLLMRun;
  240. class CallbackManagerForChainRun extends BaseRunManager {
  241. getChild(tag) {
  242. // eslint-disable-next-line @typescript-eslint/no-use-before-define
  243. const manager = new CallbackManager(this.runId);
  244. manager.setHandlers(this.inheritableHandlers);
  245. manager.addTags(this.inheritableTags);
  246. manager.addMetadata(this.inheritableMetadata);
  247. if (tag) {
  248. manager.addTags([tag], false);
  249. }
  250. return manager;
  251. }
  252. async handleChainError(err, _runId, _parentRunId, _tags, kwargs) {
  253. await Promise.all(this.handlers.map((handler) => (0, promises_js_1.consumeCallback)(async () => {
  254. if (!handler.ignoreChain) {
  255. try {
  256. await handler.handleChainError?.(err, this.runId, this._parentRunId, this.tags, kwargs);
  257. }
  258. catch (err) {
  259. const logFunction = handler.raiseError
  260. ? console.error
  261. : console.warn;
  262. logFunction(`Error in handler ${handler.constructor.name}, handleChainError: ${err}`);
  263. if (handler.raiseError) {
  264. throw err;
  265. }
  266. }
  267. }
  268. }, handler.awaitHandlers)));
  269. }
  270. async handleChainEnd(output, _runId, _parentRunId, _tags, kwargs) {
  271. await Promise.all(this.handlers.map((handler) => (0, promises_js_1.consumeCallback)(async () => {
  272. if (!handler.ignoreChain) {
  273. try {
  274. await handler.handleChainEnd?.(output, this.runId, this._parentRunId, this.tags, kwargs);
  275. }
  276. catch (err) {
  277. const logFunction = handler.raiseError
  278. ? console.error
  279. : console.warn;
  280. logFunction(`Error in handler ${handler.constructor.name}, handleChainEnd: ${err}`);
  281. if (handler.raiseError) {
  282. throw err;
  283. }
  284. }
  285. }
  286. }, handler.awaitHandlers)));
  287. }
  288. async handleAgentAction(action) {
  289. await Promise.all(this.handlers.map((handler) => (0, promises_js_1.consumeCallback)(async () => {
  290. if (!handler.ignoreAgent) {
  291. try {
  292. await handler.handleAgentAction?.(action, this.runId, this._parentRunId, this.tags);
  293. }
  294. catch (err) {
  295. const logFunction = handler.raiseError
  296. ? console.error
  297. : console.warn;
  298. logFunction(`Error in handler ${handler.constructor.name}, handleAgentAction: ${err}`);
  299. if (handler.raiseError) {
  300. throw err;
  301. }
  302. }
  303. }
  304. }, handler.awaitHandlers)));
  305. }
  306. async handleAgentEnd(action) {
  307. await Promise.all(this.handlers.map((handler) => (0, promises_js_1.consumeCallback)(async () => {
  308. if (!handler.ignoreAgent) {
  309. try {
  310. await handler.handleAgentEnd?.(action, this.runId, this._parentRunId, this.tags);
  311. }
  312. catch (err) {
  313. const logFunction = handler.raiseError
  314. ? console.error
  315. : console.warn;
  316. logFunction(`Error in handler ${handler.constructor.name}, handleAgentEnd: ${err}`);
  317. if (handler.raiseError) {
  318. throw err;
  319. }
  320. }
  321. }
  322. }, handler.awaitHandlers)));
  323. }
  324. }
  325. exports.CallbackManagerForChainRun = CallbackManagerForChainRun;
  326. class CallbackManagerForToolRun extends BaseRunManager {
  327. getChild(tag) {
  328. // eslint-disable-next-line @typescript-eslint/no-use-before-define
  329. const manager = new CallbackManager(this.runId);
  330. manager.setHandlers(this.inheritableHandlers);
  331. manager.addTags(this.inheritableTags);
  332. manager.addMetadata(this.inheritableMetadata);
  333. if (tag) {
  334. manager.addTags([tag], false);
  335. }
  336. return manager;
  337. }
  338. async handleToolError(err) {
  339. await Promise.all(this.handlers.map((handler) => (0, promises_js_1.consumeCallback)(async () => {
  340. if (!handler.ignoreAgent) {
  341. try {
  342. await handler.handleToolError?.(err, this.runId, this._parentRunId, this.tags);
  343. }
  344. catch (err) {
  345. const logFunction = handler.raiseError
  346. ? console.error
  347. : console.warn;
  348. logFunction(`Error in handler ${handler.constructor.name}, handleToolError: ${err}`);
  349. if (handler.raiseError) {
  350. throw err;
  351. }
  352. }
  353. }
  354. }, handler.awaitHandlers)));
  355. }
  356. // eslint-disable-next-line @typescript-eslint/no-explicit-any
  357. async handleToolEnd(output) {
  358. await Promise.all(this.handlers.map((handler) => (0, promises_js_1.consumeCallback)(async () => {
  359. if (!handler.ignoreAgent) {
  360. try {
  361. await handler.handleToolEnd?.(output, this.runId, this._parentRunId, this.tags);
  362. }
  363. catch (err) {
  364. const logFunction = handler.raiseError
  365. ? console.error
  366. : console.warn;
  367. logFunction(`Error in handler ${handler.constructor.name}, handleToolEnd: ${err}`);
  368. if (handler.raiseError) {
  369. throw err;
  370. }
  371. }
  372. }
  373. }, handler.awaitHandlers)));
  374. }
  375. }
  376. exports.CallbackManagerForToolRun = CallbackManagerForToolRun;
  377. /**
  378. * @example
  379. * ```typescript
  380. * const prompt = PromptTemplate.fromTemplate("What is the answer to {question}?");
  381. *
  382. * // Example of using LLMChain with OpenAI and a simple prompt
  383. * const chain = new LLMChain({
  384. * llm: new ChatOpenAI({ temperature: 0.9 }),
  385. * prompt,
  386. * });
  387. *
  388. * // Running the chain with a single question
  389. * const result = await chain.call({
  390. * question: "What is the airspeed velocity of an unladen swallow?",
  391. * });
  392. * console.log("The answer is:", result);
  393. * ```
  394. */
  395. class CallbackManager extends BaseCallbackManager {
  396. constructor(parentRunId, options) {
  397. super();
  398. Object.defineProperty(this, "handlers", {
  399. enumerable: true,
  400. configurable: true,
  401. writable: true,
  402. value: []
  403. });
  404. Object.defineProperty(this, "inheritableHandlers", {
  405. enumerable: true,
  406. configurable: true,
  407. writable: true,
  408. value: []
  409. });
  410. Object.defineProperty(this, "tags", {
  411. enumerable: true,
  412. configurable: true,
  413. writable: true,
  414. value: []
  415. });
  416. Object.defineProperty(this, "inheritableTags", {
  417. enumerable: true,
  418. configurable: true,
  419. writable: true,
  420. value: []
  421. });
  422. Object.defineProperty(this, "metadata", {
  423. enumerable: true,
  424. configurable: true,
  425. writable: true,
  426. value: {}
  427. });
  428. Object.defineProperty(this, "inheritableMetadata", {
  429. enumerable: true,
  430. configurable: true,
  431. writable: true,
  432. value: {}
  433. });
  434. Object.defineProperty(this, "name", {
  435. enumerable: true,
  436. configurable: true,
  437. writable: true,
  438. value: "callback_manager"
  439. });
  440. Object.defineProperty(this, "_parentRunId", {
  441. enumerable: true,
  442. configurable: true,
  443. writable: true,
  444. value: void 0
  445. });
  446. this.handlers = options?.handlers ?? this.handlers;
  447. this.inheritableHandlers =
  448. options?.inheritableHandlers ?? this.inheritableHandlers;
  449. this.tags = options?.tags ?? this.tags;
  450. this.inheritableTags = options?.inheritableTags ?? this.inheritableTags;
  451. this.metadata = options?.metadata ?? this.metadata;
  452. this.inheritableMetadata =
  453. options?.inheritableMetadata ?? this.inheritableMetadata;
  454. this._parentRunId = parentRunId;
  455. }
  456. /**
  457. * Gets the parent run ID, if any.
  458. *
  459. * @returns The parent run ID.
  460. */
  461. getParentRunId() {
  462. return this._parentRunId;
  463. }
  464. async handleLLMStart(llm, prompts, runId = undefined, _parentRunId = undefined, extraParams = undefined, _tags = undefined, _metadata = undefined, runName = undefined) {
  465. return Promise.all(prompts.map(async (prompt, idx) => {
  466. // Can't have duplicate runs with the same run ID (if provided)
  467. const runId_ = idx === 0 && runId ? runId : (0, uuid_1.v4)();
  468. await Promise.all(this.handlers.map((handler) => {
  469. if (handler.ignoreLLM) {
  470. return;
  471. }
  472. if ((0, base_js_2.isBaseTracer)(handler)) {
  473. // Create and add run to the run map.
  474. // We do this synchronously to avoid race conditions
  475. // when callbacks are backgrounded.
  476. handler._createRunForLLMStart(llm, [prompt], runId_, this._parentRunId, extraParams, this.tags, this.metadata, runName);
  477. }
  478. return (0, promises_js_1.consumeCallback)(async () => {
  479. try {
  480. await handler.handleLLMStart?.(llm, [prompt], runId_, this._parentRunId, extraParams, this.tags, this.metadata, runName);
  481. }
  482. catch (err) {
  483. const logFunction = handler.raiseError
  484. ? console.error
  485. : console.warn;
  486. logFunction(`Error in handler ${handler.constructor.name}, handleLLMStart: ${err}`);
  487. if (handler.raiseError) {
  488. throw err;
  489. }
  490. }
  491. }, handler.awaitHandlers);
  492. }));
  493. return new CallbackManagerForLLMRun(runId_, this.handlers, this.inheritableHandlers, this.tags, this.inheritableTags, this.metadata, this.inheritableMetadata, this._parentRunId);
  494. }));
  495. }
  496. async handleChatModelStart(llm, messages, runId = undefined, _parentRunId = undefined, extraParams = undefined, _tags = undefined, _metadata = undefined, runName = undefined) {
  497. return Promise.all(messages.map(async (messageGroup, idx) => {
  498. // Can't have duplicate runs with the same run ID (if provided)
  499. const runId_ = idx === 0 && runId ? runId : (0, uuid_1.v4)();
  500. await Promise.all(this.handlers.map((handler) => {
  501. if (handler.ignoreLLM) {
  502. return;
  503. }
  504. if ((0, base_js_2.isBaseTracer)(handler)) {
  505. // Create and add run to the run map.
  506. // We do this synchronously to avoid race conditions
  507. // when callbacks are backgrounded.
  508. handler._createRunForChatModelStart(llm, [messageGroup], runId_, this._parentRunId, extraParams, this.tags, this.metadata, runName);
  509. }
  510. return (0, promises_js_1.consumeCallback)(async () => {
  511. try {
  512. if (handler.handleChatModelStart) {
  513. await handler.handleChatModelStart?.(llm, [messageGroup], runId_, this._parentRunId, extraParams, this.tags, this.metadata, runName);
  514. }
  515. else if (handler.handleLLMStart) {
  516. const messageString = (0, utils_js_1.getBufferString)(messageGroup);
  517. await handler.handleLLMStart?.(llm, [messageString], runId_, this._parentRunId, extraParams, this.tags, this.metadata, runName);
  518. }
  519. }
  520. catch (err) {
  521. const logFunction = handler.raiseError
  522. ? console.error
  523. : console.warn;
  524. logFunction(`Error in handler ${handler.constructor.name}, handleLLMStart: ${err}`);
  525. if (handler.raiseError) {
  526. throw err;
  527. }
  528. }
  529. }, handler.awaitHandlers);
  530. }));
  531. return new CallbackManagerForLLMRun(runId_, this.handlers, this.inheritableHandlers, this.tags, this.inheritableTags, this.metadata, this.inheritableMetadata, this._parentRunId);
  532. }));
  533. }
  534. async handleChainStart(chain, inputs, runId = (0, uuid_1.v4)(), runType = undefined, _tags = undefined, _metadata = undefined, runName = undefined) {
  535. await Promise.all(this.handlers.map((handler) => {
  536. if (handler.ignoreChain) {
  537. return;
  538. }
  539. if ((0, base_js_2.isBaseTracer)(handler)) {
  540. // Create and add run to the run map.
  541. // We do this synchronously to avoid race conditions
  542. // when callbacks are backgrounded.
  543. handler._createRunForChainStart(chain, inputs, runId, this._parentRunId, this.tags, this.metadata, runType, runName);
  544. }
  545. return (0, promises_js_1.consumeCallback)(async () => {
  546. try {
  547. await handler.handleChainStart?.(chain, inputs, runId, this._parentRunId, this.tags, this.metadata, runType, runName);
  548. }
  549. catch (err) {
  550. const logFunction = handler.raiseError
  551. ? console.error
  552. : console.warn;
  553. logFunction(`Error in handler ${handler.constructor.name}, handleChainStart: ${err}`);
  554. if (handler.raiseError) {
  555. throw err;
  556. }
  557. }
  558. }, handler.awaitHandlers);
  559. }));
  560. return new CallbackManagerForChainRun(runId, this.handlers, this.inheritableHandlers, this.tags, this.inheritableTags, this.metadata, this.inheritableMetadata, this._parentRunId);
  561. }
  562. async handleToolStart(tool, input, runId = (0, uuid_1.v4)(), _parentRunId = undefined, _tags = undefined, _metadata = undefined, runName = undefined) {
  563. await Promise.all(this.handlers.map((handler) => {
  564. if (handler.ignoreAgent) {
  565. return;
  566. }
  567. if ((0, base_js_2.isBaseTracer)(handler)) {
  568. // Create and add run to the run map.
  569. // We do this synchronously to avoid race conditions
  570. // when callbacks are backgrounded.
  571. handler._createRunForToolStart(tool, input, runId, this._parentRunId, this.tags, this.metadata, runName);
  572. }
  573. return (0, promises_js_1.consumeCallback)(async () => {
  574. try {
  575. await handler.handleToolStart?.(tool, input, runId, this._parentRunId, this.tags, this.metadata, runName);
  576. }
  577. catch (err) {
  578. const logFunction = handler.raiseError
  579. ? console.error
  580. : console.warn;
  581. logFunction(`Error in handler ${handler.constructor.name}, handleToolStart: ${err}`);
  582. if (handler.raiseError) {
  583. throw err;
  584. }
  585. }
  586. }, handler.awaitHandlers);
  587. }));
  588. return new CallbackManagerForToolRun(runId, this.handlers, this.inheritableHandlers, this.tags, this.inheritableTags, this.metadata, this.inheritableMetadata, this._parentRunId);
  589. }
  590. async handleRetrieverStart(retriever, query, runId = (0, uuid_1.v4)(), _parentRunId = undefined, _tags = undefined, _metadata = undefined, runName = undefined) {
  591. await Promise.all(this.handlers.map((handler) => {
  592. if (handler.ignoreRetriever) {
  593. return;
  594. }
  595. if ((0, base_js_2.isBaseTracer)(handler)) {
  596. // Create and add run to the run map.
  597. // We do this synchronously to avoid race conditions
  598. // when callbacks are backgrounded.
  599. handler._createRunForRetrieverStart(retriever, query, runId, this._parentRunId, this.tags, this.metadata, runName);
  600. }
  601. return (0, promises_js_1.consumeCallback)(async () => {
  602. try {
  603. await handler.handleRetrieverStart?.(retriever, query, runId, this._parentRunId, this.tags, this.metadata, runName);
  604. }
  605. catch (err) {
  606. const logFunction = handler.raiseError
  607. ? console.error
  608. : console.warn;
  609. logFunction(`Error in handler ${handler.constructor.name}, handleRetrieverStart: ${err}`);
  610. if (handler.raiseError) {
  611. throw err;
  612. }
  613. }
  614. }, handler.awaitHandlers);
  615. }));
  616. return new CallbackManagerForRetrieverRun(runId, this.handlers, this.inheritableHandlers, this.tags, this.inheritableTags, this.metadata, this.inheritableMetadata, this._parentRunId);
  617. }
  618. async handleCustomEvent(eventName,
  619. // eslint-disable-next-line @typescript-eslint/no-explicit-any
  620. data, runId, _tags,
  621. // eslint-disable-next-line @typescript-eslint/no-explicit-any
  622. _metadata) {
  623. await Promise.all(this.handlers.map((handler) => (0, promises_js_1.consumeCallback)(async () => {
  624. if (!handler.ignoreCustomEvent) {
  625. try {
  626. await handler.handleCustomEvent?.(eventName, data, runId, this.tags, this.metadata);
  627. }
  628. catch (err) {
  629. const logFunction = handler.raiseError
  630. ? console.error
  631. : console.warn;
  632. logFunction(`Error in handler ${handler.constructor.name}, handleCustomEvent: ${err}`);
  633. if (handler.raiseError) {
  634. throw err;
  635. }
  636. }
  637. }
  638. }, handler.awaitHandlers)));
  639. }
  640. addHandler(handler, inherit = true) {
  641. this.handlers.push(handler);
  642. if (inherit) {
  643. this.inheritableHandlers.push(handler);
  644. }
  645. }
  646. removeHandler(handler) {
  647. this.handlers = this.handlers.filter((_handler) => _handler !== handler);
  648. this.inheritableHandlers = this.inheritableHandlers.filter((_handler) => _handler !== handler);
  649. }
  650. setHandlers(handlers, inherit = true) {
  651. this.handlers = [];
  652. this.inheritableHandlers = [];
  653. for (const handler of handlers) {
  654. this.addHandler(handler, inherit);
  655. }
  656. }
  657. addTags(tags, inherit = true) {
  658. this.removeTags(tags); // Remove duplicates
  659. this.tags.push(...tags);
  660. if (inherit) {
  661. this.inheritableTags.push(...tags);
  662. }
  663. }
  664. removeTags(tags) {
  665. this.tags = this.tags.filter((tag) => !tags.includes(tag));
  666. this.inheritableTags = this.inheritableTags.filter((tag) => !tags.includes(tag));
  667. }
  668. addMetadata(metadata, inherit = true) {
  669. this.metadata = { ...this.metadata, ...metadata };
  670. if (inherit) {
  671. this.inheritableMetadata = { ...this.inheritableMetadata, ...metadata };
  672. }
  673. }
  674. removeMetadata(metadata) {
  675. for (const key of Object.keys(metadata)) {
  676. delete this.metadata[key];
  677. delete this.inheritableMetadata[key];
  678. }
  679. }
  680. copy(additionalHandlers = [], inherit = true) {
  681. const manager = new CallbackManager(this._parentRunId);
  682. for (const handler of this.handlers) {
  683. const inheritable = this.inheritableHandlers.includes(handler);
  684. manager.addHandler(handler, inheritable);
  685. }
  686. for (const tag of this.tags) {
  687. const inheritable = this.inheritableTags.includes(tag);
  688. manager.addTags([tag], inheritable);
  689. }
  690. for (const key of Object.keys(this.metadata)) {
  691. const inheritable = Object.keys(this.inheritableMetadata).includes(key);
  692. manager.addMetadata({ [key]: this.metadata[key] }, inheritable);
  693. }
  694. for (const handler of additionalHandlers) {
  695. if (
  696. // Prevent multiple copies of console_callback_handler
  697. manager.handlers
  698. .filter((h) => h.name === "console_callback_handler")
  699. .some((h) => h.name === handler.name)) {
  700. continue;
  701. }
  702. manager.addHandler(handler, inherit);
  703. }
  704. return manager;
  705. }
  706. static fromHandlers(handlers) {
  707. class Handler extends base_js_1.BaseCallbackHandler {
  708. constructor() {
  709. super();
  710. Object.defineProperty(this, "name", {
  711. enumerable: true,
  712. configurable: true,
  713. writable: true,
  714. value: (0, uuid_1.v4)()
  715. });
  716. Object.assign(this, handlers);
  717. }
  718. }
  719. const manager = new this();
  720. manager.addHandler(new Handler());
  721. return manager;
  722. }
  723. static configure(inheritableHandlers, localHandlers, inheritableTags, localTags, inheritableMetadata, localMetadata, options) {
  724. return this._configureSync(inheritableHandlers, localHandlers, inheritableTags, localTags, inheritableMetadata, localMetadata, options);
  725. }
  726. // TODO: Deprecate async method in favor of this one.
  727. static _configureSync(inheritableHandlers, localHandlers, inheritableTags, localTags, inheritableMetadata, localMetadata, options) {
  728. let callbackManager;
  729. if (inheritableHandlers || localHandlers) {
  730. if (Array.isArray(inheritableHandlers) || !inheritableHandlers) {
  731. callbackManager = new CallbackManager();
  732. callbackManager.setHandlers(inheritableHandlers?.map(ensureHandler) ?? [], true);
  733. }
  734. else {
  735. callbackManager = inheritableHandlers;
  736. }
  737. callbackManager = callbackManager.copy(Array.isArray(localHandlers)
  738. ? localHandlers.map(ensureHandler)
  739. : localHandlers?.handlers, false);
  740. }
  741. const verboseEnabled = (0, env_js_1.getEnvironmentVariable)("LANGCHAIN_VERBOSE") === "true" ||
  742. options?.verbose;
  743. const tracingV2Enabled = tracer_langchain_js_1.LangChainTracer.getTraceableRunTree()?.tracingEnabled ||
  744. (0, callbacks_js_1.isTracingEnabled)();
  745. const tracingEnabled = tracingV2Enabled ||
  746. ((0, env_js_1.getEnvironmentVariable)("LANGCHAIN_TRACING") ?? false);
  747. if (verboseEnabled || tracingEnabled) {
  748. if (!callbackManager) {
  749. callbackManager = new CallbackManager();
  750. }
  751. if (verboseEnabled &&
  752. !callbackManager.handlers.some((handler) => handler.name === console_js_1.ConsoleCallbackHandler.prototype.name)) {
  753. const consoleHandler = new console_js_1.ConsoleCallbackHandler();
  754. callbackManager.addHandler(consoleHandler, true);
  755. }
  756. if (tracingEnabled &&
  757. !callbackManager.handlers.some((handler) => handler.name === "langchain_tracer")) {
  758. if (tracingV2Enabled) {
  759. const tracerV2 = new tracer_langchain_js_1.LangChainTracer();
  760. callbackManager.addHandler(tracerV2, true);
  761. // handoff between langchain and langsmith/traceable
  762. // override the parent run ID
  763. callbackManager._parentRunId =
  764. tracer_langchain_js_1.LangChainTracer.getTraceableRunTree()?.id ??
  765. callbackManager._parentRunId;
  766. }
  767. }
  768. }
  769. for (const { contextVar, inheritable = true, handlerClass, envVar, } of (0, context_js_1._getConfigureHooks)()) {
  770. const createIfNotInContext = envVar && (0, env_js_1.getEnvironmentVariable)(envVar) === "true" && handlerClass;
  771. let handler;
  772. const contextVarValue = contextVar !== undefined ? (0, context_js_1.getContextVariable)(contextVar) : undefined;
  773. if (contextVarValue && (0, base_js_1.isBaseCallbackHandler)(contextVarValue)) {
  774. handler = contextVarValue;
  775. }
  776. else if (createIfNotInContext) {
  777. // eslint-disable-next-line @typescript-eslint/no-explicit-any
  778. handler = new handlerClass({});
  779. }
  780. if (handler !== undefined) {
  781. if (!callbackManager) {
  782. callbackManager = new CallbackManager();
  783. }
  784. if (!callbackManager.handlers.some((h) => h.name === handler.name)) {
  785. callbackManager.addHandler(handler, inheritable);
  786. }
  787. }
  788. }
  789. if (inheritableTags || localTags) {
  790. if (callbackManager) {
  791. callbackManager.addTags(inheritableTags ?? []);
  792. callbackManager.addTags(localTags ?? [], false);
  793. }
  794. }
  795. if (inheritableMetadata || localMetadata) {
  796. if (callbackManager) {
  797. callbackManager.addMetadata(inheritableMetadata ?? {});
  798. callbackManager.addMetadata(localMetadata ?? {}, false);
  799. }
  800. }
  801. return callbackManager;
  802. }
  803. }
  804. exports.CallbackManager = CallbackManager;
  805. function ensureHandler(handler) {
  806. if ("name" in handler) {
  807. return handler;
  808. }
  809. return base_js_1.BaseCallbackHandler.fromMethods(handler);
  810. }
  811. exports.ensureHandler = ensureHandler;
  812. /**
  813. * @deprecated Use [`traceable`](https://docs.smith.langchain.com/observability/how_to_guides/tracing/annotate_code)
  814. * from "langsmith" instead.
  815. */
  816. class TraceGroup {
  817. constructor(groupName, options) {
  818. Object.defineProperty(this, "groupName", {
  819. enumerable: true,
  820. configurable: true,
  821. writable: true,
  822. value: groupName
  823. });
  824. Object.defineProperty(this, "options", {
  825. enumerable: true,
  826. configurable: true,
  827. writable: true,
  828. value: options
  829. });
  830. Object.defineProperty(this, "runManager", {
  831. enumerable: true,
  832. configurable: true,
  833. writable: true,
  834. value: void 0
  835. });
  836. }
  837. async getTraceGroupCallbackManager(group_name, inputs, options) {
  838. const cb = new tracer_langchain_js_1.LangChainTracer(options);
  839. const cm = await CallbackManager.configure([cb]);
  840. const runManager = await cm?.handleChainStart({
  841. lc: 1,
  842. type: "not_implemented",
  843. id: ["langchain", "callbacks", "groups", group_name],
  844. }, inputs ?? {});
  845. if (!runManager) {
  846. throw new Error("Failed to create run group callback manager.");
  847. }
  848. return runManager;
  849. }
  850. async start(inputs) {
  851. if (!this.runManager) {
  852. this.runManager = await this.getTraceGroupCallbackManager(this.groupName, inputs, this.options);
  853. }
  854. return this.runManager.getChild();
  855. }
  856. async error(err) {
  857. if (this.runManager) {
  858. await this.runManager.handleChainError(err);
  859. this.runManager = undefined;
  860. }
  861. }
  862. async end(output) {
  863. if (this.runManager) {
  864. await this.runManager.handleChainEnd(output ?? {});
  865. this.runManager = undefined;
  866. }
  867. }
  868. }
  869. exports.TraceGroup = TraceGroup;
  870. // eslint-disable-next-line @typescript-eslint/no-explicit-any
  871. function _coerceToDict(value, defaultKey) {
  872. return value && !Array.isArray(value) && typeof value === "object"
  873. ? value
  874. : { [defaultKey]: value };
  875. }
  876. // eslint-disable-next-line @typescript-eslint/no-explicit-any
  877. async function traceAsGroup(groupOptions, enclosedCode, ...args) {
  878. const traceGroup = new TraceGroup(groupOptions.name, groupOptions);
  879. const callbackManager = await traceGroup.start({ ...args });
  880. try {
  881. const result = await enclosedCode(callbackManager, ...args);
  882. await traceGroup.end(_coerceToDict(result, "output"));
  883. return result;
  884. }
  885. catch (err) {
  886. await traceGroup.error(err);
  887. throw err;
  888. }
  889. }
  890. exports.traceAsGroup = traceAsGroup;