langchain 0.0.192 → 0.0.194

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.
Files changed (486) hide show
  1. package/dist/agents/agent.cjs +24 -0
  2. package/dist/agents/agent.d.ts +24 -0
  3. package/dist/agents/agent.js +24 -0
  4. package/dist/agents/chat/outputParser.cjs +32 -0
  5. package/dist/agents/chat/outputParser.d.ts +32 -0
  6. package/dist/agents/chat/outputParser.js +32 -0
  7. package/dist/agents/executor.cjs +14 -0
  8. package/dist/agents/executor.d.ts +14 -0
  9. package/dist/agents/executor.js +14 -0
  10. package/dist/agents/mrkl/index.cjs +21 -0
  11. package/dist/agents/mrkl/index.d.ts +21 -0
  12. package/dist/agents/mrkl/index.js +21 -0
  13. package/dist/agents/openai/output_parser.cjs +65 -0
  14. package/dist/agents/openai/output_parser.d.ts +65 -0
  15. package/dist/agents/openai/output_parser.js +65 -0
  16. package/dist/agents/react/output_parser.cjs +16 -0
  17. package/dist/agents/react/output_parser.d.ts +16 -0
  18. package/dist/agents/react/output_parser.js +16 -0
  19. package/dist/agents/structured_chat/outputParser.cjs +12 -0
  20. package/dist/agents/structured_chat/outputParser.d.ts +12 -0
  21. package/dist/agents/structured_chat/outputParser.js +12 -0
  22. package/dist/agents/toolkits/aws_sfn.cjs +20 -0
  23. package/dist/agents/toolkits/aws_sfn.d.ts +20 -0
  24. package/dist/agents/toolkits/aws_sfn.js +20 -0
  25. package/dist/agents/toolkits/json/json.cjs +8 -0
  26. package/dist/agents/toolkits/json/json.d.ts +8 -0
  27. package/dist/agents/toolkits/json/json.js +8 -0
  28. package/dist/agents/toolkits/openapi/openapi.cjs +18 -0
  29. package/dist/agents/toolkits/openapi/openapi.d.ts +18 -0
  30. package/dist/agents/toolkits/openapi/openapi.js +18 -0
  31. package/dist/agents/toolkits/sql/sql.cjs +8 -0
  32. package/dist/agents/toolkits/sql/sql.d.ts +8 -0
  33. package/dist/agents/toolkits/sql/sql.js +8 -0
  34. package/dist/agents/toolkits/vectorstore/vectorstore.cjs +16 -0
  35. package/dist/agents/toolkits/vectorstore/vectorstore.d.ts +16 -0
  36. package/dist/agents/toolkits/vectorstore/vectorstore.js +16 -0
  37. package/dist/agents/toolkits/zapier/zapier.cjs +10 -0
  38. package/dist/agents/toolkits/zapier/zapier.d.ts +10 -0
  39. package/dist/agents/toolkits/zapier/zapier.js +10 -0
  40. package/dist/agents/xml/output_parser.cjs +21 -0
  41. package/dist/agents/xml/output_parser.d.ts +21 -0
  42. package/dist/agents/xml/output_parser.js +21 -0
  43. package/dist/cache/cloudflare_kv.cjs +13 -0
  44. package/dist/cache/cloudflare_kv.d.ts +13 -0
  45. package/dist/cache/cloudflare_kv.js +13 -0
  46. package/dist/cache/ioredis.cjs +13 -0
  47. package/dist/cache/ioredis.d.ts +13 -0
  48. package/dist/cache/ioredis.js +13 -0
  49. package/dist/cache/momento.cjs +19 -0
  50. package/dist/cache/momento.d.ts +19 -0
  51. package/dist/cache/momento.js +19 -0
  52. package/dist/cache/redis.cjs +10 -0
  53. package/dist/cache/redis.d.ts +10 -0
  54. package/dist/cache/redis.js +10 -0
  55. package/dist/cache/upstash_redis.cjs +15 -0
  56. package/dist/cache/upstash_redis.d.ts +15 -0
  57. package/dist/cache/upstash_redis.js +15 -0
  58. package/dist/callbacks/handlers/console.cjs +10 -0
  59. package/dist/callbacks/handlers/console.d.ts +10 -0
  60. package/dist/callbacks/handlers/console.js +10 -0
  61. package/dist/callbacks/manager.cjs +49 -0
  62. package/dist/callbacks/manager.d.ts +49 -0
  63. package/dist/callbacks/manager.js +49 -0
  64. package/dist/chains/analyze_documents_chain.cjs +18 -0
  65. package/dist/chains/analyze_documents_chain.d.ts +18 -0
  66. package/dist/chains/analyze_documents_chain.js +18 -0
  67. package/dist/chains/constitutional_ai/constitutional_chain.cjs +21 -0
  68. package/dist/chains/constitutional_ai/constitutional_chain.d.ts +21 -0
  69. package/dist/chains/constitutional_ai/constitutional_chain.js +21 -0
  70. package/dist/chains/constitutional_ai/constitutional_principle.cjs +21 -0
  71. package/dist/chains/constitutional_ai/constitutional_principle.d.ts +21 -0
  72. package/dist/chains/constitutional_ai/constitutional_principle.js +21 -0
  73. package/dist/chains/conversation.cjs +13 -0
  74. package/dist/chains/conversation.d.ts +13 -0
  75. package/dist/chains/conversation.js +13 -0
  76. package/dist/chains/conversational_retrieval_chain.cjs +29 -0
  77. package/dist/chains/conversational_retrieval_chain.d.ts +29 -0
  78. package/dist/chains/conversational_retrieval_chain.js +29 -0
  79. package/dist/chains/graph_qa/cypher.cjs +10 -0
  80. package/dist/chains/graph_qa/cypher.d.ts +10 -0
  81. package/dist/chains/graph_qa/cypher.js +10 -0
  82. package/dist/chains/openai_moderation.cjs +28 -0
  83. package/dist/chains/openai_moderation.d.ts +28 -0
  84. package/dist/chains/openai_moderation.js +28 -0
  85. package/dist/chains/retrieval_qa.cjs +21 -0
  86. package/dist/chains/retrieval_qa.d.ts +21 -0
  87. package/dist/chains/retrieval_qa.js +21 -0
  88. package/dist/chains/router/multi_prompt.cjs +19 -0
  89. package/dist/chains/router/multi_prompt.d.ts +19 -0
  90. package/dist/chains/router/multi_prompt.js +19 -0
  91. package/dist/chains/router/multi_retrieval_qa.cjs +29 -0
  92. package/dist/chains/router/multi_retrieval_qa.d.ts +29 -0
  93. package/dist/chains/router/multi_retrieval_qa.js +29 -0
  94. package/dist/chains/sequential_chain.cjs +43 -0
  95. package/dist/chains/sequential_chain.d.ts +43 -0
  96. package/dist/chains/sequential_chain.js +43 -0
  97. package/dist/chains/sql_db/sql_db_chain.cjs +9 -0
  98. package/dist/chains/sql_db/sql_db_chain.d.ts +9 -0
  99. package/dist/chains/sql_db/sql_db_chain.js +9 -0
  100. package/dist/chat_models/anthropic.cjs +9 -1
  101. package/dist/chat_models/anthropic.d.ts +9 -1
  102. package/dist/chat_models/anthropic.js +9 -1
  103. package/dist/chat_models/baiduwenxin.cjs +20 -0
  104. package/dist/chat_models/baiduwenxin.d.ts +20 -0
  105. package/dist/chat_models/baiduwenxin.js +20 -0
  106. package/dist/chat_models/base.cjs +2 -0
  107. package/dist/chat_models/base.d.ts +1 -1
  108. package/dist/chat_models/base.js +2 -0
  109. package/dist/chat_models/bedrock/index.cjs +11 -0
  110. package/dist/chat_models/bedrock/index.d.ts +11 -0
  111. package/dist/chat_models/bedrock/index.js +11 -0
  112. package/dist/chat_models/bedrock/web.cjs +9 -0
  113. package/dist/chat_models/bedrock/web.d.ts +9 -0
  114. package/dist/chat_models/bedrock/web.js +9 -0
  115. package/dist/chat_models/cloudflare_workersai.cjs +15 -0
  116. package/dist/chat_models/cloudflare_workersai.d.ts +15 -0
  117. package/dist/chat_models/cloudflare_workersai.js +15 -0
  118. package/dist/chat_models/fake.cjs +16 -0
  119. package/dist/chat_models/fake.d.ts +16 -0
  120. package/dist/chat_models/fake.js +16 -0
  121. package/dist/chat_models/fireworks.cjs +10 -0
  122. package/dist/chat_models/fireworks.d.ts +10 -0
  123. package/dist/chat_models/fireworks.js +10 -0
  124. package/dist/chat_models/googlepalm.cjs +24 -0
  125. package/dist/chat_models/googlepalm.d.ts +24 -0
  126. package/dist/chat_models/googlepalm.js +24 -0
  127. package/dist/chat_models/googlevertexai/index.cjs +7 -0
  128. package/dist/chat_models/googlevertexai/index.d.ts +7 -0
  129. package/dist/chat_models/googlevertexai/index.js +7 -0
  130. package/dist/chat_models/googlevertexai/web.cjs +9 -0
  131. package/dist/chat_models/googlevertexai/web.d.ts +9 -0
  132. package/dist/chat_models/googlevertexai/web.js +9 -0
  133. package/dist/chat_models/iflytek_xinghuo/index.cjs +8 -0
  134. package/dist/chat_models/iflytek_xinghuo/index.d.ts +8 -0
  135. package/dist/chat_models/iflytek_xinghuo/index.js +8 -0
  136. package/dist/chat_models/iflytek_xinghuo/web.cjs +8 -0
  137. package/dist/chat_models/iflytek_xinghuo/web.d.ts +8 -0
  138. package/dist/chat_models/iflytek_xinghuo/web.js +8 -0
  139. package/dist/chat_models/llama_cpp.cjs +17 -0
  140. package/dist/chat_models/llama_cpp.d.ts +17 -0
  141. package/dist/chat_models/llama_cpp.js +17 -0
  142. package/dist/chat_models/minimax.cjs +27 -0
  143. package/dist/chat_models/minimax.d.ts +27 -0
  144. package/dist/chat_models/minimax.js +27 -0
  145. package/dist/chat_models/ollama.cjs +24 -0
  146. package/dist/chat_models/ollama.d.ts +24 -0
  147. package/dist/chat_models/ollama.js +24 -0
  148. package/dist/chat_models/openai.cjs +15 -0
  149. package/dist/chat_models/openai.d.ts +15 -0
  150. package/dist/chat_models/openai.js +15 -0
  151. package/dist/chat_models/yandex.cjs +14 -0
  152. package/dist/chat_models/yandex.d.ts +14 -0
  153. package/dist/chat_models/yandex.js +14 -0
  154. package/dist/document_loaders/fs/directory.cjs +14 -0
  155. package/dist/document_loaders/fs/directory.d.ts +14 -0
  156. package/dist/document_loaders/fs/directory.js +14 -0
  157. package/dist/document_loaders/fs/openai_whisper_audio.cjs +10 -0
  158. package/dist/document_loaders/fs/openai_whisper_audio.d.ts +10 -0
  159. package/dist/document_loaders/fs/openai_whisper_audio.js +10 -0
  160. package/dist/document_loaders/fs/pdf.cjs +6 -0
  161. package/dist/document_loaders/fs/pdf.d.ts +6 -0
  162. package/dist/document_loaders/fs/pdf.js +6 -0
  163. package/dist/document_loaders/fs/srt.cjs +6 -0
  164. package/dist/document_loaders/fs/srt.d.ts +6 -0
  165. package/dist/document_loaders/fs/srt.js +6 -0
  166. package/dist/document_loaders/fs/text.cjs +5 -0
  167. package/dist/document_loaders/fs/text.d.ts +5 -0
  168. package/dist/document_loaders/fs/text.js +5 -0
  169. package/dist/document_loaders/fs/unstructured.cjs +7 -0
  170. package/dist/document_loaders/fs/unstructured.d.ts +7 -0
  171. package/dist/document_loaders/fs/unstructured.js +7 -0
  172. package/dist/document_loaders/web/apify_dataset.cjs +21 -0
  173. package/dist/document_loaders/web/apify_dataset.d.ts +21 -0
  174. package/dist/document_loaders/web/apify_dataset.js +21 -0
  175. package/dist/document_loaders/web/assemblyai.cjs +24 -0
  176. package/dist/document_loaders/web/assemblyai.d.ts +24 -0
  177. package/dist/document_loaders/web/assemblyai.js +24 -0
  178. package/dist/document_loaders/web/azure_blob_storage_file.cjs +11 -0
  179. package/dist/document_loaders/web/azure_blob_storage_file.d.ts +11 -0
  180. package/dist/document_loaders/web/azure_blob_storage_file.js +11 -0
  181. package/dist/document_loaders/web/cheerio.cjs +6 -0
  182. package/dist/document_loaders/web/cheerio.d.ts +6 -0
  183. package/dist/document_loaders/web/cheerio.js +6 -0
  184. package/dist/document_loaders/web/college_confidential.cjs +6 -0
  185. package/dist/document_loaders/web/college_confidential.d.ts +6 -0
  186. package/dist/document_loaders/web/college_confidential.js +6 -0
  187. package/dist/document_loaders/web/confluence.cjs +11 -0
  188. package/dist/document_loaders/web/confluence.d.ts +11 -0
  189. package/dist/document_loaders/web/confluence.js +11 -0
  190. package/dist/document_loaders/web/figma.cjs +9 -0
  191. package/dist/document_loaders/web/figma.d.ts +9 -0
  192. package/dist/document_loaders/web/figma.js +9 -0
  193. package/dist/document_loaders/web/notionapi.cjs +16 -0
  194. package/dist/document_loaders/web/notionapi.d.ts +16 -0
  195. package/dist/document_loaders/web/notionapi.js +16 -0
  196. package/dist/document_loaders/web/notiondb.cjs +11 -1
  197. package/dist/document_loaders/web/notiondb.d.ts +11 -1
  198. package/dist/document_loaders/web/notiondb.js +11 -1
  199. package/dist/document_loaders/web/pdf.cjs +6 -0
  200. package/dist/document_loaders/web/pdf.d.ts +6 -0
  201. package/dist/document_loaders/web/pdf.js +6 -0
  202. package/dist/document_loaders/web/puppeteer.cjs +12 -0
  203. package/dist/document_loaders/web/puppeteer.d.ts +12 -0
  204. package/dist/document_loaders/web/puppeteer.js +12 -0
  205. package/dist/document_loaders/web/s3.cjs +17 -0
  206. package/dist/document_loaders/web/s3.d.ts +17 -0
  207. package/dist/document_loaders/web/s3.js +17 -0
  208. package/dist/document_loaders/web/searchapi.cjs +9 -0
  209. package/dist/document_loaders/web/searchapi.d.ts +9 -0
  210. package/dist/document_loaders/web/searchapi.js +9 -0
  211. package/dist/document_loaders/web/serpapi.cjs +5 -0
  212. package/dist/document_loaders/web/serpapi.d.ts +5 -0
  213. package/dist/document_loaders/web/serpapi.js +5 -0
  214. package/dist/document_loaders/web/sonix_audio.cjs +12 -0
  215. package/dist/document_loaders/web/sonix_audio.d.ts +12 -0
  216. package/dist/document_loaders/web/sonix_audio.js +12 -0
  217. package/dist/document_loaders/web/sort_xyz_blockchain.cjs +22 -0
  218. package/dist/document_loaders/web/sort_xyz_blockchain.d.ts +22 -0
  219. package/dist/document_loaders/web/sort_xyz_blockchain.js +22 -0
  220. package/dist/document_loaders/web/youtube.cjs +9 -0
  221. package/dist/document_loaders/web/youtube.d.ts +9 -0
  222. package/dist/document_loaders/web/youtube.js +9 -0
  223. package/dist/document_transformers/html_to_text.cjs +18 -0
  224. package/dist/document_transformers/html_to_text.d.ts +18 -0
  225. package/dist/document_transformers/html_to_text.js +18 -0
  226. package/dist/document_transformers/mozilla_readability.cjs +18 -0
  227. package/dist/document_transformers/mozilla_readability.d.ts +18 -0
  228. package/dist/document_transformers/mozilla_readability.js +18 -0
  229. package/dist/embeddings/bedrock.cjs +17 -0
  230. package/dist/embeddings/bedrock.d.ts +17 -0
  231. package/dist/embeddings/bedrock.js +17 -0
  232. package/dist/embeddings/cache_backed.cjs +37 -0
  233. package/dist/embeddings/cache_backed.d.ts +37 -0
  234. package/dist/embeddings/cache_backed.js +37 -0
  235. package/dist/embeddings/cohere.cjs +10 -0
  236. package/dist/embeddings/cohere.d.ts +10 -0
  237. package/dist/embeddings/cohere.js +10 -0
  238. package/dist/embeddings/googlepalm.cjs +17 -0
  239. package/dist/embeddings/googlepalm.d.ts +17 -0
  240. package/dist/embeddings/googlepalm.js +17 -0
  241. package/dist/embeddings/googlevertexai.cjs +8 -0
  242. package/dist/embeddings/googlevertexai.d.ts +8 -0
  243. package/dist/embeddings/googlevertexai.js +8 -0
  244. package/dist/embeddings/hf_transformers.cjs +18 -0
  245. package/dist/embeddings/hf_transformers.d.ts +18 -0
  246. package/dist/embeddings/hf_transformers.js +18 -0
  247. package/dist/embeddings/llama_cpp.cjs +16 -0
  248. package/dist/embeddings/llama_cpp.d.ts +16 -0
  249. package/dist/embeddings/llama_cpp.js +16 -0
  250. package/dist/embeddings/minimax.cjs +15 -0
  251. package/dist/embeddings/minimax.d.ts +15 -0
  252. package/dist/embeddings/minimax.js +15 -0
  253. package/dist/embeddings/openai.cjs +10 -0
  254. package/dist/embeddings/openai.d.ts +10 -0
  255. package/dist/embeddings/openai.js +10 -0
  256. package/dist/embeddings/tensorflow.cjs +16 -0
  257. package/dist/embeddings/tensorflow.d.ts +16 -0
  258. package/dist/embeddings/tensorflow.js +16 -0
  259. package/dist/experimental/autogpt/agent.cjs +21 -0
  260. package/dist/experimental/autogpt/agent.d.ts +21 -0
  261. package/dist/experimental/autogpt/agent.js +21 -0
  262. package/dist/experimental/babyagi/agent.cjs +12 -0
  263. package/dist/experimental/babyagi/agent.d.ts +12 -0
  264. package/dist/experimental/babyagi/agent.js +12 -0
  265. package/dist/experimental/chat_models/ollama_functions.cjs +12 -15
  266. package/dist/experimental/chat_models/ollama_functions.d.ts +3 -4
  267. package/dist/experimental/chat_models/ollama_functions.js +13 -16
  268. package/dist/experimental/generative_agents/generative_agent.cjs +30 -0
  269. package/dist/experimental/generative_agents/generative_agent.d.ts +30 -0
  270. package/dist/experimental/generative_agents/generative_agent.js +30 -0
  271. package/dist/experimental/generative_agents/generative_agent_memory.cjs +18 -0
  272. package/dist/experimental/generative_agents/generative_agent_memory.d.ts +18 -0
  273. package/dist/experimental/generative_agents/generative_agent_memory.js +18 -0
  274. package/dist/llms/base.cjs +3 -1
  275. package/dist/llms/base.d.ts +1 -1
  276. package/dist/llms/base.js +3 -1
  277. package/dist/llms/cohere.cjs +13 -0
  278. package/dist/llms/cohere.d.ts +13 -0
  279. package/dist/llms/cohere.js +13 -0
  280. package/dist/llms/googlevertexai/index.cjs +12 -0
  281. package/dist/llms/googlevertexai/index.d.ts +12 -0
  282. package/dist/llms/googlevertexai/index.js +12 -0
  283. package/dist/llms/googlevertexai/web.cjs +12 -0
  284. package/dist/llms/googlevertexai/web.d.ts +12 -0
  285. package/dist/llms/googlevertexai/web.js +12 -0
  286. package/dist/llms/hf.cjs +13 -0
  287. package/dist/llms/hf.d.ts +13 -0
  288. package/dist/llms/hf.js +13 -0
  289. package/dist/llms/ollama.cjs +19 -0
  290. package/dist/llms/ollama.d.ts +19 -0
  291. package/dist/llms/ollama.js +19 -0
  292. package/dist/llms/openai-chat.cjs +17 -0
  293. package/dist/llms/openai-chat.d.ts +17 -0
  294. package/dist/llms/openai-chat.js +17 -0
  295. package/dist/llms/openai.cjs +14 -0
  296. package/dist/llms/openai.d.ts +14 -0
  297. package/dist/llms/openai.js +14 -0
  298. package/dist/llms/portkey.cjs +24 -0
  299. package/dist/llms/portkey.d.ts +24 -0
  300. package/dist/llms/portkey.js +24 -0
  301. package/dist/llms/replicate.cjs +11 -0
  302. package/dist/llms/replicate.d.ts +11 -0
  303. package/dist/llms/replicate.js +11 -0
  304. package/dist/memory/buffer_memory.cjs +24 -0
  305. package/dist/memory/buffer_memory.d.ts +24 -0
  306. package/dist/memory/buffer_memory.js +24 -0
  307. package/dist/memory/buffer_token_memory.cjs +15 -0
  308. package/dist/memory/buffer_token_memory.d.ts +15 -0
  309. package/dist/memory/buffer_token_memory.js +15 -0
  310. package/dist/memory/buffer_window_memory.cjs +23 -0
  311. package/dist/memory/buffer_window_memory.d.ts +23 -0
  312. package/dist/memory/buffer_window_memory.js +23 -0
  313. package/dist/memory/entity_memory.cjs +29 -0
  314. package/dist/memory/entity_memory.d.ts +29 -0
  315. package/dist/memory/entity_memory.js +29 -0
  316. package/dist/memory/summary.cjs +24 -0
  317. package/dist/memory/summary.d.ts +24 -0
  318. package/dist/memory/summary.js +24 -0
  319. package/dist/memory/summary_buffer.cjs +32 -0
  320. package/dist/memory/summary_buffer.d.ts +32 -0
  321. package/dist/memory/summary_buffer.js +32 -0
  322. package/dist/memory/vector_store.cjs +24 -0
  323. package/dist/memory/vector_store.d.ts +24 -0
  324. package/dist/memory/vector_store.js +24 -0
  325. package/dist/memory/zep.cjs +34 -0
  326. package/dist/memory/zep.d.ts +34 -0
  327. package/dist/memory/zep.js +34 -0
  328. package/dist/prompts/chat.cjs +31 -0
  329. package/dist/prompts/chat.d.ts +31 -0
  330. package/dist/prompts/chat.js +31 -0
  331. package/dist/prompts/few_shot.cjs +31 -0
  332. package/dist/prompts/few_shot.d.ts +31 -0
  333. package/dist/prompts/few_shot.js +31 -0
  334. package/dist/prompts/pipeline.cjs +39 -0
  335. package/dist/prompts/pipeline.d.ts +39 -0
  336. package/dist/prompts/pipeline.js +39 -0
  337. package/dist/prompts/selectors/LengthBasedExampleSelector.cjs +36 -0
  338. package/dist/prompts/selectors/LengthBasedExampleSelector.d.ts +36 -0
  339. package/dist/prompts/selectors/LengthBasedExampleSelector.js +36 -0
  340. package/dist/prompts/selectors/SemanticSimilarityExampleSelector.cjs +25 -0
  341. package/dist/prompts/selectors/SemanticSimilarityExampleSelector.d.ts +25 -0
  342. package/dist/prompts/selectors/SemanticSimilarityExampleSelector.js +25 -0
  343. package/dist/retrievers/amazon_kendra.cjs +16 -0
  344. package/dist/retrievers/amazon_kendra.d.ts +16 -0
  345. package/dist/retrievers/amazon_kendra.js +16 -0
  346. package/dist/retrievers/chaindesk.cjs +11 -0
  347. package/dist/retrievers/chaindesk.d.ts +11 -0
  348. package/dist/retrievers/chaindesk.js +11 -0
  349. package/dist/retrievers/contextual_compression.cjs +10 -0
  350. package/dist/retrievers/contextual_compression.d.ts +10 -0
  351. package/dist/retrievers/contextual_compression.js +10 -0
  352. package/dist/retrievers/document_compressors/embeddings_filter.cjs +13 -0
  353. package/dist/retrievers/document_compressors/embeddings_filter.d.ts +13 -0
  354. package/dist/retrievers/document_compressors/embeddings_filter.js +13 -0
  355. package/dist/retrievers/document_compressors/index.cjs +26 -0
  356. package/dist/retrievers/document_compressors/index.d.ts +26 -0
  357. package/dist/retrievers/document_compressors/index.js +26 -0
  358. package/dist/retrievers/hyde.cjs +19 -0
  359. package/dist/retrievers/hyde.d.ts +19 -0
  360. package/dist/retrievers/hyde.js +19 -0
  361. package/dist/retrievers/metal.cjs +11 -0
  362. package/dist/retrievers/metal.d.ts +11 -0
  363. package/dist/retrievers/metal.js +11 -0
  364. package/dist/retrievers/multi_query.cjs +13 -1
  365. package/dist/retrievers/multi_query.d.ts +13 -0
  366. package/dist/retrievers/multi_query.js +13 -1
  367. package/dist/retrievers/multi_vector.cjs +13 -0
  368. package/dist/retrievers/multi_vector.d.ts +13 -0
  369. package/dist/retrievers/multi_vector.js +13 -0
  370. package/dist/retrievers/parent_document.cjs +21 -0
  371. package/dist/retrievers/parent_document.d.ts +21 -0
  372. package/dist/retrievers/parent_document.js +21 -0
  373. package/dist/retrievers/remote/chatgpt-plugin.cjs +10 -0
  374. package/dist/retrievers/remote/chatgpt-plugin.d.ts +10 -0
  375. package/dist/retrievers/remote/chatgpt-plugin.js +10 -0
  376. package/dist/retrievers/self_query/chroma.cjs +15 -0
  377. package/dist/retrievers/self_query/chroma.d.ts +15 -0
  378. package/dist/retrievers/self_query/chroma.js +15 -0
  379. package/dist/retrievers/self_query/functional.cjs +7 -0
  380. package/dist/retrievers/self_query/functional.d.ts +7 -0
  381. package/dist/retrievers/self_query/functional.js +7 -0
  382. package/dist/retrievers/self_query/index.cjs +13 -0
  383. package/dist/retrievers/self_query/index.d.ts +13 -0
  384. package/dist/retrievers/self_query/index.js +13 -0
  385. package/dist/retrievers/self_query/pinecone.cjs +14 -0
  386. package/dist/retrievers/self_query/pinecone.d.ts +14 -0
  387. package/dist/retrievers/self_query/pinecone.js +14 -0
  388. package/dist/retrievers/self_query/supabase.cjs +14 -0
  389. package/dist/retrievers/self_query/supabase.d.ts +14 -0
  390. package/dist/retrievers/self_query/supabase.js +14 -0
  391. package/dist/retrievers/self_query/weaviate.cjs +14 -0
  392. package/dist/retrievers/self_query/weaviate.d.ts +14 -0
  393. package/dist/retrievers/self_query/weaviate.js +14 -0
  394. package/dist/retrievers/time_weighted.cjs +16 -0
  395. package/dist/retrievers/time_weighted.d.ts +16 -0
  396. package/dist/retrievers/time_weighted.js +16 -0
  397. package/dist/retrievers/vespa.cjs +15 -0
  398. package/dist/retrievers/vespa.d.ts +15 -0
  399. package/dist/retrievers/vespa.js +15 -0
  400. package/dist/retrievers/zep.cjs +10 -0
  401. package/dist/retrievers/zep.d.ts +10 -0
  402. package/dist/retrievers/zep.js +10 -0
  403. package/dist/schema/index.d.ts +8 -6
  404. package/dist/schema/output_parser.cjs +15 -0
  405. package/dist/schema/output_parser.d.ts +15 -0
  406. package/dist/schema/output_parser.js +15 -0
  407. package/dist/schema/runnable/base.cjs +20 -0
  408. package/dist/schema/runnable/base.d.ts +20 -0
  409. package/dist/schema/runnable/base.js +20 -0
  410. package/dist/schema/runnable/branch.cjs +28 -0
  411. package/dist/schema/runnable/branch.d.ts +28 -0
  412. package/dist/schema/runnable/branch.js +28 -0
  413. package/dist/storage/file_system.cjs +21 -0
  414. package/dist/storage/file_system.d.ts +21 -0
  415. package/dist/storage/file_system.js +21 -0
  416. package/dist/storage/in_memory.cjs +15 -0
  417. package/dist/storage/in_memory.d.ts +15 -0
  418. package/dist/storage/in_memory.js +15 -0
  419. package/dist/storage/ioredis.cjs +24 -0
  420. package/dist/storage/ioredis.d.ts +24 -0
  421. package/dist/storage/ioredis.js +24 -0
  422. package/dist/storage/upstash_redis.cjs +19 -0
  423. package/dist/storage/upstash_redis.d.ts +19 -0
  424. package/dist/storage/upstash_redis.js +19 -0
  425. package/dist/storage/vercel_kv.cjs +16 -0
  426. package/dist/storage/vercel_kv.d.ts +16 -0
  427. package/dist/storage/vercel_kv.js +16 -0
  428. package/dist/stores/message/cassandra.cjs +25 -0
  429. package/dist/stores/message/cassandra.d.ts +25 -0
  430. package/dist/stores/message/cassandra.js +25 -0
  431. package/dist/stores/message/cloudflare_d1.cjs +18 -0
  432. package/dist/stores/message/cloudflare_d1.d.ts +18 -0
  433. package/dist/stores/message/cloudflare_d1.js +18 -0
  434. package/dist/stores/message/firestore.cjs +19 -0
  435. package/dist/stores/message/firestore.d.ts +19 -0
  436. package/dist/stores/message/firestore.js +19 -0
  437. package/dist/stores/message/ioredis.cjs +18 -0
  438. package/dist/stores/message/ioredis.d.ts +18 -0
  439. package/dist/stores/message/ioredis.js +18 -0
  440. package/dist/stores/message/momento.cjs +18 -0
  441. package/dist/stores/message/momento.d.ts +18 -0
  442. package/dist/stores/message/momento.js +18 -0
  443. package/dist/stores/message/mongodb.cjs +11 -0
  444. package/dist/stores/message/mongodb.d.ts +11 -0
  445. package/dist/stores/message/mongodb.js +11 -0
  446. package/dist/stores/message/planetscale.cjs +18 -0
  447. package/dist/stores/message/planetscale.d.ts +18 -0
  448. package/dist/stores/message/planetscale.js +18 -0
  449. package/dist/stores/message/redis.cjs +18 -0
  450. package/dist/stores/message/redis.d.ts +18 -0
  451. package/dist/stores/message/redis.js +18 -0
  452. package/dist/stores/message/xata.cjs +23 -0
  453. package/dist/stores/message/xata.d.ts +23 -0
  454. package/dist/stores/message/xata.js +23 -0
  455. package/dist/tools/calculator.cjs +6 -0
  456. package/dist/tools/calculator.d.ts +6 -0
  457. package/dist/tools/calculator.js +6 -0
  458. package/dist/tools/google_calendar/create.cjs +22 -0
  459. package/dist/tools/google_calendar/create.d.ts +22 -0
  460. package/dist/tools/google_calendar/create.js +22 -0
  461. package/dist/tools/google_calendar/view.cjs +20 -0
  462. package/dist/tools/google_calendar/view.d.ts +20 -0
  463. package/dist/tools/google_calendar/view.js +20 -0
  464. package/dist/tools/searchapi.cjs +27 -0
  465. package/dist/tools/searchapi.d.ts +27 -0
  466. package/dist/tools/searchapi.js +27 -0
  467. package/dist/tools/searxng_search.cjs +20 -1
  468. package/dist/tools/searxng_search.d.ts +20 -1
  469. package/dist/tools/searxng_search.js +20 -1
  470. package/dist/tools/webbrowser.cjs +8 -0
  471. package/dist/tools/webbrowser.d.ts +8 -0
  472. package/dist/tools/webbrowser.js +8 -0
  473. package/dist/tools/wikipedia_query_run.cjs +8 -0
  474. package/dist/tools/wikipedia_query_run.d.ts +8 -0
  475. package/dist/tools/wikipedia_query_run.js +8 -0
  476. package/dist/tools/wolframalpha.cjs +9 -0
  477. package/dist/tools/wolframalpha.d.ts +9 -0
  478. package/dist/tools/wolframalpha.js +9 -0
  479. package/dist/util/googlevertexai-connection.cjs +3 -9
  480. package/dist/util/googlevertexai-connection.js +3 -9
  481. package/dist/vectorstores/opensearch.cjs +2 -1
  482. package/dist/vectorstores/opensearch.js +2 -1
  483. package/dist/vectorstores/prisma.cjs +6 -0
  484. package/dist/vectorstores/prisma.d.ts +3 -0
  485. package/dist/vectorstores/prisma.js +6 -0
  486. package/package.json +2 -2
