langchain 0.0.191 → 0.0.193

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 (502) hide show
  1. package/cache/file_system.cjs +1 -0
  2. package/cache/file_system.d.ts +1 -0
  3. package/cache/file_system.js +1 -0
  4. package/dist/agents/agent.cjs +24 -0
  5. package/dist/agents/agent.d.ts +24 -0
  6. package/dist/agents/agent.js +24 -0
  7. package/dist/agents/chat/outputParser.cjs +32 -0
  8. package/dist/agents/chat/outputParser.d.ts +32 -0
  9. package/dist/agents/chat/outputParser.js +32 -0
  10. package/dist/agents/executor.cjs +14 -0
  11. package/dist/agents/executor.d.ts +14 -0
  12. package/dist/agents/executor.js +14 -0
  13. package/dist/agents/mrkl/index.cjs +21 -0
  14. package/dist/agents/mrkl/index.d.ts +21 -0
  15. package/dist/agents/mrkl/index.js +21 -0
  16. package/dist/agents/openai/output_parser.cjs +65 -0
  17. package/dist/agents/openai/output_parser.d.ts +65 -0
  18. package/dist/agents/openai/output_parser.js +65 -0
  19. package/dist/agents/react/output_parser.cjs +16 -0
  20. package/dist/agents/react/output_parser.d.ts +16 -0
  21. package/dist/agents/react/output_parser.js +16 -0
  22. package/dist/agents/structured_chat/outputParser.cjs +12 -0
  23. package/dist/agents/structured_chat/outputParser.d.ts +12 -0
  24. package/dist/agents/structured_chat/outputParser.js +12 -0
  25. package/dist/agents/toolkits/aws_sfn.cjs +20 -0
  26. package/dist/agents/toolkits/aws_sfn.d.ts +20 -0
  27. package/dist/agents/toolkits/aws_sfn.js +20 -0
  28. package/dist/agents/toolkits/json/json.cjs +8 -0
  29. package/dist/agents/toolkits/json/json.d.ts +8 -0
  30. package/dist/agents/toolkits/json/json.js +8 -0
  31. package/dist/agents/toolkits/openapi/openapi.cjs +18 -0
  32. package/dist/agents/toolkits/openapi/openapi.d.ts +18 -0
  33. package/dist/agents/toolkits/openapi/openapi.js +18 -0
  34. package/dist/agents/toolkits/sql/sql.cjs +8 -0
  35. package/dist/agents/toolkits/sql/sql.d.ts +8 -0
  36. package/dist/agents/toolkits/sql/sql.js +8 -0
  37. package/dist/agents/toolkits/vectorstore/vectorstore.cjs +16 -0
  38. package/dist/agents/toolkits/vectorstore/vectorstore.d.ts +16 -0
  39. package/dist/agents/toolkits/vectorstore/vectorstore.js +16 -0
  40. package/dist/agents/toolkits/zapier/zapier.cjs +10 -0
  41. package/dist/agents/toolkits/zapier/zapier.d.ts +10 -0
  42. package/dist/agents/toolkits/zapier/zapier.js +10 -0
  43. package/dist/agents/xml/output_parser.cjs +21 -0
  44. package/dist/agents/xml/output_parser.d.ts +21 -0
  45. package/dist/agents/xml/output_parser.js +21 -0
  46. package/dist/cache/cloudflare_kv.cjs +13 -0
  47. package/dist/cache/cloudflare_kv.d.ts +13 -0
  48. package/dist/cache/cloudflare_kv.js +13 -0
  49. package/dist/cache/file_system.cjs +73 -0
  50. package/dist/cache/file_system.d.ts +33 -0
  51. package/dist/cache/file_system.js +66 -0
  52. package/dist/cache/ioredis.cjs +13 -0
  53. package/dist/cache/ioredis.d.ts +13 -0
  54. package/dist/cache/ioredis.js +13 -0
  55. package/dist/cache/momento.cjs +19 -0
  56. package/dist/cache/momento.d.ts +19 -0
  57. package/dist/cache/momento.js +19 -0
  58. package/dist/cache/redis.cjs +10 -0
  59. package/dist/cache/redis.d.ts +10 -0
  60. package/dist/cache/redis.js +10 -0
  61. package/dist/cache/upstash_redis.cjs +15 -0
  62. package/dist/cache/upstash_redis.d.ts +15 -0
  63. package/dist/cache/upstash_redis.js +15 -0
  64. package/dist/callbacks/handlers/console.cjs +10 -0
  65. package/dist/callbacks/handlers/console.d.ts +10 -0
  66. package/dist/callbacks/handlers/console.js +10 -0
  67. package/dist/callbacks/manager.cjs +49 -0
  68. package/dist/callbacks/manager.d.ts +49 -0
  69. package/dist/callbacks/manager.js +49 -0
  70. package/dist/chains/analyze_documents_chain.cjs +18 -0
  71. package/dist/chains/analyze_documents_chain.d.ts +18 -0
  72. package/dist/chains/analyze_documents_chain.js +18 -0
  73. package/dist/chains/constitutional_ai/constitutional_chain.cjs +21 -0
  74. package/dist/chains/constitutional_ai/constitutional_chain.d.ts +21 -0
  75. package/dist/chains/constitutional_ai/constitutional_chain.js +21 -0
  76. package/dist/chains/constitutional_ai/constitutional_principle.cjs +21 -0
  77. package/dist/chains/constitutional_ai/constitutional_principle.d.ts +21 -0
  78. package/dist/chains/constitutional_ai/constitutional_principle.js +21 -0
  79. package/dist/chains/conversation.cjs +13 -0
  80. package/dist/chains/conversation.d.ts +13 -0
  81. package/dist/chains/conversation.js +13 -0
  82. package/dist/chains/conversational_retrieval_chain.cjs +29 -0
  83. package/dist/chains/conversational_retrieval_chain.d.ts +29 -0
  84. package/dist/chains/conversational_retrieval_chain.js +29 -0
  85. package/dist/chains/graph_qa/cypher.cjs +10 -0
  86. package/dist/chains/graph_qa/cypher.d.ts +10 -0
  87. package/dist/chains/graph_qa/cypher.js +10 -0
  88. package/dist/chains/openai_moderation.cjs +28 -0
  89. package/dist/chains/openai_moderation.d.ts +28 -0
  90. package/dist/chains/openai_moderation.js +28 -0
  91. package/dist/chains/retrieval_qa.cjs +21 -0
  92. package/dist/chains/retrieval_qa.d.ts +21 -0
  93. package/dist/chains/retrieval_qa.js +21 -0
  94. package/dist/chains/router/multi_prompt.cjs +19 -0
  95. package/dist/chains/router/multi_prompt.d.ts +19 -0
  96. package/dist/chains/router/multi_prompt.js +19 -0
  97. package/dist/chains/router/multi_retrieval_qa.cjs +29 -0
  98. package/dist/chains/router/multi_retrieval_qa.d.ts +29 -0
  99. package/dist/chains/router/multi_retrieval_qa.js +29 -0
  100. package/dist/chains/sequential_chain.cjs +43 -0
  101. package/dist/chains/sequential_chain.d.ts +43 -0
  102. package/dist/chains/sequential_chain.js +43 -0
  103. package/dist/chains/sql_db/sql_db_chain.cjs +9 -0
  104. package/dist/chains/sql_db/sql_db_chain.d.ts +9 -0
  105. package/dist/chains/sql_db/sql_db_chain.js +9 -0
  106. package/dist/chat_models/anthropic.cjs +9 -1
  107. package/dist/chat_models/anthropic.d.ts +9 -1
  108. package/dist/chat_models/anthropic.js +9 -1
  109. package/dist/chat_models/baiduwenxin.cjs +20 -0
  110. package/dist/chat_models/baiduwenxin.d.ts +20 -0
  111. package/dist/chat_models/baiduwenxin.js +20 -0
  112. package/dist/chat_models/base.cjs +2 -0
  113. package/dist/chat_models/base.d.ts +1 -1
  114. package/dist/chat_models/base.js +2 -0
  115. package/dist/chat_models/bedrock/index.cjs +11 -0
  116. package/dist/chat_models/bedrock/index.d.ts +11 -0
  117. package/dist/chat_models/bedrock/index.js +11 -0
  118. package/dist/chat_models/bedrock/web.cjs +10 -1
  119. package/dist/chat_models/bedrock/web.d.ts +9 -0
  120. package/dist/chat_models/bedrock/web.js +10 -1
  121. package/dist/chat_models/cloudflare_workersai.cjs +15 -0
  122. package/dist/chat_models/cloudflare_workersai.d.ts +15 -0
  123. package/dist/chat_models/cloudflare_workersai.js +15 -0
  124. package/dist/chat_models/fake.cjs +16 -0
  125. package/dist/chat_models/fake.d.ts +16 -0
  126. package/dist/chat_models/fake.js +16 -0
  127. package/dist/chat_models/fireworks.cjs +10 -0
  128. package/dist/chat_models/fireworks.d.ts +10 -0
  129. package/dist/chat_models/fireworks.js +10 -0
  130. package/dist/chat_models/googlepalm.cjs +24 -0
  131. package/dist/chat_models/googlepalm.d.ts +24 -0
  132. package/dist/chat_models/googlepalm.js +24 -0
  133. package/dist/chat_models/googlevertexai/index.cjs +7 -0
  134. package/dist/chat_models/googlevertexai/index.d.ts +7 -0
  135. package/dist/chat_models/googlevertexai/index.js +7 -0
  136. package/dist/chat_models/googlevertexai/web.cjs +9 -0
  137. package/dist/chat_models/googlevertexai/web.d.ts +9 -0
  138. package/dist/chat_models/googlevertexai/web.js +9 -0
  139. package/dist/chat_models/iflytek_xinghuo/index.cjs +8 -0
  140. package/dist/chat_models/iflytek_xinghuo/index.d.ts +8 -0
  141. package/dist/chat_models/iflytek_xinghuo/index.js +8 -0
  142. package/dist/chat_models/iflytek_xinghuo/web.cjs +8 -0
  143. package/dist/chat_models/iflytek_xinghuo/web.d.ts +8 -0
  144. package/dist/chat_models/iflytek_xinghuo/web.js +8 -0
  145. package/dist/chat_models/llama_cpp.cjs +17 -0
  146. package/dist/chat_models/llama_cpp.d.ts +17 -0
  147. package/dist/chat_models/llama_cpp.js +17 -0
  148. package/dist/chat_models/minimax.cjs +27 -0
  149. package/dist/chat_models/minimax.d.ts +27 -0
  150. package/dist/chat_models/minimax.js +27 -0
  151. package/dist/chat_models/ollama.cjs +24 -0
  152. package/dist/chat_models/ollama.d.ts +24 -0
  153. package/dist/chat_models/ollama.js +24 -0
  154. package/dist/chat_models/openai.cjs +15 -0
  155. package/dist/chat_models/openai.d.ts +15 -0
  156. package/dist/chat_models/openai.js +15 -0
  157. package/dist/chat_models/yandex.cjs +14 -0
  158. package/dist/chat_models/yandex.d.ts +14 -0
  159. package/dist/chat_models/yandex.js +14 -0
  160. package/dist/document_loaders/fs/directory.cjs +14 -0
  161. package/dist/document_loaders/fs/directory.d.ts +14 -0
  162. package/dist/document_loaders/fs/directory.js +14 -0
  163. package/dist/document_loaders/fs/openai_whisper_audio.cjs +10 -0
  164. package/dist/document_loaders/fs/openai_whisper_audio.d.ts +10 -0
  165. package/dist/document_loaders/fs/openai_whisper_audio.js +10 -0
  166. package/dist/document_loaders/fs/pdf.cjs +15 -2
  167. package/dist/document_loaders/fs/pdf.d.ts +9 -1
  168. package/dist/document_loaders/fs/pdf.js +15 -2
  169. package/dist/document_loaders/fs/srt.cjs +6 -0
  170. package/dist/document_loaders/fs/srt.d.ts +6 -0
  171. package/dist/document_loaders/fs/srt.js +6 -0
  172. package/dist/document_loaders/fs/text.cjs +5 -0
  173. package/dist/document_loaders/fs/text.d.ts +5 -0
  174. package/dist/document_loaders/fs/text.js +5 -0
  175. package/dist/document_loaders/fs/unstructured.cjs +7 -0
  176. package/dist/document_loaders/fs/unstructured.d.ts +7 -0
  177. package/dist/document_loaders/fs/unstructured.js +7 -0
  178. package/dist/document_loaders/web/apify_dataset.cjs +26 -2
  179. package/dist/document_loaders/web/apify_dataset.d.ts +25 -1
  180. package/dist/document_loaders/web/apify_dataset.js +26 -2
  181. package/dist/document_loaders/web/assemblyai.cjs +24 -0
  182. package/dist/document_loaders/web/assemblyai.d.ts +24 -0
  183. package/dist/document_loaders/web/assemblyai.js +24 -0
  184. package/dist/document_loaders/web/azure_blob_storage_file.cjs +11 -0
  185. package/dist/document_loaders/web/azure_blob_storage_file.d.ts +11 -0
  186. package/dist/document_loaders/web/azure_blob_storage_file.js +11 -0
  187. package/dist/document_loaders/web/cheerio.cjs +6 -0
  188. package/dist/document_loaders/web/cheerio.d.ts +6 -0
  189. package/dist/document_loaders/web/cheerio.js +6 -0
  190. package/dist/document_loaders/web/college_confidential.cjs +6 -0
  191. package/dist/document_loaders/web/college_confidential.d.ts +6 -0
  192. package/dist/document_loaders/web/college_confidential.js +6 -0
  193. package/dist/document_loaders/web/confluence.cjs +11 -0
  194. package/dist/document_loaders/web/confluence.d.ts +11 -0
  195. package/dist/document_loaders/web/confluence.js +11 -0
  196. package/dist/document_loaders/web/figma.cjs +9 -0
  197. package/dist/document_loaders/web/figma.d.ts +9 -0
  198. package/dist/document_loaders/web/figma.js +9 -0
  199. package/dist/document_loaders/web/notionapi.cjs +16 -0
  200. package/dist/document_loaders/web/notionapi.d.ts +16 -0
  201. package/dist/document_loaders/web/notionapi.js +16 -0
  202. package/dist/document_loaders/web/notiondb.cjs +11 -1
  203. package/dist/document_loaders/web/notiondb.d.ts +11 -1
  204. package/dist/document_loaders/web/notiondb.js +11 -1
  205. package/dist/document_loaders/web/pdf.cjs +15 -2
  206. package/dist/document_loaders/web/pdf.d.ts +9 -1
  207. package/dist/document_loaders/web/pdf.js +15 -2
  208. package/dist/document_loaders/web/puppeteer.cjs +12 -0
  209. package/dist/document_loaders/web/puppeteer.d.ts +12 -0
  210. package/dist/document_loaders/web/puppeteer.js +12 -0
  211. package/dist/document_loaders/web/s3.cjs +17 -0
  212. package/dist/document_loaders/web/s3.d.ts +17 -0
  213. package/dist/document_loaders/web/s3.js +17 -0
  214. package/dist/document_loaders/web/searchapi.cjs +9 -0
  215. package/dist/document_loaders/web/searchapi.d.ts +9 -0
  216. package/dist/document_loaders/web/searchapi.js +9 -0
  217. package/dist/document_loaders/web/serpapi.cjs +5 -0
  218. package/dist/document_loaders/web/serpapi.d.ts +5 -0
  219. package/dist/document_loaders/web/serpapi.js +5 -0
  220. package/dist/document_loaders/web/sonix_audio.cjs +12 -0
  221. package/dist/document_loaders/web/sonix_audio.d.ts +12 -0
  222. package/dist/document_loaders/web/sonix_audio.js +12 -0
  223. package/dist/document_loaders/web/sort_xyz_blockchain.cjs +22 -0
  224. package/dist/document_loaders/web/sort_xyz_blockchain.d.ts +22 -0
  225. package/dist/document_loaders/web/sort_xyz_blockchain.js +22 -0
  226. package/dist/document_loaders/web/youtube.cjs +9 -0
  227. package/dist/document_loaders/web/youtube.d.ts +9 -0
  228. package/dist/document_loaders/web/youtube.js +9 -0
  229. package/dist/document_transformers/html_to_text.cjs +18 -0
  230. package/dist/document_transformers/html_to_text.d.ts +18 -0
  231. package/dist/document_transformers/html_to_text.js +18 -0
  232. package/dist/document_transformers/mozilla_readability.cjs +18 -0
  233. package/dist/document_transformers/mozilla_readability.d.ts +18 -0
  234. package/dist/document_transformers/mozilla_readability.js +18 -0
  235. package/dist/embeddings/bedrock.cjs +17 -0
  236. package/dist/embeddings/bedrock.d.ts +17 -0
  237. package/dist/embeddings/bedrock.js +17 -0
  238. package/dist/embeddings/cache_backed.cjs +37 -0
  239. package/dist/embeddings/cache_backed.d.ts +37 -0
  240. package/dist/embeddings/cache_backed.js +37 -0
  241. package/dist/embeddings/cohere.cjs +10 -0
  242. package/dist/embeddings/cohere.d.ts +10 -0
  243. package/dist/embeddings/cohere.js +10 -0
  244. package/dist/embeddings/googlepalm.cjs +17 -0
  245. package/dist/embeddings/googlepalm.d.ts +17 -0
  246. package/dist/embeddings/googlepalm.js +17 -0
  247. package/dist/embeddings/googlevertexai.cjs +8 -0
  248. package/dist/embeddings/googlevertexai.d.ts +8 -0
  249. package/dist/embeddings/googlevertexai.js +8 -0
  250. package/dist/embeddings/hf_transformers.cjs +18 -0
  251. package/dist/embeddings/hf_transformers.d.ts +18 -0
  252. package/dist/embeddings/hf_transformers.js +18 -0
  253. package/dist/embeddings/llama_cpp.cjs +16 -0
  254. package/dist/embeddings/llama_cpp.d.ts +16 -0
  255. package/dist/embeddings/llama_cpp.js +16 -0
  256. package/dist/embeddings/minimax.cjs +15 -0
  257. package/dist/embeddings/minimax.d.ts +15 -0
  258. package/dist/embeddings/minimax.js +15 -0
  259. package/dist/embeddings/openai.cjs +10 -0
  260. package/dist/embeddings/openai.d.ts +10 -0
  261. package/dist/embeddings/openai.js +10 -0
  262. package/dist/embeddings/tensorflow.cjs +16 -0
  263. package/dist/embeddings/tensorflow.d.ts +16 -0
  264. package/dist/embeddings/tensorflow.js +16 -0
  265. package/dist/experimental/autogpt/agent.cjs +21 -0
  266. package/dist/experimental/autogpt/agent.d.ts +21 -0
  267. package/dist/experimental/autogpt/agent.js +21 -0
  268. package/dist/experimental/babyagi/agent.cjs +12 -0
  269. package/dist/experimental/babyagi/agent.d.ts +12 -0
  270. package/dist/experimental/babyagi/agent.js +12 -0
  271. package/dist/experimental/chat_models/ollama_functions.cjs +12 -15
  272. package/dist/experimental/chat_models/ollama_functions.d.ts +3 -4
  273. package/dist/experimental/chat_models/ollama_functions.js +13 -16
  274. package/dist/experimental/generative_agents/generative_agent.cjs +30 -0
  275. package/dist/experimental/generative_agents/generative_agent.d.ts +30 -0
  276. package/dist/experimental/generative_agents/generative_agent.js +30 -0
  277. package/dist/experimental/generative_agents/generative_agent_memory.cjs +18 -0
  278. package/dist/experimental/generative_agents/generative_agent_memory.d.ts +18 -0
  279. package/dist/experimental/generative_agents/generative_agent_memory.js +18 -0
  280. package/dist/llms/base.cjs +3 -1
  281. package/dist/llms/base.d.ts +1 -1
  282. package/dist/llms/base.js +3 -1
  283. package/dist/llms/bedrock/web.cjs +1 -1
  284. package/dist/llms/bedrock/web.js +1 -1
  285. package/dist/llms/cohere.cjs +13 -0
  286. package/dist/llms/cohere.d.ts +13 -0
  287. package/dist/llms/cohere.js +13 -0
  288. package/dist/llms/googlevertexai/index.cjs +12 -0
  289. package/dist/llms/googlevertexai/index.d.ts +12 -0
  290. package/dist/llms/googlevertexai/index.js +12 -0
  291. package/dist/llms/googlevertexai/web.cjs +12 -0
  292. package/dist/llms/googlevertexai/web.d.ts +12 -0
  293. package/dist/llms/googlevertexai/web.js +12 -0
  294. package/dist/llms/hf.cjs +13 -0
  295. package/dist/llms/hf.d.ts +13 -0
  296. package/dist/llms/hf.js +13 -0
  297. package/dist/llms/ollama.cjs +19 -0
  298. package/dist/llms/ollama.d.ts +19 -0
  299. package/dist/llms/ollama.js +19 -0
  300. package/dist/llms/openai-chat.cjs +17 -0
  301. package/dist/llms/openai-chat.d.ts +17 -0
  302. package/dist/llms/openai-chat.js +17 -0
  303. package/dist/llms/openai.cjs +14 -0
  304. package/dist/llms/openai.d.ts +14 -0
  305. package/dist/llms/openai.js +14 -0
  306. package/dist/llms/portkey.cjs +24 -0
  307. package/dist/llms/portkey.d.ts +24 -0
  308. package/dist/llms/portkey.js +24 -0
  309. package/dist/llms/replicate.cjs +11 -0
  310. package/dist/llms/replicate.d.ts +11 -0
  311. package/dist/llms/replicate.js +11 -0
  312. package/dist/load/import_constants.cjs +2 -0
  313. package/dist/load/import_constants.js +2 -0
  314. package/dist/memory/buffer_memory.cjs +24 -0
  315. package/dist/memory/buffer_memory.d.ts +24 -0
  316. package/dist/memory/buffer_memory.js +24 -0
  317. package/dist/memory/buffer_token_memory.cjs +15 -0
  318. package/dist/memory/buffer_token_memory.d.ts +15 -0
  319. package/dist/memory/buffer_token_memory.js +15 -0
  320. package/dist/memory/buffer_window_memory.cjs +23 -0
  321. package/dist/memory/buffer_window_memory.d.ts +23 -0
  322. package/dist/memory/buffer_window_memory.js +23 -0
  323. package/dist/memory/entity_memory.cjs +29 -0
  324. package/dist/memory/entity_memory.d.ts +29 -0
  325. package/dist/memory/entity_memory.js +29 -0
  326. package/dist/memory/summary.cjs +24 -0
  327. package/dist/memory/summary.d.ts +24 -0
  328. package/dist/memory/summary.js +24 -0
  329. package/dist/memory/summary_buffer.cjs +32 -0
  330. package/dist/memory/summary_buffer.d.ts +32 -0
  331. package/dist/memory/summary_buffer.js +32 -0
  332. package/dist/memory/vector_store.cjs +24 -0
  333. package/dist/memory/vector_store.d.ts +24 -0
  334. package/dist/memory/vector_store.js +24 -0
  335. package/dist/memory/zep.cjs +34 -0
  336. package/dist/memory/zep.d.ts +34 -0
  337. package/dist/memory/zep.js +34 -0
  338. package/dist/prompts/chat.cjs +31 -0
  339. package/dist/prompts/chat.d.ts +31 -0
  340. package/dist/prompts/chat.js +31 -0
  341. package/dist/prompts/few_shot.cjs +31 -0
  342. package/dist/prompts/few_shot.d.ts +31 -0
  343. package/dist/prompts/few_shot.js +31 -0
  344. package/dist/prompts/pipeline.cjs +39 -0
  345. package/dist/prompts/pipeline.d.ts +39 -0
  346. package/dist/prompts/pipeline.js +39 -0
  347. package/dist/prompts/selectors/LengthBasedExampleSelector.cjs +36 -0
  348. package/dist/prompts/selectors/LengthBasedExampleSelector.d.ts +36 -0
  349. package/dist/prompts/selectors/LengthBasedExampleSelector.js +36 -0
  350. package/dist/prompts/selectors/SemanticSimilarityExampleSelector.cjs +25 -0
  351. package/dist/prompts/selectors/SemanticSimilarityExampleSelector.d.ts +25 -0
  352. package/dist/prompts/selectors/SemanticSimilarityExampleSelector.js +25 -0
  353. package/dist/retrievers/amazon_kendra.cjs +16 -0
  354. package/dist/retrievers/amazon_kendra.d.ts +16 -0
  355. package/dist/retrievers/amazon_kendra.js +16 -0
  356. package/dist/retrievers/chaindesk.cjs +11 -0
  357. package/dist/retrievers/chaindesk.d.ts +11 -0
  358. package/dist/retrievers/chaindesk.js +11 -0
  359. package/dist/retrievers/contextual_compression.cjs +10 -0
  360. package/dist/retrievers/contextual_compression.d.ts +10 -0
  361. package/dist/retrievers/contextual_compression.js +10 -0
  362. package/dist/retrievers/document_compressors/embeddings_filter.cjs +13 -0
  363. package/dist/retrievers/document_compressors/embeddings_filter.d.ts +13 -0
  364. package/dist/retrievers/document_compressors/embeddings_filter.js +13 -0
  365. package/dist/retrievers/document_compressors/index.cjs +26 -0
  366. package/dist/retrievers/document_compressors/index.d.ts +26 -0
  367. package/dist/retrievers/document_compressors/index.js +26 -0
  368. package/dist/retrievers/hyde.cjs +19 -0
  369. package/dist/retrievers/hyde.d.ts +19 -0
  370. package/dist/retrievers/hyde.js +19 -0
  371. package/dist/retrievers/metal.cjs +11 -0
  372. package/dist/retrievers/metal.d.ts +11 -0
  373. package/dist/retrievers/metal.js +11 -0
  374. package/dist/retrievers/multi_query.cjs +13 -1
  375. package/dist/retrievers/multi_query.d.ts +13 -0
  376. package/dist/retrievers/multi_query.js +13 -1
  377. package/dist/retrievers/multi_vector.cjs +13 -0
  378. package/dist/retrievers/multi_vector.d.ts +13 -0
  379. package/dist/retrievers/multi_vector.js +13 -0
  380. package/dist/retrievers/parent_document.cjs +21 -0
  381. package/dist/retrievers/parent_document.d.ts +21 -0
  382. package/dist/retrievers/parent_document.js +21 -0
  383. package/dist/retrievers/remote/chatgpt-plugin.cjs +10 -0
  384. package/dist/retrievers/remote/chatgpt-plugin.d.ts +10 -0
  385. package/dist/retrievers/remote/chatgpt-plugin.js +10 -0
  386. package/dist/retrievers/self_query/chroma.cjs +15 -0
  387. package/dist/retrievers/self_query/chroma.d.ts +15 -0
  388. package/dist/retrievers/self_query/chroma.js +15 -0
  389. package/dist/retrievers/self_query/functional.cjs +7 -0
  390. package/dist/retrievers/self_query/functional.d.ts +7 -0
  391. package/dist/retrievers/self_query/functional.js +7 -0
  392. package/dist/retrievers/self_query/index.cjs +13 -0
  393. package/dist/retrievers/self_query/index.d.ts +13 -0
  394. package/dist/retrievers/self_query/index.js +13 -0
  395. package/dist/retrievers/self_query/pinecone.cjs +14 -0
  396. package/dist/retrievers/self_query/pinecone.d.ts +14 -0
  397. package/dist/retrievers/self_query/pinecone.js +14 -0
  398. package/dist/retrievers/self_query/supabase.cjs +14 -0
  399. package/dist/retrievers/self_query/supabase.d.ts +14 -0
  400. package/dist/retrievers/self_query/supabase.js +14 -0
  401. package/dist/retrievers/self_query/weaviate.cjs +14 -0
  402. package/dist/retrievers/self_query/weaviate.d.ts +14 -0
  403. package/dist/retrievers/self_query/weaviate.js +14 -0
  404. package/dist/retrievers/time_weighted.cjs +16 -0
  405. package/dist/retrievers/time_weighted.d.ts +16 -0
  406. package/dist/retrievers/time_weighted.js +16 -0
  407. package/dist/retrievers/vespa.cjs +15 -0
  408. package/dist/retrievers/vespa.d.ts +15 -0
  409. package/dist/retrievers/vespa.js +15 -0
  410. package/dist/retrievers/zep.cjs +10 -0
  411. package/dist/retrievers/zep.d.ts +10 -0
  412. package/dist/retrievers/zep.js +10 -0
  413. package/dist/schema/index.d.ts +8 -6
  414. package/dist/schema/output_parser.cjs +15 -0
  415. package/dist/schema/output_parser.d.ts +15 -0
  416. package/dist/schema/output_parser.js +15 -0
  417. package/dist/schema/runnable/base.cjs +20 -0
  418. package/dist/schema/runnable/base.d.ts +20 -0
  419. package/dist/schema/runnable/base.js +20 -0
  420. package/dist/schema/runnable/branch.cjs +28 -0
  421. package/dist/schema/runnable/branch.d.ts +28 -0
  422. package/dist/schema/runnable/branch.js +28 -0
  423. package/dist/storage/file_system.cjs +21 -0
  424. package/dist/storage/file_system.d.ts +21 -0
  425. package/dist/storage/file_system.js +21 -0
  426. package/dist/storage/in_memory.cjs +15 -0
  427. package/dist/storage/in_memory.d.ts +15 -0
  428. package/dist/storage/in_memory.js +15 -0
  429. package/dist/storage/ioredis.cjs +24 -0
  430. package/dist/storage/ioredis.d.ts +24 -0
  431. package/dist/storage/ioredis.js +24 -0
  432. package/dist/storage/upstash_redis.cjs +19 -0
  433. package/dist/storage/upstash_redis.d.ts +19 -0
  434. package/dist/storage/upstash_redis.js +19 -0
  435. package/dist/storage/vercel_kv.cjs +16 -0
  436. package/dist/storage/vercel_kv.d.ts +16 -0
  437. package/dist/storage/vercel_kv.js +16 -0
  438. package/dist/stores/message/cassandra.cjs +25 -0
  439. package/dist/stores/message/cassandra.d.ts +25 -0
  440. package/dist/stores/message/cassandra.js +25 -0
  441. package/dist/stores/message/cloudflare_d1.cjs +18 -0
  442. package/dist/stores/message/cloudflare_d1.d.ts +18 -0
  443. package/dist/stores/message/cloudflare_d1.js +18 -0
  444. package/dist/stores/message/firestore.cjs +19 -0
  445. package/dist/stores/message/firestore.d.ts +19 -0
  446. package/dist/stores/message/firestore.js +19 -0
  447. package/dist/stores/message/ioredis.cjs +18 -0
  448. package/dist/stores/message/ioredis.d.ts +18 -0
  449. package/dist/stores/message/ioredis.js +18 -0
  450. package/dist/stores/message/momento.cjs +18 -0
  451. package/dist/stores/message/momento.d.ts +18 -0
  452. package/dist/stores/message/momento.js +18 -0
  453. package/dist/stores/message/mongodb.cjs +11 -0
  454. package/dist/stores/message/mongodb.d.ts +11 -0
  455. package/dist/stores/message/mongodb.js +11 -0
  456. package/dist/stores/message/planetscale.cjs +18 -0
  457. package/dist/stores/message/planetscale.d.ts +18 -0
  458. package/dist/stores/message/planetscale.js +18 -0
  459. package/dist/stores/message/redis.cjs +18 -0
  460. package/dist/stores/message/redis.d.ts +18 -0
  461. package/dist/stores/message/redis.js +18 -0
  462. package/dist/stores/message/xata.cjs +23 -0
  463. package/dist/stores/message/xata.d.ts +23 -0
  464. package/dist/stores/message/xata.js +23 -0
  465. package/dist/tools/calculator.cjs +6 -0
  466. package/dist/tools/calculator.d.ts +6 -0
  467. package/dist/tools/calculator.js +6 -0
  468. package/dist/tools/google_calendar/create.cjs +22 -0
  469. package/dist/tools/google_calendar/create.d.ts +22 -0
  470. package/dist/tools/google_calendar/create.js +22 -0
  471. package/dist/tools/google_calendar/view.cjs +20 -0
  472. package/dist/tools/google_calendar/view.d.ts +20 -0
  473. package/dist/tools/google_calendar/view.js +20 -0
  474. package/dist/tools/searchapi.cjs +27 -0
  475. package/dist/tools/searchapi.d.ts +27 -0
  476. package/dist/tools/searchapi.js +27 -0
  477. package/dist/tools/searxng_search.cjs +20 -1
  478. package/dist/tools/searxng_search.d.ts +20 -1
  479. package/dist/tools/searxng_search.js +20 -1
  480. package/dist/tools/webbrowser.cjs +8 -0
  481. package/dist/tools/webbrowser.d.ts +8 -0
  482. package/dist/tools/webbrowser.js +8 -0
  483. package/dist/tools/wikipedia_query_run.cjs +8 -0
  484. package/dist/tools/wikipedia_query_run.d.ts +8 -0
  485. package/dist/tools/wikipedia_query_run.js +8 -0
  486. package/dist/tools/wolframalpha.cjs +9 -0
  487. package/dist/tools/wolframalpha.d.ts +9 -0
  488. package/dist/tools/wolframalpha.js +9 -0
  489. package/dist/util/googlevertexai-connection.cjs +3 -9
  490. package/dist/util/googlevertexai-connection.js +3 -9
  491. package/dist/vectorstores/opensearch.cjs +2 -1
  492. package/dist/vectorstores/opensearch.js +2 -1
  493. package/dist/vectorstores/prisma.cjs +20 -2
  494. package/dist/vectorstores/prisma.d.ts +4 -0
  495. package/dist/vectorstores/prisma.js +20 -2
  496. package/dist/vectorstores/rockset.cjs +353 -0
  497. package/dist/vectorstores/rockset.d.ts +202 -0
  498. package/dist/vectorstores/rockset.js +347 -0
  499. package/package.json +24 -5
  500. package/vectorstores/rockset.cjs +1 -0
  501. package/vectorstores/rockset.d.ts +1 -0
  502. package/vectorstores/rockset.js +1 -0