@@ -7,6 +7,25 @@ const storage_js_1 = require("../schema/storage.cjs");
7
7
  * Class that extends the BaseStore class to interact with an Upstash Redis
8
8
  * database. It provides methods for getting, setting, and deleting data,
9
9
  * as well as yielding keys from the database.
10
+ * @example
11
+ * ```typescript
12
+ * const store = new UpstashRedisStore({
13
+ * client: new Redis({
14
+ * url: "your-upstash-redis-url",
15
+ * token: "your-upstash-redis-token",
16
+ * }),
17
+ * });
18
+ * await store.mset([
19
+ * ["message:id:0", "encoded-ai-message"],
20
+ * ["message:id:1", "encoded-human-message"],
21
+ * ]);
22
+ * const retrievedMessages = await store.mget(["message:id:0", "message:id:1"]);
23
+ * const yieldedKeys = [];
24
+ * for await (const key of store.yieldKeys("message:id")) {
25
+ * yieldedKeys.push(key);
26
+ * }
27
+ * await store.mdelete(yieldedKeys);
28
+ * ```
10
29
  */
11
30
  class UpstashRedisStore extends storage_js_1.BaseStore {
12
31
  constructor(fields) {
@@ -22,6 +22,25 @@ export interface UpstashRedisStoreInput {
22
22
  * Class that extends the BaseStore class to interact with an Upstash Redis
23
23
  * database. It provides methods for getting, setting, and deleting data,
24
24
  * as well as yielding keys from the database.
25
+ * @example
26
+ * ```typescript
27
+ * const store = new UpstashRedisStore({
28
+ * client: new Redis({
29
+ * url: "your-upstash-redis-url",
30
+ * token: "your-upstash-redis-token",
31
+ * }),
32
+ * });
33
+ * await store.mset([
34
+ * ["message:id:0", "encoded-ai-message"],
35
+ * ["message:id:1", "encoded-human-message"],
36
+ * ]);
37
+ * const retrievedMessages = await store.mget(["message:id:0", "message:id:1"]);
38
+ * const yieldedKeys = [];
39
+ * for await (const key of store.yieldKeys("message:id")) {
40
+ * yieldedKeys.push(key);
41
+ * }
42
+ * await store.mdelete(yieldedKeys);
43
+ * ```
25
44
  */
26
45
  export declare class UpstashRedisStore extends BaseStore<string, Uint8Array> {
27
46
  lc_namespace: string[];
@@ -4,6 +4,25 @@ import { BaseStore } from "../schema/storage.js";
4
4
  * Class that extends the BaseStore class to interact with an Upstash Redis
5
5
  * database. It provides methods for getting, setting, and deleting data,
6
6
  * as well as yielding keys from the database.
7
+ * @example
8
+ * ```typescript
9
+ * const store = new UpstashRedisStore({
10
+ * client: new Redis({
11
+ * url: "your-upstash-redis-url",
12
+ * token: "your-upstash-redis-token",
13
+ * }),
14
+ * });
15
+ * await store.mset([
16
+ * ["message:id:0", "encoded-ai-message"],
17
+ * ["message:id:1", "encoded-human-message"],
18
+ * ]);
19
+ * const retrievedMessages = await store.mget(["message:id:0", "message:id:1"]);
20
+ * const yieldedKeys = [];
21
+ * for await (const key of store.yieldKeys("message:id")) {
22
+ * yieldedKeys.push(key);
23
+ * }
24
+ * await store.mdelete(yieldedKeys);
25
+ * ```
7
26
  */
8
27
  export class UpstashRedisStore extends BaseStore {
9
28
  constructor(fields) {
@@ -7,6 +7,22 @@ const storage_js_1 = require("../schema/storage.cjs");
7
7
  * Class that extends the BaseStore class to interact with a Vercel KV
8
8
  * database. It provides methods for getting, setting, and deleting data,
9
9
  * as well as yielding keys from the database.
10
+ * @example
11
+ * ```typescript
12
+ * const store = new VercelKVStore({
13
+ * client: getClient(),
14
+ * });
15
+ * await store.mset([
16
+ * { key: "message:id:0", value: "encoded message 0" },
17
+ * { key: "message:id:1", value: "encoded message 1" },
18
+ * ]);
19
+ * const retrievedMessages = await store.mget(["message:id:0", "message:id:1"]);
20
+ * const yieldedKeys = [];
21
+ * for await (const key of store.yieldKeys("message:id:")) {
22
+ * yieldedKeys.push(key);
23
+ * }
24
+ * await store.mdelete(yieldedKeys);
25
+ * ```
10
26
  */
11
27
  class VercelKVStore extends storage_js_1.BaseStore {
12
28
  constructor(fields) {
@@ -4,6 +4,22 @@ import { BaseStore } from "../schema/storage.js";
4
4
  * Class that extends the BaseStore class to interact with a Vercel KV
5
5
  * database. It provides methods for getting, setting, and deleting data,
6
6
  * as well as yielding keys from the database.
7
+ * @example
8
+ * ```typescript
9
+ * const store = new VercelKVStore({
10
+ * client: getClient(),
11
+ * });
12
+ * await store.mset([
13
+ * { key: "message:id:0", value: "encoded message 0" },
14
+ * { key: "message:id:1", value: "encoded message 1" },
15
+ * ]);
16
+ * const retrievedMessages = await store.mget(["message:id:0", "message:id:1"]);
17
+ * const yieldedKeys = [];
18
+ * for await (const key of store.yieldKeys("message:id:")) {
19
+ * yieldedKeys.push(key);
20
+ * }
21
+ * await store.mdelete(yieldedKeys);
22
+ * ```
7
23
  */
8
24
  export declare class VercelKVStore extends BaseStore<string, Uint8Array> {
9
25
  lc_namespace: string[];
@@ -4,6 +4,22 @@ import { BaseStore } from "../schema/storage.js";
4
4
  * Class that extends the BaseStore class to interact with a Vercel KV
5
5
  * database. It provides methods for getting, setting, and deleting data,
6
6
  * as well as yielding keys from the database.
7
+ * @example
8
+ * ```typescript
9
+ * const store = new VercelKVStore({
10
+ * client: getClient(),
11
+ * });
12
+ * await store.mset([
13
+ * { key: "message:id:0", value: "encoded message 0" },
14
+ * { key: "message:id:1", value: "encoded message 1" },
15
+ * ]);
16
+ * const retrievedMessages = await store.mget(["message:id:0", "message:id:1"]);
17
+ * const yieldedKeys = [];
18
+ * for await (const key of store.yieldKeys("message:id:")) {
19
+ * yieldedKeys.push(key);
20
+ * }
21
+ * await store.mdelete(yieldedKeys);
22
+ * ```
7
23
  */
8
24
  export class VercelKVStore extends BaseStore {
9
25
  constructor(fields) {
@@ -8,6 +8,31 @@ const utils_js_1 = require("./utils.cjs");
8
8
  * Class for storing chat message history within Cassandra. It extends the
9
9
  * BaseListChatMessageHistory class and provides methods to get, add, and
10
10
  * clear messages.
11
+ * @example
12
+ * ```typescript
13
+ * const chatHistory = new CassandraChatMessageHistory({
14
+ * cloud: {
15
+ * secureConnectBundle: "<path to your secure bundle>",
16
+ * },
17
+ * credentials: {
18
+ * username: "token",
19
+ * password: "<your Cassandra access token>",
20
+ * },
21
+ * keyspace: "langchain",
22
+ * table: "message_history",
23
+ * sessionId: "<some unique session identifier>",
24
+ * });
25
+ *
26
+ * const chain = new ConversationChain({
27
+ * llm: new ChatOpenAI(),
28
+ * memory: chatHistory,
29
+ * });
30
+ *
31
+ * const response = await chain.invoke({
32
+ * input: "What did I just say my name was?",
33
+ * });
34
+ * console.log({ response });
35
+ * ```
11
36
  */
12
37
  class CassandraChatMessageHistory extends index_js_1.BaseListChatMessageHistory {
13
38
  constructor(options) {
@@ -9,6 +9,31 @@ export interface CassandraChatMessageHistoryOptions extends DseClientOptions {
9
9
  * Class for storing chat message history within Cassandra. It extends the
10
10
  * BaseListChatMessageHistory class and provides methods to get, add, and
11
11
  * clear messages.
12
+ * @example
13
+ * ```typescript
14
+ * const chatHistory = new CassandraChatMessageHistory({
15
+ * cloud: {
16
+ * secureConnectBundle: "<path to your secure bundle>",
17
+ * },
18
+ * credentials: {
19
+ * username: "token",
20
+ * password: "<your Cassandra access token>",
21
+ * },
22
+ * keyspace: "langchain",
23
+ * table: "message_history",
24
+ * sessionId: "<some unique session identifier>",
25
+ * });
26
+ *
27
+ * const chain = new ConversationChain({
28
+ * llm: new ChatOpenAI(),
29
+ * memory: chatHistory,
30
+ * });
31
+ *
32
+ * const response = await chain.invoke({
33
+ * input: "What did I just say my name was?",
34
+ * });
35
+ * console.log({ response });
36
+ * ```
12
37
  */
13
38
  export declare class CassandraChatMessageHistory extends BaseListChatMessageHistory {
14
39
  lc_namespace: string[];
@@ -5,6 +5,31 @@ import { mapChatMessagesToStoredMessages, mapStoredMessagesToChatMessages, } fro
5
5
  * Class for storing chat message history within Cassandra. It extends the
6
6
  * BaseListChatMessageHistory class and provides methods to get, add, and
7
7
  * clear messages.
8
+ * @example
9
+ * ```typescript
10
+ * const chatHistory = new CassandraChatMessageHistory({
11
+ * cloud: {
12
+ * secureConnectBundle: "<path to your secure bundle>",
13
+ * },
14
+ * credentials: {
15
+ * username: "token",
16
+ * password: "<your Cassandra access token>",
17
+ * },
18
+ * keyspace: "langchain",
19
+ * table: "message_history",
20
+ * sessionId: "<some unique session identifier>",
21
+ * });
22
+ *
23
+ * const chain = new ConversationChain({
24
+ * llm: new ChatOpenAI(),
25
+ * memory: chatHistory,
26
+ * });
27
+ *
28
+ * const response = await chain.invoke({
29
+ * input: "What did I just say my name was?",
30
+ * });
31
+ * console.log({ response });
32
+ * ```
8
33
  */
9
34
  export class CassandraChatMessageHistory extends BaseListChatMessageHistory {
10
35
  constructor(options) {
@@ -7,6 +7,24 @@ const utils_js_1 = require("./utils.cjs");
7
7
  /**
8
8
  * Class for storing and retrieving chat message history from a
9
9
  * Cloudflare D1 database. Extends the BaseListChatMessageHistory class.
10
+ * @example
11
+ * ```typescript
12
+ * const memory = new BufferMemory({
13
+ * returnMessages: true,
14
+ * chatHistory: new CloudflareD1MessageHistory({
15
+ * tableName: "stored_message",
16
+ * sessionId: "example",
17
+ * database: env.DB,
18
+ * }),
19
+ * });
20
+ *
21
+ * const chainInput = { input };
22
+ *
23
+ * const res = await memory.chatHistory.invoke(chainInput);
24
+ * await memory.saveContext(chainInput, {
25
+ * output: res,
26
+ * });
27
+ * ```
10
28
  */
11
29
  class CloudflareD1MessageHistory extends index_js_1.BaseListChatMessageHistory {
12
30
  constructor(fields) {
@@ -12,6 +12,24 @@ export type CloudflareD1MessageHistoryInput = {
12
12
  /**
13
13
  * Class for storing and retrieving chat message history from a
14
14
  * Cloudflare D1 database. Extends the BaseListChatMessageHistory class.
15
+ * @example
16
+ * ```typescript
17
+ * const memory = new BufferMemory({
18
+ * returnMessages: true,
19
+ * chatHistory: new CloudflareD1MessageHistory({
20
+ * tableName: "stored_message",
21
+ * sessionId: "example",
22
+ * database: env.DB,
23
+ * }),
24
+ * });
25
+ *
26
+ * const chainInput = { input };
27
+ *
28
+ * const res = await memory.chatHistory.invoke(chainInput);
29
+ * await memory.saveContext(chainInput, {
30
+ * output: res,
31
+ * });
32
+ * ```
15
33
  */
16
34
  export declare class CloudflareD1MessageHistory extends BaseListChatMessageHistory {
17
35
  lc_namespace: string[];
@@ -4,6 +4,24 @@ import { mapChatMessagesToStoredMessages, mapStoredMessagesToChatMessages, } fro
4
4
  /**
5
5
  * Class for storing and retrieving chat message history from a
6
6
  * Cloudflare D1 database. Extends the BaseListChatMessageHistory class.
7
+ * @example
8
+ * ```typescript
9
+ * const memory = new BufferMemory({
10
+ * returnMessages: true,
11
+ * chatHistory: new CloudflareD1MessageHistory({
12
+ * tableName: "stored_message",
13
+ * sessionId: "example",
14
+ * database: env.DB,
15
+ * }),
16
+ * });
17
+ *
18
+ * const chainInput = { input };
19
+ *
20
+ * const res = await memory.chatHistory.invoke(chainInput);
21
+ * await memory.saveContext(chainInput, {
22
+ * output: res,
23
+ * });
24
+ * ```
7
25
  */
8
26
  export class CloudflareD1MessageHistory extends BaseListChatMessageHistory {
9
27
  constructor(fields) {
@@ -8,6 +8,25 @@ const utils_js_1 = require("./utils.cjs");
8
8
  /**
9
9
  * Class for managing chat message history using Google's Firestore as a
10
10
  * storage backend. Extends the BaseListChatMessageHistory class.
11
+ * @example
12
+ * ```typescript
13
+ * const chatHistory = new FirestoreChatMessageHistory({
14
+ * collectionName: "langchain",
15
+ * sessionId: "lc-example",
16
+ * userId: "a@example.com",
17
+ * config: { projectId: "your-project-id" },
18
+ * });
19
+ *
20
+ * const chain = new ConversationChain({
21
+ * llm: new ChatOpenAI(),
22
+ * memory: new BufferMemory({ chatHistory }),
23
+ * });
24
+ *
25
+ * const response = await chain.invoke({
26
+ * input: "What did I just say my name was?",
27
+ * });
28
+ * console.log({ response });
29
+ * ```
11
30
  */
12
31
  class FirestoreChatMessageHistory extends index_js_1.BaseListChatMessageHistory {
13
32
  constructor({ collectionName, sessionId, userId, appIdx = 0, config, }) {
@@ -15,6 +15,25 @@ export interface FirestoreDBChatMessageHistory {
15
15
  /**
16
16
  * Class for managing chat message history using Google's Firestore as a
17
17
  * storage backend. Extends the BaseListChatMessageHistory class.
18
+ * @example
19
+ * ```typescript
20
+ * const chatHistory = new FirestoreChatMessageHistory({
21
+ * collectionName: "langchain",
22
+ * sessionId: "lc-example",
23
+ * userId: "a@example.com",
24
+ * config: { projectId: "your-project-id" },
25
+ * });
26
+ *
27
+ * const chain = new ConversationChain({
28
+ * llm: new ChatOpenAI(),
29
+ * memory: new BufferMemory({ chatHistory }),
30
+ * });
31
+ *
32
+ * const response = await chain.invoke({
33
+ * input: "What did I just say my name was?",
34
+ * });
35
+ * console.log({ response });
36
+ * ```
18
37
  */
19
38
  export declare class FirestoreChatMessageHistory extends BaseListChatMessageHistory {
20
39
  lc_namespace: string[];
@@ -5,6 +5,25 @@ import { mapChatMessagesToStoredMessages, mapStoredMessagesToChatMessages, } fro
5
5
  /**
6
6
  * Class for managing chat message history using Google's Firestore as a
7
7
  * storage backend. Extends the BaseListChatMessageHistory class.
8
+ * @example
9
+ * ```typescript
10
+ * const chatHistory = new FirestoreChatMessageHistory({
11
+ * collectionName: "langchain",
12
+ * sessionId: "lc-example",
13
+ * userId: "a@example.com",
14
+ * config: { projectId: "your-project-id" },
15
+ * });
16
+ *
17
+ * const chain = new ConversationChain({
18
+ * llm: new ChatOpenAI(),
19
+ * memory: new BufferMemory({ chatHistory }),
20
+ * });
21
+ *
22
+ * const response = await chain.invoke({
23
+ * input: "What did I just say my name was?",
24
+ * });
25
+ * console.log({ response });
26
+ * ```
8
27
  */
9
28
  export class FirestoreChatMessageHistory extends BaseListChatMessageHistory {
10
29
  constructor({ collectionName, sessionId, userId, appIdx = 0, config, }) {
@@ -7,6 +7,24 @@ const utils_js_1 = require("./utils.cjs");
7
7
  /**
8
8
  * Class used to store chat message history in Redis. It provides methods
9
9
  * to add, retrieve, and clear messages from the chat history.
10
+ * @example
11
+ * ```typescript
12
+ * const chatHistory = new RedisChatMessageHistory({
13
+ * sessionId: new Date().toISOString(),
14
+ * sessionTTL: 300,
15
+ * url: "redis:
16
+ * });
17
+ *
18
+ * const chain = new ConversationChain({
19
+ * llm: new ChatOpenAI({ temperature: 0 }),
20
+ * memory: { chatHistory },
21
+ * });
22
+ *
23
+ * const response = await chain.invoke({
24
+ * input: "What did I just say my name was?",
25
+ * });
26
+ * console.log({ response });
27
+ * ```
10
28
  */
11
29
  class RedisChatMessageHistory extends index_js_1.BaseListChatMessageHistory {
12
30
  get lc_secrets() {
@@ -15,6 +15,24 @@ export type RedisChatMessageHistoryInput = {
15
15
  /**
16
16
  * Class used to store chat message history in Redis. It provides methods
17
17
  * to add, retrieve, and clear messages from the chat history.
18
+ * @example
19
+ * ```typescript
20
+ * const chatHistory = new RedisChatMessageHistory({
21
+ * sessionId: new Date().toISOString(),
22
+ * sessionTTL: 300,
23
+ * url: "redis:
24
+ * });
25
+ *
26
+ * const chain = new ConversationChain({
27
+ * llm: new ChatOpenAI({ temperature: 0 }),
28
+ * memory: { chatHistory },
29
+ * });
30
+ *
31
+ * const response = await chain.invoke({
32
+ * input: "What did I just say my name was?",
33
+ * });
34
+ * console.log({ response });
35
+ * ```
18
36
  */
19
37
  export declare class RedisChatMessageHistory extends BaseListChatMessageHistory {
20
38
  lc_namespace: string[];
@@ -4,6 +4,24 @@ import { mapChatMessagesToStoredMessages, mapStoredMessagesToChatMessages, } fro
4
4
  /**
5
5
  * Class used to store chat message history in Redis. It provides methods
6
6
  * to add, retrieve, and clear messages from the chat history.
7
+ * @example
8
+ * ```typescript
9
+ * const chatHistory = new RedisChatMessageHistory({
10
+ * sessionId: new Date().toISOString(),
11
+ * sessionTTL: 300,
12
+ * url: "redis:
13
+ * });
14
+ *
15
+ * const chain = new ConversationChain({
16
+ * llm: new ChatOpenAI({ temperature: 0 }),
17
+ * memory: { chatHistory },
18
+ * });
19
+ *
20
+ * const response = await chain.invoke({
21
+ * input: "What did I just say my name was?",
22
+ * });
23
+ * console.log({ response });
24
+ * ```
7
25
  */
8
26
  export class RedisChatMessageHistory extends BaseListChatMessageHistory {
9
27
  get lc_secrets() {
@@ -10,6 +10,24 @@ const momento_js_1 = require("../../util/momento.cjs");
10
10
  * A class that stores chat message history using Momento Cache. It
11
11
  * interacts with a Momento cache client to perform operations like
12
12
  * fetching, adding, and deleting messages.
13
+ * @example
14
+ * ```typescript
15
+ * const chatHistory = await MomentoChatMessageHistory.fromProps({
16
+ * client: new CacheClient({
17
+ * configuration: Configurations.Laptop.v1(),
18
+ * credentialProvider: CredentialProvider.fromEnvironmentVariable({
19
+ * environmentVariableName: "MOMENTO_API_KEY",
20
+ * }),
21
+ * defaultTtlSeconds: 60 * 60 * 24,
22
+ * }),
23
+ * cacheName: "langchain",
24
+ * sessionId: new Date().toISOString(),
25
+ * sessionTtl: 300,
26
+ * });
27
+ *
28
+ * const messages = await chatHistory.getMessages();
29
+ * console.log({ messages });
30
+ * ```
13
31
  */
14
32
  class MomentoChatMessageHistory extends index_js_1.BaseListChatMessageHistory {
15
33
  constructor(props) {
@@ -32,6 +32,24 @@ export interface MomentoChatMessageHistoryProps {
32
32
  * A class that stores chat message history using Momento Cache. It
33
33
  * interacts with a Momento cache client to perform operations like
34
34
  * fetching, adding, and deleting messages.
35
+ * @example
36
+ * ```typescript
37
+ * const chatHistory = await MomentoChatMessageHistory.fromProps({
38
+ * client: new CacheClient({
39
+ * configuration: Configurations.Laptop.v1(),
40
+ * credentialProvider: CredentialProvider.fromEnvironmentVariable({
41
+ * environmentVariableName: "MOMENTO_API_KEY",
42
+ * }),
43
+ * defaultTtlSeconds: 60 * 60 * 24,
44
+ * }),
45
+ * cacheName: "langchain",
46
+ * sessionId: new Date().toISOString(),
47
+ * sessionTtl: 300,
48
+ * });
49
+ *
50
+ * const messages = await chatHistory.getMessages();
51
+ * console.log({ messages });
52
+ * ```
35
53
  */
36
54
  export declare class MomentoChatMessageHistory extends BaseListChatMessageHistory {
37
55
  lc_namespace: string[];
@@ -7,6 +7,24 @@ import { ensureCacheExists } from "../../util/momento.js";
7
7
  * A class that stores chat message history using Momento Cache. It
8
8
  * interacts with a Momento cache client to perform operations like
9
9
  * fetching, adding, and deleting messages.
10
+ * @example
11
+ * ```typescript
12
+ * const chatHistory = await MomentoChatMessageHistory.fromProps({
13
+ * client: new CacheClient({
14
+ * configuration: Configurations.Laptop.v1(),
15
+ * credentialProvider: CredentialProvider.fromEnvironmentVariable({
16
+ * environmentVariableName: "MOMENTO_API_KEY",
17
+ * }),
18
+ * defaultTtlSeconds: 60 * 60 * 24,
19
+ * }),
20
+ * cacheName: "langchain",
21
+ * sessionId: new Date().toISOString(),
22
+ * sessionTtl: 300,
23
+ * });
24
+ *
25
+ * const messages = await chatHistory.getMessages();
26
+ * console.log({ messages });
27
+ * ```
10
28
  */
11
29
  export class MomentoChatMessageHistory extends BaseListChatMessageHistory {
12
30
  constructor(props) {
@@ -4,6 +4,17 @@ exports.MongoDBChatMessageHistory = void 0;
4
4
  const mongodb_1 = require("mongodb");
5
5
  const index_js_1 = require("../../schema/index.cjs");
6
6
  const utils_js_1 = require("./utils.cjs");
7
+ /**
8
+ * @example
9
+ * ```typescript
10
+ * const chatHistory = new MongoDBChatMessageHistory({
11
+ * collection: myCollection,
12
+ * sessionId: 'unique-session-id',
13
+ * });
14
+ * const messages = await chatHistory.getMessages();
15
+ * await chatHistory.clear();
16
+ * ```
17
+ */
7
18
  class MongoDBChatMessageHistory extends index_js_1.BaseListChatMessageHistory {
8
19
  constructor({ collection, sessionId }) {
9
20
  super();
@@ -4,6 +4,17 @@ export interface MongoDBChatMessageHistoryInput {
4
4
  collection: Collection<MongoDBDocument>;
5
5
  sessionId: string;
6
6
  }
7
+ /**
8
+ * @example
9
+ * ```typescript
10
+ * const chatHistory = new MongoDBChatMessageHistory({
11
+ * collection: myCollection,
12
+ * sessionId: 'unique-session-id',
13
+ * });
14
+ * const messages = await chatHistory.getMessages();
15
+ * await chatHistory.clear();
16
+ * ```
17
+ */
7
18
  export declare class MongoDBChatMessageHistory extends BaseListChatMessageHistory {
8
19
  lc_namespace: string[];
9
20
  private collection;
@@ -1,6 +1,17 @@
1
1
  import { ObjectId } from "mongodb";
2
2
  import { BaseListChatMessageHistory } from "../../schema/index.js";
3
3
  import { mapChatMessagesToStoredMessages, mapStoredMessagesToChatMessages, } from "./utils.js";
4
+ /**
5
+ * @example
6
+ * ```typescript
7
+ * const chatHistory = new MongoDBChatMessageHistory({
8
+ * collection: myCollection,
9
+ * sessionId: 'unique-session-id',
10
+ * });
11
+ * const messages = await chatHistory.getMessages();
12
+ * await chatHistory.clear();
13
+ * ```
14
+ */
4
15
  export class MongoDBChatMessageHistory extends BaseListChatMessageHistory {
5
16
  constructor({ collection, sessionId }) {
6
17
  super();
@@ -7,6 +7,24 @@ const utils_js_1 = require("./utils.cjs");
7
7
  /**
8
8
  * Class for storing and retrieving chat message history from a
9
9
  * PlanetScale database. Extends the BaseListChatMessageHistory class.
10
+ * @example
11
+ * ```typescript
12
+ * const chatHistory = new PlanetScaleChatMessageHistory({
13
+ * tableName: "stored_message",
14
+ * sessionId: "lc-example",
15
+ * config: {
16
+ * url: "ADD_YOURS_HERE",
17
+ * },
18
+ * });
19
+ * const chain = new ConversationChain({
20
+ * llm: new ChatOpenAI(),
21
+ * memory: chatHistory,
22
+ * });
23
+ * const response = await chain.invoke({
24
+ * input: "What did I just say my name was?",
25
+ * });
26
+ * console.log({ response });
27
+ * ```
10
28
  */
11
29
  class PlanetScaleChatMessageHistory extends index_js_1.BaseListChatMessageHistory {
12
30
  get lc_secrets() {
@@ -13,6 +13,24 @@ export type PlanetScaleChatMessageHistoryInput = {
13
13
  /**
14
14
  * Class for storing and retrieving chat message history from a
15
15
  * PlanetScale database. Extends the BaseListChatMessageHistory class.
16
+ * @example
17
+ * ```typescript
18
+ * const chatHistory = new PlanetScaleChatMessageHistory({
19
+ * tableName: "stored_message",
20
+ * sessionId: "lc-example",
21
+ * config: {
22
+ * url: "ADD_YOURS_HERE",
23
+ * },
24
+ * });
25
+ * const chain = new ConversationChain({
26
+ * llm: new ChatOpenAI(),
27
+ * memory: chatHistory,
28
+ * });
29
+ * const response = await chain.invoke({
30
+ * input: "What did I just say my name was?",
31
+ * });
32
+ * console.log({ response });
33
+ * ```
16
34
  */
17
35
  export declare class PlanetScaleChatMessageHistory extends BaseListChatMessageHistory {
18
36
  lc_namespace: string[];