@@ -7,6 +7,27 @@ import { getEnvironmentVariable } from "../../util/env.js";
7
7
  * A class that extends the BaseDocumentLoader and implements the
8
8
  * DocumentLoader interface. It represents a document loader that loads
9
9
  * documents from an Apify dataset.
10
+ * @example
11
+ * ```typescript
12
+ * const loader = new ApifyDatasetLoader("your-dataset-id", {
13
+ * datasetMappingFunction: (item) =>
14
+ * new Document({
15
+ * pageContent: item.text || "",
16
+ * metadata: { source: item.url },
17
+ * }),
18
+ * clientOptions: {
19
+ * token: "your-apify-token",
20
+ * },
21
+ * });
22
+ *
23
+ * const docs = await loader.load();
24
+ *
25
+ * const chain = new RetrievalQAChain();
26
+ * const res = await chain.invoke({ query: "What is LangChain?" });
27
+ *
28
+ * console.log(res.text);
29
+ * console.log(res.sourceDocuments.map((d) => d.metadata.source));
30
+ * ```
10
31
  */
11
32
  export class ApifyDatasetLoader extends BaseDocumentLoader {
12
33
  constructor(datasetId, config) {
@@ -52,8 +73,11 @@ export class ApifyDatasetLoader extends BaseDocumentLoader {
52
73
  * @returns An array of Document instances.
53
74
  */
54
75
  async load() {
55
- const datasetItems = (await this.apifyClient.dataset(this.datasetId).listItems({ clean: true })).items;
56
- return await Promise.all(datasetItems.map((item) => this.caller.call(async () => this.datasetMappingFunction(item))));
76
+ const dataset = await this.apifyClient
77
+ .dataset(this.datasetId)
78
+ .listItems({ clean: true });
79
+ const documentList = await Promise.all(dataset.items.map((item) => this.caller.call(async () => this.datasetMappingFunction(item))));
80
+ return documentList.flat();
57
81
  }
58
82
  /**
59
83
  * Create an ApifyDatasetLoader by calling an Actor on the Apify platform and waiting for its results to be ready.
@@ -74,6 +74,15 @@ class CreateTranscriptLoader extends AssemblyAILoader {
74
74
  }
75
75
  /**
76
76
  * Creates and loads the transcript as a document using AssemblyAI.
77
+ * @example
78
+ * ```typescript
79
+ * const loader = new AudioTranscriptLoader(
80
+ * { audio_url: "https:
81
+ * { apiKey: "ASSEMBLYAI_API_KEY" },
82
+ * );
83
+ * const docs = await loader.load();
84
+ * console.dir(docs, { depth: Infinity });
85
+ * ```
77
86
  */
78
87
  class AudioTranscriptLoader extends CreateTranscriptLoader {
79
88
  /**
@@ -131,6 +140,21 @@ class AudioTranscriptSentencesLoader extends CreateTranscriptLoader {
131
140
  exports.AudioTranscriptSentencesLoader = AudioTranscriptSentencesLoader;
132
141
  /**
133
142
  * Creates a transcript and loads subtitles for the transcript as `srt` or `vtt` format.
143
+ * @example
144
+ * ```typescript
145
+ * const loader = new AudioSubtitleLoader(
146
+ * {
147
+ * audio_url: "https:
148
+ * },
149
+ * "srt",
150
+ * {
151
+ * apiKey: "<ASSEMBLYAI_API_KEY>",
152
+ * },
153
+ * );
154
+ *
155
+ *
156
+ * const docs = await loader.load();
157
+ * ```
134
158
  */
135
159
  class AudioSubtitleLoader extends CreateTranscriptLoader {
136
160
  /**
@@ -29,6 +29,15 @@ declare abstract class CreateTranscriptLoader extends AssemblyAILoader {
29
29
  }
30
30
  /**
31
31
  * Creates and loads the transcript as a document using AssemblyAI.
32
+ * @example
33
+ * ```typescript
34
+ * const loader = new AudioTranscriptLoader(
35
+ * { audio_url: "https:
36
+ * { apiKey: "ASSEMBLYAI_API_KEY" },
37
+ * );
38
+ * const docs = await loader.load();
39
+ * console.dir(docs, { depth: Infinity });
40
+ * ```
32
41
  */
33
42
  export declare class AudioTranscriptLoader extends CreateTranscriptLoader {
34
43
  /**
@@ -61,6 +70,21 @@ export declare class AudioTranscriptSentencesLoader extends CreateTranscriptLoad
61
70
  }
62
71
  /**
63
72
  * Creates a transcript and loads subtitles for the transcript as `srt` or `vtt` format.
73
+ * @example
74
+ * ```typescript
75
+ * const loader = new AudioSubtitleLoader(
76
+ * {
77
+ * audio_url: "https:
78
+ * },
79
+ * "srt",
80
+ * {
81
+ * apiKey: "<ASSEMBLYAI_API_KEY>",
82
+ * },
83
+ * );
84
+ *
85
+ *
86
+ * const docs = await loader.load();
87
+ * ```
64
88
  */
65
89
  export declare class AudioSubtitleLoader extends CreateTranscriptLoader {
66
90
  private subtitleFormat;
@@ -71,6 +71,15 @@ class CreateTranscriptLoader extends AssemblyAILoader {
71
71
  }
72
72
  /**
73
73
  * Creates and loads the transcript as a document using AssemblyAI.
74
+ * @example
75
+ * ```typescript
76
+ * const loader = new AudioTranscriptLoader(
77
+ * { audio_url: "https:
78
+ * { apiKey: "ASSEMBLYAI_API_KEY" },
79
+ * );
80
+ * const docs = await loader.load();
81
+ * console.dir(docs, { depth: Infinity });
82
+ * ```
74
83
  */
75
84
  export class AudioTranscriptLoader extends CreateTranscriptLoader {
76
85
  /**
@@ -125,6 +134,21 @@ export class AudioTranscriptSentencesLoader extends CreateTranscriptLoader {
125
134
  }
126
135
  /**
127
136
  * Creates a transcript and loads subtitles for the transcript as `srt` or `vtt` format.
137
+ * @example
138
+ * ```typescript
139
+ * const loader = new AudioSubtitleLoader(
140
+ * {
141
+ * audio_url: "https:
142
+ * },
143
+ * "srt",
144
+ * {
145
+ * apiKey: "<ASSEMBLYAI_API_KEY>",
146
+ * },
147
+ * );
148
+ *
149
+ *
150
+ * const docs = await loader.load();
151
+ * ```
128
152
  */
129
153
  export class AudioSubtitleLoader extends CreateTranscriptLoader {
130
154
  /**
@@ -34,6 +34,17 @@ const unstructured_js_1 = require("../fs/unstructured.cjs");
34
34
  * Class representing a document loader that loads a specific file from
35
35
  * Azure Blob Storage. It extends the BaseDocumentLoader class and
36
36
  * implements the DocumentLoader interface.
37
+ * @example
38
+ * ```typescript
39
+ * const loader = new AzureBlobStorageFileLoader({
40
+ * azureConfig: {
41
+ * connectionString: "{connectionString}",
42
+ * container: "{containerName}",
43
+ * blobName: "{blobName}",
44
+ * },
45
+ * });
46
+ * const docs = await loader.load();
47
+ * ```
37
48
  */
38
49
  class AzureBlobStorageFileLoader extends base_js_1.BaseDocumentLoader {
39
50
  constructor({ azureConfig, unstructuredConfig, }) {
@@ -22,6 +22,17 @@ interface AzureBlobStorageFileLoaderConfig {
22
22
  * Class representing a document loader that loads a specific file from
23
23
  * Azure Blob Storage. It extends the BaseDocumentLoader class and
24
24
  * implements the DocumentLoader interface.
25
+ * @example
26
+ * ```typescript
27
+ * const loader = new AzureBlobStorageFileLoader({
28
+ * azureConfig: {
29
+ * connectionString: "{connectionString}",
30
+ * container: "{containerName}",
31
+ * blobName: "{blobName}",
32
+ * },
33
+ * });
34
+ * const docs = await loader.load();
35
+ * ```
25
36
  */
26
37
  export declare class AzureBlobStorageFileLoader extends BaseDocumentLoader {
27
38
  private readonly connectionString;
@@ -8,6 +8,17 @@ import { UnstructuredLoader, } from "../fs/unstructured.js";
8
8
  * Class representing a document loader that loads a specific file from
9
9
  * Azure Blob Storage. It extends the BaseDocumentLoader class and
10
10
  * implements the DocumentLoader interface.
11
+ * @example
12
+ * ```typescript
13
+ * const loader = new AzureBlobStorageFileLoader({
14
+ * azureConfig: {
15
+ * connectionString: "{connectionString}",
16
+ * container: "{containerName}",
17
+ * blobName: "{blobName}",
18
+ * },
19
+ * });
20
+ * const docs = await loader.load();
21
+ * ```
11
22
  */
12
23
  export class AzureBlobStorageFileLoader extends BaseDocumentLoader {
13
24
  constructor({ azureConfig, unstructuredConfig, }) {
@@ -8,6 +8,12 @@ const async_caller_js_1 = require("../../util/async_caller.cjs");
8
8
  * A class that extends the BaseDocumentLoader and implements the
9
9
  * DocumentLoader interface. It represents a document loader for loading
10
10
  * web-based documents using Cheerio.
11
+ * @example
12
+ * ```typescript
13
+ * const loader = new CheerioWebBaseLoader("https:exampleurl.com");
14
+ * const docs = await loader.load();
15
+ * console.log({ docs });
16
+ * ```
11
17
  */
12
18
  class CheerioWebBaseLoader extends base_js_1.BaseDocumentLoader {
13
19
  constructor(webPath, fields) {
@@ -27,6 +27,12 @@ export interface WebBaseLoaderParams extends AsyncCallerParams {
27
27
  * A class that extends the BaseDocumentLoader and implements the
28
28
  * DocumentLoader interface. It represents a document loader for loading
29
29
  * web-based documents using Cheerio.
30
+ * @example
31
+ * ```typescript
32
+ * const loader = new CheerioWebBaseLoader("https:exampleurl.com");
33
+ * const docs = await loader.load();
34
+ * console.log({ docs });
35
+ * ```
30
36
  */
31
37
  export declare class CheerioWebBaseLoader extends BaseDocumentLoader implements DocumentLoader {
32
38
  webPath: string;
@@ -5,6 +5,12 @@ import { AsyncCaller } from "../../util/async_caller.js";
5
5
  * A class that extends the BaseDocumentLoader and implements the
6
6
  * DocumentLoader interface. It represents a document loader for loading
7
7
  * web-based documents using Cheerio.
8
+ * @example
9
+ * ```typescript
10
+ * const loader = new CheerioWebBaseLoader("https:exampleurl.com");
11
+ * const docs = await loader.load();
12
+ * console.log({ docs });
13
+ * ```
8
14
  */
9
15
  export class CheerioWebBaseLoader extends BaseDocumentLoader {
10
16
  constructor(webPath, fields) {
@@ -6,6 +6,12 @@ const cheerio_js_1 = require("./cheerio.cjs");
6
6
  /**
7
7
  * A document loader specifically designed for loading documents from the
8
8
  * College Confidential website. It extends the CheerioWebBaseLoader.
9
+ * @example
10
+ * ```typescript
11
+ * const loader = new CollegeConfidentialLoader("https:exampleurl.com");
12
+ * const docs = await loader.load();
13
+ * console.log({ docs });
14
+ * ```
9
15
  */
10
16
  class CollegeConfidentialLoader extends cheerio_js_1.CheerioWebBaseLoader {
11
17
  constructor(webPath) {
@@ -3,6 +3,12 @@ import { CheerioWebBaseLoader } from "./cheerio.js";
3
3
  /**
4
4
  * A document loader specifically designed for loading documents from the
5
5
  * College Confidential website. It extends the CheerioWebBaseLoader.
6
+ * @example
7
+ * ```typescript
8
+ * const loader = new CollegeConfidentialLoader("https:exampleurl.com");
9
+ * const docs = await loader.load();
10
+ * console.log({ docs });
11
+ * ```
6
12
  */
7
13
  export declare class CollegeConfidentialLoader extends CheerioWebBaseLoader {
8
14
  constructor(webPath: string);
@@ -3,6 +3,12 @@ import { CheerioWebBaseLoader } from "./cheerio.js";
3
3
  /**
4
4
  * A document loader specifically designed for loading documents from the
5
5
  * College Confidential website. It extends the CheerioWebBaseLoader.
6
+ * @example
7
+ * ```typescript
8
+ * const loader = new CollegeConfidentialLoader("https:exampleurl.com");
9
+ * const docs = await loader.load();
10
+ * console.log({ docs });
11
+ * ```
6
12
  */
7
13
  export class CollegeConfidentialLoader extends CheerioWebBaseLoader {
8
14
  constructor(webPath) {
@@ -6,6 +6,17 @@ const document_js_1 = require("../../document.cjs");
6
6
  const base_js_1 = require("../base.cjs");
7
7
  /**
8
8
  * Class representing a document loader for loading pages from Confluence.
9
+ * @example
10
+ * ```typescript
11
+ * const loader = new ConfluencePagesLoader({
12
+ * baseUrl: "https:
13
+ * spaceKey: "~EXAMPLE362906de5d343d49dcdbae5dEXAMPLE",
14
+ * username: "your-username",
15
+ * accessToken: "your-access-token",
16
+ * });
17
+ * const documents = await loader.load();
18
+ * console.log(documents);
19
+ * ```
9
20
  */
10
21
  class ConfluencePagesLoader extends base_js_1.BaseDocumentLoader {
11
22
  constructor({ baseUrl, spaceKey, username, accessToken, limit = 25, }) {
@@ -32,6 +32,17 @@ export interface ConfluenceAPIResponse {
32
32
  }
33
33
  /**
34
34
  * Class representing a document loader for loading pages from Confluence.
35
+ * @example
36
+ * ```typescript
37
+ * const loader = new ConfluencePagesLoader({
38
+ * baseUrl: "https:
39
+ * spaceKey: "~EXAMPLE362906de5d343d49dcdbae5dEXAMPLE",
40
+ * username: "your-username",
41
+ * accessToken: "your-access-token",
42
+ * });
43
+ * const documents = await loader.load();
44
+ * console.log(documents);
45
+ * ```
35
46
  */
36
47
  export declare class ConfluencePagesLoader extends BaseDocumentLoader {
37
48
  readonly baseUrl: string;
@@ -3,6 +3,17 @@ import { Document } from "../../document.js";
3
3
  import { BaseDocumentLoader } from "../base.js";
4
4
  /**
5
5
  * Class representing a document loader for loading pages from Confluence.
6
+ * @example
7
+ * ```typescript
8
+ * const loader = new ConfluencePagesLoader({
9
+ * baseUrl: "https:
10
+ * spaceKey: "~EXAMPLE362906de5d343d49dcdbae5dEXAMPLE",
11
+ * username: "your-username",
12
+ * accessToken: "your-access-token",
13
+ * });
14
+ * const documents = await loader.load();
15
+ * console.log(documents);
16
+ * ```
6
17
  */
7
18
  export class ConfluencePagesLoader extends BaseDocumentLoader {
8
19
  constructor({ baseUrl, spaceKey, username, accessToken, limit = 25, }) {
@@ -9,6 +9,15 @@ const env_js_1 = require("../../util/env.cjs");
9
9
  * extends the BaseDocumentLoader and implements the FigmaLoaderParams
10
10
  * interface. The constructor takes a config object as a parameter, which
11
11
  * contains the access token, an array of node IDs, and the file key.
12
+ * @example
13
+ * ```typescript
14
+ * const loader = new FigmaFileLoader({
15
+ * accessToken: "FIGMA_ACCESS_TOKEN",
16
+ * nodeIds: ["id1", "id2", "id3"],
17
+ * fileKey: "key",
18
+ * });
19
+ * const docs = await loader.load();
20
+ * ```
12
21
  */
13
22
  class FigmaFileLoader extends base_js_1.BaseDocumentLoader {
14
23
  constructor({ accessToken = (0, env_js_1.getEnvironmentVariable)("FIGMA_ACCESS_TOKEN"), nodeIds, fileKey, }) {
@@ -39,6 +39,15 @@ export interface FigmaLoaderParams {
39
39
  * extends the BaseDocumentLoader and implements the FigmaLoaderParams
40
40
  * interface. The constructor takes a config object as a parameter, which
41
41
  * contains the access token, an array of node IDs, and the file key.
42
+ * @example
43
+ * ```typescript
44
+ * const loader = new FigmaFileLoader({
45
+ * accessToken: "FIGMA_ACCESS_TOKEN",
46
+ * nodeIds: ["id1", "id2", "id3"],
47
+ * fileKey: "key",
48
+ * });
49
+ * const docs = await loader.load();
50
+ * ```
42
51
  */
43
52
  export declare class FigmaFileLoader extends BaseDocumentLoader implements FigmaLoaderParams {
44
53
  accessToken?: string;
@@ -6,6 +6,15 @@ import { getEnvironmentVariable } from "../../util/env.js";
6
6
  * extends the BaseDocumentLoader and implements the FigmaLoaderParams
7
7
  * interface. The constructor takes a config object as a parameter, which
8
8
  * contains the access token, an array of node IDs, and the file key.
9
+ * @example
10
+ * ```typescript
11
+ * const loader = new FigmaFileLoader({
12
+ * accessToken: "FIGMA_ACCESS_TOKEN",
13
+ * nodeIds: ["id1", "id2", "id3"],
14
+ * fileKey: "key",
15
+ * });
16
+ * const docs = await loader.load();
17
+ * ```
9
18
  */
10
19
  export class FigmaFileLoader extends BaseDocumentLoader {
11
20
  constructor({ accessToken = getEnvironmentVariable("FIGMA_ACCESS_TOKEN"), nodeIds, fileKey, }) {
@@ -24,6 +24,22 @@ exports.isDatabase = isDatabase;
24
24
  /**
25
25
  * A class that extends the BaseDocumentLoader class. It represents a
26
26
  * document loader for loading documents from Notion using the Notion API.
27
+ * @example
28
+ * ```typescript
29
+ * const pageLoader = new NotionAPILoader({
30
+ * clientOptions: { auth: "<NOTION_INTEGRATION_TOKEN>" },
31
+ * id: "<PAGE_ID>",
32
+ * type: "page",
33
+ * });
34
+ * const pageDocs = await pageLoader.loadAndSplit();
35
+ * const dbLoader = new NotionAPILoader({
36
+ * clientOptions: { auth: "<NOTION_INTEGRATION_TOKEN>" },
37
+ * id: "<DATABASE_ID>",
38
+ * type: "database",
39
+ * propertiesAsHeader: true,
40
+ * });
41
+ * const dbDocs = await dbLoader.load();
42
+ * ```
27
43
  */
28
44
  class NotionAPILoader extends base_js_1.BaseDocumentLoader {
29
45
  constructor(options) {
@@ -34,6 +34,22 @@ export type NotionAPILoaderOptions = {
34
34
  /**
35
35
  * A class that extends the BaseDocumentLoader class. It represents a
36
36
  * document loader for loading documents from Notion using the Notion API.
37
+ * @example
38
+ * ```typescript
39
+ * const pageLoader = new NotionAPILoader({
40
+ * clientOptions: { auth: "<NOTION_INTEGRATION_TOKEN>" },
41
+ * id: "<PAGE_ID>",
42
+ * type: "page",
43
+ * });
44
+ * const pageDocs = await pageLoader.loadAndSplit();
45
+ * const dbLoader = new NotionAPILoader({
46
+ * clientOptions: { auth: "<NOTION_INTEGRATION_TOKEN>" },
47
+ * id: "<DATABASE_ID>",
48
+ * type: "database",
49
+ * propertiesAsHeader: true,
50
+ * });
51
+ * const dbDocs = await dbLoader.load();
52
+ * ```
37
53
  */
38
54
  export declare class NotionAPILoader extends BaseDocumentLoader {
39
55
  private caller;
@@ -13,6 +13,22 @@ export const isDatabase = (res) => isDatabaseResponse(res) && isFullDatabase(res
13
13
  /**
14
14
  * A class that extends the BaseDocumentLoader class. It represents a
15
15
  * document loader for loading documents from Notion using the Notion API.
16
+ * @example
17
+ * ```typescript
18
+ * const pageLoader = new NotionAPILoader({
19
+ * clientOptions: { auth: "<NOTION_INTEGRATION_TOKEN>" },
20
+ * id: "<PAGE_ID>",
21
+ * type: "page",
22
+ * });
23
+ * const pageDocs = await pageLoader.loadAndSplit();
24
+ * const dbLoader = new NotionAPILoader({
25
+ * clientOptions: { auth: "<NOTION_INTEGRATION_TOKEN>" },
26
+ * id: "<DATABASE_ID>",
27
+ * type: "database",
28
+ * propertiesAsHeader: true,
29
+ * });
30
+ * const dbDocs = await dbLoader.load();
31
+ * ```
16
32
  */
17
33
  export class NotionAPILoader extends BaseDocumentLoader {
18
34
  constructor(options) {
@@ -4,7 +4,17 @@ exports.NotionDBLoader = void 0;
4
4
  const base_js_1 = require("../base.cjs");
5
5
  const env_js_1 = require("../../util/env.cjs");
6
6
  const NOTION_BASE_URL = "https://api.notion.com/v1";
7
- /** @deprecated use the `NotionAPILoader` class instead. */
7
+ /** @deprecated use the `NotionAPILoader` class instead.
8
+ * @example
9
+ * ```typescript
10
+ * const loader = new NotionDBLoader({
11
+ * pageSizeLimit: 10,
12
+ * databaseId: "{databaseId}",
13
+ * notionIntegrationToken: "{notionIntegrationToken}",
14
+ * });
15
+ * const docs = await loader.load();
16
+ * ```
17
+ */
8
18
  class NotionDBLoader extends base_js_1.BaseDocumentLoader {
9
19
  constructor({ databaseId, notionApiVersion = "2022-06-28", notionIntegrationToken = (0, env_js_1.getEnvironmentVariable)("NOTION_INTEGRATION_TOKEN"), pageSizeLimit = 50, }) {
10
20
  super();
@@ -11,7 +11,17 @@ export interface NotionDBLoaderParams {
11
11
  notionApiVersion?: string;
12
12
  pageSizeLimit?: number;
13
13
  }
14
- /** @deprecated use the `NotionAPILoader` class instead. */
14
+ /** @deprecated use the `NotionAPILoader` class instead.
15
+ * @example
16
+ * ```typescript
17
+ * const loader = new NotionDBLoader({
18
+ * pageSizeLimit: 10,
19
+ * databaseId: "{databaseId}",
20
+ * notionIntegrationToken: "{notionIntegrationToken}",
21
+ * });
22
+ * const docs = await loader.load();
23
+ * ```
24
+ */
15
25
  export declare class NotionDBLoader extends BaseDocumentLoader implements NotionDBLoaderParams {
16
26
  integrationToken: string;
17
27
  databaseId: string;
@@ -1,7 +1,17 @@
1
1
  import { BaseDocumentLoader } from "../base.js";
2
2
  import { getEnvironmentVariable } from "../../util/env.js";
3
3
  const NOTION_BASE_URL = "https://api.notion.com/v1";
4
- /** @deprecated use the `NotionAPILoader` class instead. */
4
+ /** @deprecated use the `NotionAPILoader` class instead.
5
+ * @example
6
+ * ```typescript
7
+ * const loader = new NotionDBLoader({
8
+ * pageSizeLimit: 10,
9
+ * databaseId: "{databaseId}",
10
+ * notionIntegrationToken: "{notionIntegrationToken}",
11
+ * });
12
+ * const docs = await loader.load();
13
+ * ```
14
+ */
5
15
  export class NotionDBLoader extends BaseDocumentLoader {
6
16
  constructor({ databaseId, notionApiVersion = "2022-06-28", notionIntegrationToken = getEnvironmentVariable("NOTION_INTEGRATION_TOKEN"), pageSizeLimit = 50, }) {
7
17
  super();
@@ -6,9 +6,15 @@ const base_js_1 = require("../base.cjs");
6
6
  const document_js_2 = require("../../util/document.cjs");
7
7
  /**
8
8
  * A document loader for loading data from PDFs.
9
+ * @example
10
+ * ```typescript
11
+ * const loader = new WebPDFLoader(new Blob());
12
+ * const docs = await loader.load();
13
+ * console.log({ docs });
14
+ * ```
9
15
  */
10
16
  class WebPDFLoader extends base_js_1.BaseDocumentLoader {
11
- constructor(blob, { splitPages = true, pdfjs = PDFLoaderImports } = {}) {
17
+ constructor(blob, { splitPages = true, pdfjs = PDFLoaderImports, parsedItemSeparator = " ", } = {}) {
12
18
  super();
13
19
  Object.defineProperty(this, "blob", {
14
20
  enumerable: true,
@@ -28,9 +34,16 @@ class WebPDFLoader extends base_js_1.BaseDocumentLoader {
28
34
  writable: true,
29
35
  value: void 0
30
36
  });
37
+ Object.defineProperty(this, "parsedItemSeparator", {
38
+ enumerable: true,
39
+ configurable: true,
40
+ writable: true,
41
+ value: void 0
42
+ });
31
43
  this.blob = blob;
32
44
  this.splitPages = splitPages ?? this.splitPages;
33
45
  this.pdfjs = pdfjs;
46
+ this.parsedItemSeparator = parsedItemSeparator;
34
47
  }
35
48
  /**
36
49
  * Loads the contents of the PDF as documents.
@@ -68,7 +81,7 @@ class WebPDFLoader extends base_js_1.BaseDocumentLoader {
68
81
  lastY = item.transform[5];
69
82
  }
70
83
  }
71
- const text = textItems.join(" ");
84
+ const text = textItems.join(this.parsedItemSeparator);
72
85
  documents.push(new document_js_1.Document({
73
86
  pageContent: text,
74
87
  metadata: {
@@ -3,14 +3,22 @@ import { Document } from "../../document.js";
3
3
  import { BaseDocumentLoader } from "../base.js";
4
4
  /**
5
5
  * A document loader for loading data from PDFs.
6
+ * @example
7
+ * ```typescript
8
+ * const loader = new WebPDFLoader(new Blob());
9
+ * const docs = await loader.load();
10
+ * console.log({ docs });
11
+ * ```
6
12
  */
7
13
  export declare class WebPDFLoader extends BaseDocumentLoader {
8
14
  protected blob: Blob;
9
15
  protected splitPages: boolean;
10
16
  private pdfjs;
11
- constructor(blob: Blob, { splitPages, pdfjs }?: {
17
+ protected parsedItemSeparator: string;
18
+ constructor(blob: Blob, { splitPages, pdfjs, parsedItemSeparator, }?: {
12
19
  splitPages?: boolean | undefined;
13
20
  pdfjs?: typeof PDFLoaderImports | undefined;
21
+ parsedItemSeparator?: string | undefined;
14
22
  });
15
23
  /**
16
24
  * Loads the contents of the PDF as documents.
@@ -3,9 +3,15 @@ import { BaseDocumentLoader } from "../base.js";
3
3
  import { formatDocumentsAsString } from "../../util/document.js";
4
4
  /**
5
5
  * A document loader for loading data from PDFs.
6
+ * @example
7
+ * ```typescript
8
+ * const loader = new WebPDFLoader(new Blob());
9
+ * const docs = await loader.load();
10
+ * console.log({ docs });
11
+ * ```
6
12
  */
7
13
  export class WebPDFLoader extends BaseDocumentLoader {
8
- constructor(blob, { splitPages = true, pdfjs = PDFLoaderImports } = {}) {
14
+ constructor(blob, { splitPages = true, pdfjs = PDFLoaderImports, parsedItemSeparator = " ", } = {}) {
9
15
  super();
10
16
  Object.defineProperty(this, "blob", {
11
17
  enumerable: true,
@@ -25,9 +31,16 @@ export class WebPDFLoader extends BaseDocumentLoader {
25
31
  writable: true,
26
32
  value: void 0
27
33
  });
34
+ Object.defineProperty(this, "parsedItemSeparator", {
35
+ enumerable: true,
36
+ configurable: true,
37
+ writable: true,
38
+ value: void 0
39
+ });
28
40
  this.blob = blob;
29
41
  this.splitPages = splitPages ?? this.splitPages;
30
42
  this.pdfjs = pdfjs;
43
+ this.parsedItemSeparator = parsedItemSeparator;
31
44
  }
32
45
  /**
33
46
  * Loads the contents of the PDF as documents.
@@ -65,7 +78,7 @@ export class WebPDFLoader extends BaseDocumentLoader {
65
78
  lastY = item.transform[5];
66
79
  }
67
80
  }
68
- const text = textItems.join(" ");
81
+ const text = textItems.join(this.parsedItemSeparator);
69
82
  documents.push(new Document({
70
83
  pageContent: text,
71
84
  metadata: {
@@ -7,6 +7,18 @@ const base_js_1 = require("../base.cjs");
7
7
  * Class that extends the BaseDocumentLoader class and implements the
8
8
  * DocumentLoader interface. It represents a document loader for scraping
9
9
  * web pages using Puppeteer.
10
+ * @example
11
+ * ```typescript
12
+ * const loader = new PuppeteerWebBaseLoader("https:exampleurl.com", {
13
+ * launchOptions: {
14
+ * headless: true,
15
+ * },
16
+ * gotoOptions: {
17
+ * waitUntil: "domcontentloaded",
18
+ * },
19
+ * });
20
+ * const screenshot = await loader.screenshot();
21
+ * ```
10
22
  */
11
23
  class PuppeteerWebBaseLoader extends base_js_1.BaseDocumentLoader {
12
24
  constructor(webPath, options) {