langchain 0.0.131 → 0.0.132

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 (804) hide show
  1. package/dist/agents/agent.cjs +23 -0
  2. package/dist/agents/agent.d.ts +28 -0
  3. package/dist/agents/agent.js +23 -0
  4. package/dist/agents/chat/index.cjs +25 -0
  5. package/dist/agents/chat/index.d.ts +32 -0
  6. package/dist/agents/chat/index.js +25 -0
  7. package/dist/agents/chat/outputParser.cjs +19 -0
  8. package/dist/agents/chat/outputParser.d.ts +19 -0
  9. package/dist/agents/chat/outputParser.js +19 -0
  10. package/dist/agents/chat_convo/index.cjs +22 -0
  11. package/dist/agents/chat_convo/index.d.ts +31 -0
  12. package/dist/agents/chat_convo/index.js +22 -0
  13. package/dist/agents/chat_convo/outputParser.cjs +42 -0
  14. package/dist/agents/chat_convo/outputParser.d.ts +42 -0
  15. package/dist/agents/chat_convo/outputParser.js +42 -0
  16. package/dist/agents/executor.cjs +6 -0
  17. package/dist/agents/executor.d.ts +11 -0
  18. package/dist/agents/executor.js +6 -0
  19. package/dist/agents/initialize.d.ts +5 -0
  20. package/dist/agents/mrkl/index.cjs +17 -0
  21. package/dist/agents/mrkl/index.d.ts +24 -0
  22. package/dist/agents/mrkl/index.js +17 -0
  23. package/dist/agents/mrkl/outputParser.cjs +15 -0
  24. package/dist/agents/mrkl/outputParser.d.ts +15 -0
  25. package/dist/agents/mrkl/outputParser.js +15 -0
  26. package/dist/agents/openai/index.cjs +43 -0
  27. package/dist/agents/openai/index.d.ts +39 -0
  28. package/dist/agents/openai/index.js +43 -0
  29. package/dist/agents/structured_chat/index.cjs +32 -0
  30. package/dist/agents/structured_chat/index.d.ts +40 -0
  31. package/dist/agents/structured_chat/index.js +32 -0
  32. package/dist/agents/structured_chat/outputParser.cjs +44 -0
  33. package/dist/agents/structured_chat/outputParser.d.ts +48 -0
  34. package/dist/agents/structured_chat/outputParser.js +44 -0
  35. package/dist/agents/toolkits/aws_sfn.cjs +5 -0
  36. package/dist/agents/toolkits/aws_sfn.d.ts +9 -0
  37. package/dist/agents/toolkits/aws_sfn.js +5 -0
  38. package/dist/agents/toolkits/base.cjs +5 -0
  39. package/dist/agents/toolkits/base.d.ts +5 -0
  40. package/dist/agents/toolkits/base.js +5 -0
  41. package/dist/agents/toolkits/conversational_retrieval/openai_functions.cjs +10 -0
  42. package/dist/agents/toolkits/conversational_retrieval/openai_functions.d.ts +10 -0
  43. package/dist/agents/toolkits/conversational_retrieval/openai_functions.js +10 -0
  44. package/dist/agents/toolkits/conversational_retrieval/token_buffer_memory.cjs +17 -0
  45. package/dist/agents/toolkits/conversational_retrieval/token_buffer_memory.d.ts +21 -0
  46. package/dist/agents/toolkits/conversational_retrieval/token_buffer_memory.js +17 -0
  47. package/dist/agents/toolkits/json/json.cjs +15 -0
  48. package/dist/agents/toolkits/json/json.d.ts +15 -0
  49. package/dist/agents/toolkits/json/json.js +15 -0
  50. package/dist/agents/toolkits/openapi/openapi.cjs +21 -0
  51. package/dist/agents/toolkits/openapi/openapi.d.ts +21 -0
  52. package/dist/agents/toolkits/openapi/openapi.js +21 -0
  53. package/dist/agents/toolkits/sql/sql.cjs +4 -0
  54. package/dist/agents/toolkits/sql/sql.d.ts +8 -0
  55. package/dist/agents/toolkits/sql/sql.js +4 -0
  56. package/dist/agents/toolkits/vectorstore/vectorstore.cjs +10 -0
  57. package/dist/agents/toolkits/vectorstore/vectorstore.d.ts +14 -0
  58. package/dist/agents/toolkits/vectorstore/vectorstore.js +10 -0
  59. package/dist/agents/toolkits/zapier/zapier.cjs +12 -0
  60. package/dist/agents/toolkits/zapier/zapier.d.ts +12 -0
  61. package/dist/agents/toolkits/zapier/zapier.js +12 -0
  62. package/dist/agents/types.cjs +5 -0
  63. package/dist/agents/types.d.ts +28 -0
  64. package/dist/agents/types.js +5 -0
  65. package/dist/cache/index.cjs +21 -0
  66. package/dist/cache/index.d.ts +21 -0
  67. package/dist/cache/index.js +21 -0
  68. package/dist/cache/ioredis.cjs +16 -0
  69. package/dist/cache/ioredis.d.ts +16 -0
  70. package/dist/cache/ioredis.js +16 -0
  71. package/dist/cache/redis.cjs +21 -0
  72. package/dist/cache/redis.d.ts +25 -0
  73. package/dist/cache/redis.js +21 -0
  74. package/dist/callbacks/base.cjs +11 -0
  75. package/dist/callbacks/base.d.ts +20 -0
  76. package/dist/callbacks/base.js +11 -0
  77. package/dist/callbacks/handlers/console.cjs +87 -0
  78. package/dist/callbacks/handlers/console.d.ts +87 -0
  79. package/dist/callbacks/handlers/console.js +87 -0
  80. package/dist/callbacks/handlers/initialize.cjs +12 -0
  81. package/dist/callbacks/handlers/initialize.d.ts +12 -0
  82. package/dist/callbacks/handlers/initialize.js +12 -0
  83. package/dist/callbacks/manager.cjs +9 -0
  84. package/dist/callbacks/manager.d.ts +9 -0
  85. package/dist/callbacks/manager.js +9 -0
  86. package/dist/callbacks/promises.cjs +9 -0
  87. package/dist/callbacks/promises.d.ts +4 -0
  88. package/dist/callbacks/promises.js +9 -0
  89. package/dist/chains/analyze_documents_chain.d.ts +4 -0
  90. package/dist/chains/api/api_chain.cjs +12 -0
  91. package/dist/chains/api/api_chain.d.ts +19 -0
  92. package/dist/chains/api/api_chain.js +12 -0
  93. package/dist/chains/base.cjs +6 -0
  94. package/dist/chains/base.d.ts +6 -0
  95. package/dist/chains/base.js +6 -0
  96. package/dist/chains/chat_vector_db_chain.cjs +8 -0
  97. package/dist/chains/chat_vector_db_chain.d.ts +11 -0
  98. package/dist/chains/chat_vector_db_chain.js +8 -0
  99. package/dist/chains/combine_docs_chain.d.ts +10 -0
  100. package/dist/chains/constitutional_ai/constitutional_chain.cjs +17 -0
  101. package/dist/chains/constitutional_ai/constitutional_chain.d.ts +20 -0
  102. package/dist/chains/constitutional_ai/constitutional_chain.js +17 -0
  103. package/dist/chains/constitutional_ai/constitutional_principle.cjs +4 -0
  104. package/dist/chains/constitutional_ai/constitutional_principle.d.ts +4 -0
  105. package/dist/chains/constitutional_ai/constitutional_principle.js +4 -0
  106. package/dist/chains/conversation.cjs +4 -0
  107. package/dist/chains/conversation.d.ts +4 -0
  108. package/dist/chains/conversation.js +4 -0
  109. package/dist/chains/conversational_retrieval_chain.cjs +21 -0
  110. package/dist/chains/conversational_retrieval_chain.d.ts +26 -1
  111. package/dist/chains/conversational_retrieval_chain.js +21 -0
  112. package/dist/chains/llm_chain.d.ts +3 -0
  113. package/dist/chains/openai_functions/extraction.cjs +21 -0
  114. package/dist/chains/openai_functions/extraction.d.ts +15 -0
  115. package/dist/chains/openai_functions/extraction.js +21 -0
  116. package/dist/chains/openai_functions/openapi.cjs +27 -0
  117. package/dist/chains/openai_functions/openapi.d.ts +3 -0
  118. package/dist/chains/openai_functions/openapi.js +27 -0
  119. package/dist/chains/openai_functions/structured_output.cjs +12 -0
  120. package/dist/chains/openai_functions/structured_output.d.ts +18 -0
  121. package/dist/chains/openai_functions/structured_output.js +12 -0
  122. package/dist/chains/openai_functions/tagging.cjs +24 -0
  123. package/dist/chains/openai_functions/tagging.d.ts +21 -0
  124. package/dist/chains/openai_functions/tagging.js +24 -0
  125. package/dist/chains/openai_moderation.cjs +5 -0
  126. package/dist/chains/openai_moderation.d.ts +8 -0
  127. package/dist/chains/openai_moderation.js +5 -0
  128. package/dist/chains/query_constructor/index.cjs +17 -0
  129. package/dist/chains/query_constructor/index.d.ts +20 -0
  130. package/dist/chains/query_constructor/index.js +17 -0
  131. package/dist/chains/query_constructor/ir.cjs +24 -0
  132. package/dist/chains/query_constructor/ir.d.ts +71 -0
  133. package/dist/chains/query_constructor/ir.js +24 -0
  134. package/dist/chains/query_constructor/parser.cjs +21 -0
  135. package/dist/chains/query_constructor/parser.d.ts +25 -0
  136. package/dist/chains/query_constructor/parser.js +21 -0
  137. package/dist/chains/question_answering/load.cjs +21 -0
  138. package/dist/chains/question_answering/load.d.ts +34 -0
  139. package/dist/chains/question_answering/load.js +21 -0
  140. package/dist/chains/retrieval_qa.cjs +12 -0
  141. package/dist/chains/retrieval_qa.d.ts +15 -0
  142. package/dist/chains/retrieval_qa.js +12 -0
  143. package/dist/chains/router/llm_router.cjs +16 -0
  144. package/dist/chains/router/llm_router.d.ts +24 -0
  145. package/dist/chains/router/llm_router.js +16 -0
  146. package/dist/chains/router/multi_prompt.cjs +19 -0
  147. package/dist/chains/router/multi_prompt.d.ts +19 -0
  148. package/dist/chains/router/multi_prompt.js +19 -0
  149. package/dist/chains/router/multi_retrieval_qa.cjs +22 -0
  150. package/dist/chains/router/multi_retrieval_qa.d.ts +27 -0
  151. package/dist/chains/router/multi_retrieval_qa.js +22 -0
  152. package/dist/chains/router/multi_route.cjs +10 -0
  153. package/dist/chains/router/multi_route.d.ts +25 -0
  154. package/dist/chains/router/multi_route.js +10 -0
  155. package/dist/chains/sequential_chain.d.ts +6 -0
  156. package/dist/chains/serde.d.ts +58 -0
  157. package/dist/chains/sql_db/sql_db_chain.cjs +13 -0
  158. package/dist/chains/sql_db/sql_db_chain.d.ts +18 -0
  159. package/dist/chains/sql_db/sql_db_chain.js +13 -0
  160. package/dist/chains/summarization/load.d.ts +4 -0
  161. package/dist/chains/transform.cjs +6 -0
  162. package/dist/chains/transform.d.ts +11 -0
  163. package/dist/chains/transform.js +6 -0
  164. package/dist/chains/vector_db_qa.cjs +15 -0
  165. package/dist/chains/vector_db_qa.d.ts +21 -0
  166. package/dist/chains/vector_db_qa.js +15 -0
  167. package/dist/chat_models/anthropic.cjs +24 -4
  168. package/dist/chat_models/anthropic.d.ts +14 -0
  169. package/dist/chat_models/anthropic.js +24 -4
  170. package/dist/chat_models/baiduwenxin.cjs +16 -0
  171. package/dist/chat_models/baiduwenxin.d.ts +18 -0
  172. package/dist/chat_models/baiduwenxin.js +16 -0
  173. package/dist/chat_models/base.cjs +61 -0
  174. package/dist/chat_models/base.d.ts +73 -0
  175. package/dist/chat_models/base.js +61 -0
  176. package/dist/chat_models/googlepalm.cjs +3 -0
  177. package/dist/chat_models/googlepalm.d.ts +6 -0
  178. package/dist/chat_models/googlepalm.js +3 -0
  179. package/dist/chat_models/googlevertexai.cjs +32 -0
  180. package/dist/chat_models/googlevertexai.d.ts +49 -0
  181. package/dist/chat_models/googlevertexai.js +32 -0
  182. package/dist/chat_models/ollama.cjs +11 -0
  183. package/dist/chat_models/ollama.d.ts +15 -0
  184. package/dist/chat_models/ollama.js +11 -0
  185. package/dist/document_loaders/base.cjs +10 -0
  186. package/dist/document_loaders/base.d.ts +17 -0
  187. package/dist/document_loaders/base.js +10 -0
  188. package/dist/document_loaders/fs/buffer.cjs +21 -0
  189. package/dist/document_loaders/fs/buffer.d.ts +28 -0
  190. package/dist/document_loaders/fs/buffer.js +21 -0
  191. package/dist/document_loaders/fs/csv.cjs +19 -0
  192. package/dist/document_loaders/fs/csv.d.ts +19 -0
  193. package/dist/document_loaders/fs/csv.js +19 -0
  194. package/dist/document_loaders/fs/directory.cjs +21 -0
  195. package/dist/document_loaders/fs/directory.d.ts +29 -0
  196. package/dist/document_loaders/fs/directory.js +21 -0
  197. package/dist/document_loaders/fs/docx.cjs +16 -0
  198. package/dist/document_loaders/fs/docx.d.ts +16 -0
  199. package/dist/document_loaders/fs/docx.js +16 -0
  200. package/dist/document_loaders/fs/epub.cjs +16 -0
  201. package/dist/document_loaders/fs/epub.d.ts +16 -0
  202. package/dist/document_loaders/fs/epub.js +16 -0
  203. package/dist/document_loaders/fs/json.cjs +40 -0
  204. package/dist/document_loaders/fs/json.d.ts +40 -0
  205. package/dist/document_loaders/fs/json.js +40 -0
  206. package/dist/document_loaders/fs/notion.cjs +6 -0
  207. package/dist/document_loaders/fs/notion.d.ts +6 -0
  208. package/dist/document_loaders/fs/notion.js +6 -0
  209. package/dist/document_loaders/fs/pdf.cjs +21 -0
  210. package/dist/document_loaders/fs/pdf.d.ts +21 -0
  211. package/dist/document_loaders/fs/pdf.js +21 -0
  212. package/dist/document_loaders/fs/srt.cjs +19 -0
  213. package/dist/document_loaders/fs/srt.d.ts +19 -0
  214. package/dist/document_loaders/fs/srt.js +19 -0
  215. package/dist/document_loaders/fs/text.cjs +34 -0
  216. package/dist/document_loaders/fs/text.d.ts +34 -0
  217. package/dist/document_loaders/fs/text.js +34 -0
  218. package/dist/document_loaders/fs/unstructured.cjs +14 -0
  219. package/dist/document_loaders/fs/unstructured.d.ts +26 -0
  220. package/dist/document_loaders/fs/unstructured.js +14 -0
  221. package/dist/document_loaders/web/apify_dataset.cjs +11 -0
  222. package/dist/document_loaders/web/apify_dataset.d.ts +15 -0
  223. package/dist/document_loaders/web/apify_dataset.js +11 -0
  224. package/dist/document_loaders/web/azure_blob_storage_container.cjs +13 -0
  225. package/dist/document_loaders/web/azure_blob_storage_container.d.ts +26 -0
  226. package/dist/document_loaders/web/azure_blob_storage_container.js +13 -0
  227. package/dist/document_loaders/web/azure_blob_storage_file.cjs +12 -0
  228. package/dist/document_loaders/web/azure_blob_storage_file.d.ts +21 -0
  229. package/dist/document_loaders/web/azure_blob_storage_file.js +12 -0
  230. package/dist/document_loaders/web/cheerio.cjs +21 -0
  231. package/dist/document_loaders/web/cheerio.d.ts +26 -0
  232. package/dist/document_loaders/web/cheerio.js +21 -0
  233. package/dist/document_loaders/web/college_confidential.cjs +11 -0
  234. package/dist/document_loaders/web/college_confidential.d.ts +11 -0
  235. package/dist/document_loaders/web/college_confidential.js +11 -0
  236. package/dist/document_loaders/web/confluence.cjs +23 -0
  237. package/dist/document_loaders/web/confluence.d.ts +33 -0
  238. package/dist/document_loaders/web/confluence.js +23 -0
  239. package/dist/document_loaders/web/figma.cjs +21 -0
  240. package/dist/document_loaders/web/figma.d.ts +32 -0
  241. package/dist/document_loaders/web/figma.js +21 -0
  242. package/dist/document_loaders/web/gitbook.cjs +33 -0
  243. package/dist/document_loaders/web/gitbook.d.ts +38 -0
  244. package/dist/document_loaders/web/gitbook.js +33 -0
  245. package/dist/document_loaders/web/github.cjs +50 -0
  246. package/dist/document_loaders/web/github.d.ts +53 -0
  247. package/dist/document_loaders/web/github.js +50 -0
  248. package/dist/document_loaders/web/hn.cjs +31 -0
  249. package/dist/document_loaders/web/hn.d.ts +31 -0
  250. package/dist/document_loaders/web/hn.js +31 -0
  251. package/dist/document_loaders/web/imsdb.cjs +14 -0
  252. package/dist/document_loaders/web/imsdb.d.ts +14 -0
  253. package/dist/document_loaders/web/imsdb.js +14 -0
  254. package/dist/document_loaders/web/notionapi.cjs +39 -0
  255. package/dist/document_loaders/web/notionapi.d.ts +43 -0
  256. package/dist/document_loaders/web/notionapi.js +39 -0
  257. package/dist/document_loaders/web/notiondb.cjs +19 -0
  258. package/dist/document_loaders/web/notiondb.d.ts +24 -0
  259. package/dist/document_loaders/web/notiondb.js +19 -0
  260. package/dist/document_loaders/web/playwright.cjs +22 -0
  261. package/dist/document_loaders/web/playwright.d.ts +27 -0
  262. package/dist/document_loaders/web/playwright.js +22 -0
  263. package/dist/document_loaders/web/puppeteer.cjs +20 -0
  264. package/dist/document_loaders/web/puppeteer.d.ts +25 -0
  265. package/dist/document_loaders/web/puppeteer.js +20 -0
  266. package/dist/document_loaders/web/s3.cjs +9 -0
  267. package/dist/document_loaders/web/s3.d.ts +21 -0
  268. package/dist/document_loaders/web/s3.js +9 -0
  269. package/dist/document_loaders/web/serpapi.cjs +4 -0
  270. package/dist/document_loaders/web/serpapi.d.ts +8 -0
  271. package/dist/document_loaders/web/serpapi.js +4 -0
  272. package/dist/document_loaders/web/sonix_audio.cjs +10 -0
  273. package/dist/document_loaders/web/sonix_audio.d.ts +10 -0
  274. package/dist/document_loaders/web/sonix_audio.js +10 -0
  275. package/dist/document_loaders/web/sort_xyz_blockchain.cjs +10 -0
  276. package/dist/document_loaders/web/sort_xyz_blockchain.d.ts +17 -0
  277. package/dist/document_loaders/web/sort_xyz_blockchain.js +10 -0
  278. package/dist/document_loaders/web/youtube.cjs +23 -0
  279. package/dist/document_loaders/web/youtube.d.ts +27 -0
  280. package/dist/document_loaders/web/youtube.js +23 -0
  281. package/dist/document_transformers/html_to_text.cjs +3 -0
  282. package/dist/document_transformers/html_to_text.d.ts +3 -0
  283. package/dist/document_transformers/html_to_text.js +3 -0
  284. package/dist/document_transformers/mozilla_readability.cjs +4 -0
  285. package/dist/document_transformers/mozilla_readability.d.ts +4 -0
  286. package/dist/document_transformers/mozilla_readability.js +4 -0
  287. package/dist/document_transformers/openai_functions.cjs +3 -0
  288. package/dist/document_transformers/openai_functions.d.ts +3 -0
  289. package/dist/document_transformers/openai_functions.js +3 -0
  290. package/dist/embeddings/base.cjs +4 -0
  291. package/dist/embeddings/base.d.ts +21 -0
  292. package/dist/embeddings/base.js +4 -0
  293. package/dist/embeddings/cache_backed.d.ts +4 -0
  294. package/dist/embeddings/cohere.d.ts +4 -0
  295. package/dist/embeddings/fake.cjs +33 -0
  296. package/dist/embeddings/fake.d.ts +37 -0
  297. package/dist/embeddings/fake.js +33 -0
  298. package/dist/embeddings/googlepalm.cjs +18 -0
  299. package/dist/embeddings/googlepalm.d.ts +22 -0
  300. package/dist/embeddings/googlepalm.js +18 -0
  301. package/dist/embeddings/googlevertexai.cjs +15 -0
  302. package/dist/embeddings/googlevertexai.d.ts +20 -0
  303. package/dist/embeddings/googlevertexai.js +15 -0
  304. package/dist/embeddings/hf.cjs +20 -0
  305. package/dist/embeddings/hf.d.ts +24 -0
  306. package/dist/embeddings/hf.js +20 -0
  307. package/dist/embeddings/openai.cjs +25 -0
  308. package/dist/embeddings/openai.d.ts +29 -0
  309. package/dist/embeddings/openai.js +25 -0
  310. package/dist/embeddings/tensorflow.cjs +27 -0
  311. package/dist/embeddings/tensorflow.d.ts +31 -0
  312. package/dist/embeddings/tensorflow.js +27 -0
  313. package/dist/experimental/autogpt/agent.cjs +21 -0
  314. package/dist/experimental/autogpt/agent.d.ts +24 -0
  315. package/dist/experimental/autogpt/agent.js +21 -0
  316. package/dist/experimental/autogpt/output_parser.cjs +24 -0
  317. package/dist/experimental/autogpt/output_parser.d.ts +24 -0
  318. package/dist/experimental/autogpt/output_parser.js +24 -0
  319. package/dist/experimental/autogpt/prompt.cjs +25 -0
  320. package/dist/experimental/autogpt/prompt.d.ts +28 -0
  321. package/dist/experimental/autogpt/prompt.js +25 -0
  322. package/dist/experimental/autogpt/prompt_generator.cjs +32 -0
  323. package/dist/experimental/autogpt/prompt_generator.d.ts +32 -0
  324. package/dist/experimental/autogpt/prompt_generator.js +32 -0
  325. package/dist/experimental/autogpt/schema.d.ts +11 -0
  326. package/dist/experimental/babyagi/agent.cjs +65 -0
  327. package/dist/experimental/babyagi/agent.d.ts +75 -0
  328. package/dist/experimental/babyagi/agent.js +65 -0
  329. package/dist/experimental/babyagi/task_creation.cjs +10 -0
  330. package/dist/experimental/babyagi/task_creation.d.ts +10 -0
  331. package/dist/experimental/babyagi/task_creation.js +10 -0
  332. package/dist/experimental/babyagi/task_execution.cjs +9 -0
  333. package/dist/experimental/babyagi/task_execution.d.ts +9 -0
  334. package/dist/experimental/babyagi/task_execution.js +9 -0
  335. package/dist/experimental/babyagi/task_prioritization.cjs +8 -0
  336. package/dist/experimental/babyagi/task_prioritization.d.ts +8 -0
  337. package/dist/experimental/babyagi/task_prioritization.js +8 -0
  338. package/dist/experimental/generative_agents/generative_agent.cjs +74 -0
  339. package/dist/experimental/generative_agents/generative_agent.d.ts +79 -0
  340. package/dist/experimental/generative_agents/generative_agent.js +74 -0
  341. package/dist/experimental/generative_agents/generative_agent_memory.cjs +113 -0
  342. package/dist/experimental/generative_agents/generative_agent_memory.d.ts +113 -0
  343. package/dist/experimental/generative_agents/generative_agent_memory.js +113 -0
  344. package/dist/experimental/multimodal_embeddings/googlevertexai.cjs +46 -0
  345. package/dist/experimental/multimodal_embeddings/googlevertexai.d.ts +58 -0
  346. package/dist/experimental/multimodal_embeddings/googlevertexai.js +46 -0
  347. package/dist/experimental/plan_and_execute/agent_executor.cjs +32 -0
  348. package/dist/experimental/plan_and_execute/agent_executor.d.ts +37 -0
  349. package/dist/experimental/plan_and_execute/agent_executor.js +32 -0
  350. package/dist/experimental/plan_and_execute/base.cjs +26 -0
  351. package/dist/experimental/plan_and_execute/base.d.ts +38 -0
  352. package/dist/experimental/plan_and_execute/base.js +26 -0
  353. package/dist/experimental/plan_and_execute/outputParser.cjs +18 -0
  354. package/dist/experimental/plan_and_execute/outputParser.d.ts +18 -0
  355. package/dist/experimental/plan_and_execute/outputParser.js +18 -0
  356. package/dist/llms/ai21.cjs +13 -0
  357. package/dist/llms/ai21.d.ts +19 -0
  358. package/dist/llms/ai21.js +13 -0
  359. package/dist/llms/aleph_alpha.cjs +10 -0
  360. package/dist/llms/aleph_alpha.d.ts +13 -0
  361. package/dist/llms/aleph_alpha.js +10 -0
  362. package/dist/llms/base.cjs +32 -0
  363. package/dist/llms/base.d.ts +32 -0
  364. package/dist/llms/base.js +32 -0
  365. package/dist/llms/bedrock.cjs +21 -0
  366. package/dist/llms/bedrock.d.ts +9 -0
  367. package/dist/llms/bedrock.js +21 -0
  368. package/dist/llms/cohere.cjs +4 -0
  369. package/dist/llms/cohere.d.ts +7 -0
  370. package/dist/llms/cohere.js +4 -0
  371. package/dist/llms/googlevertexai.cjs +23 -0
  372. package/dist/llms/googlevertexai.d.ts +38 -0
  373. package/dist/llms/googlevertexai.js +23 -0
  374. package/dist/llms/hf.cjs +4 -0
  375. package/dist/llms/hf.d.ts +8 -0
  376. package/dist/llms/hf.js +4 -0
  377. package/dist/llms/ollama.cjs +4 -0
  378. package/dist/llms/ollama.d.ts +4 -0
  379. package/dist/llms/ollama.js +4 -0
  380. package/dist/llms/openai-chat.cjs +17 -0
  381. package/dist/llms/openai-chat.d.ts +22 -0
  382. package/dist/llms/openai-chat.js +17 -0
  383. package/dist/llms/openai.cjs +6 -0
  384. package/dist/llms/openai.d.ts +6 -0
  385. package/dist/llms/openai.js +6 -0
  386. package/dist/llms/replicate.cjs +6 -0
  387. package/dist/llms/replicate.d.ts +11 -0
  388. package/dist/llms/replicate.js +6 -0
  389. package/dist/llms/sagemaker_endpoint.cjs +11 -0
  390. package/dist/llms/sagemaker_endpoint.d.ts +17 -0
  391. package/dist/llms/sagemaker_endpoint.js +11 -0
  392. package/dist/memory/base.cjs +11 -0
  393. package/dist/memory/base.d.ts +40 -0
  394. package/dist/memory/base.js +11 -0
  395. package/dist/memory/buffer_memory.cjs +19 -0
  396. package/dist/memory/buffer_memory.d.ts +22 -0
  397. package/dist/memory/buffer_memory.js +19 -0
  398. package/dist/memory/buffer_window_memory.cjs +15 -0
  399. package/dist/memory/buffer_window_memory.d.ts +18 -0
  400. package/dist/memory/buffer_window_memory.js +15 -0
  401. package/dist/memory/chat_memory.cjs +16 -0
  402. package/dist/memory/chat_memory.d.ts +19 -0
  403. package/dist/memory/chat_memory.js +16 -0
  404. package/dist/memory/combined_memory.cjs +28 -0
  405. package/dist/memory/combined_memory.d.ts +33 -0
  406. package/dist/memory/combined_memory.js +28 -0
  407. package/dist/memory/entity_memory.cjs +21 -0
  408. package/dist/memory/entity_memory.d.ts +24 -0
  409. package/dist/memory/entity_memory.js +21 -0
  410. package/dist/memory/motorhead_memory.cjs +25 -0
  411. package/dist/memory/motorhead_memory.d.ts +29 -0
  412. package/dist/memory/motorhead_memory.js +25 -0
  413. package/dist/memory/stores/entity/in_memory.cjs +29 -0
  414. package/dist/memory/stores/entity/in_memory.d.ts +29 -0
  415. package/dist/memory/stores/entity/in_memory.js +29 -0
  416. package/dist/memory/summary.cjs +31 -0
  417. package/dist/memory/summary.d.ts +39 -0
  418. package/dist/memory/summary.js +31 -0
  419. package/dist/memory/summary_buffer.cjs +33 -0
  420. package/dist/memory/summary_buffer.d.ts +37 -0
  421. package/dist/memory/summary_buffer.js +33 -0
  422. package/dist/memory/vector_store.cjs +22 -0
  423. package/dist/memory/vector_store.d.ts +26 -0
  424. package/dist/memory/vector_store.js +22 -0
  425. package/dist/memory/zep.cjs +22 -0
  426. package/dist/memory/zep.d.ts +27 -0
  427. package/dist/memory/zep.js +22 -0
  428. package/dist/output_parsers/combining.cjs +12 -0
  429. package/dist/output_parsers/combining.d.ts +18 -0
  430. package/dist/output_parsers/combining.js +12 -0
  431. package/dist/output_parsers/expression.cjs +12 -0
  432. package/dist/output_parsers/expression.d.ts +12 -0
  433. package/dist/output_parsers/expression.js +12 -0
  434. package/dist/output_parsers/expression_type_handlers/array_literal_expression_handler.cjs +18 -0
  435. package/dist/output_parsers/expression_type_handlers/array_literal_expression_handler.d.ts +18 -0
  436. package/dist/output_parsers/expression_type_handlers/array_literal_expression_handler.js +18 -0
  437. package/dist/output_parsers/expression_type_handlers/base.cjs +68 -0
  438. package/dist/output_parsers/expression_type_handlers/base.d.ts +79 -0
  439. package/dist/output_parsers/expression_type_handlers/base.js +68 -0
  440. package/dist/output_parsers/expression_type_handlers/boolean_literal_handler.cjs +18 -0
  441. package/dist/output_parsers/expression_type_handlers/boolean_literal_handler.d.ts +18 -0
  442. package/dist/output_parsers/expression_type_handlers/boolean_literal_handler.js +18 -0
  443. package/dist/output_parsers/expression_type_handlers/call_expression_handler.cjs +22 -0
  444. package/dist/output_parsers/expression_type_handlers/call_expression_handler.d.ts +22 -0
  445. package/dist/output_parsers/expression_type_handlers/call_expression_handler.js +22 -0
  446. package/dist/output_parsers/expression_type_handlers/factory.cjs +20 -0
  447. package/dist/output_parsers/expression_type_handlers/factory.d.ts +20 -0
  448. package/dist/output_parsers/expression_type_handlers/factory.js +20 -0
  449. package/dist/output_parsers/expression_type_handlers/identifier_handler.cjs +19 -0
  450. package/dist/output_parsers/expression_type_handlers/identifier_handler.d.ts +19 -0
  451. package/dist/output_parsers/expression_type_handlers/identifier_handler.js +19 -0
  452. package/dist/output_parsers/expression_type_handlers/member_expression_handler.cjs +17 -0
  453. package/dist/output_parsers/expression_type_handlers/member_expression_handler.d.ts +17 -0
  454. package/dist/output_parsers/expression_type_handlers/member_expression_handler.js +17 -0
  455. package/dist/output_parsers/expression_type_handlers/numeric_literal_handler.cjs +16 -0
  456. package/dist/output_parsers/expression_type_handlers/numeric_literal_handler.d.ts +16 -0
  457. package/dist/output_parsers/expression_type_handlers/numeric_literal_handler.js +16 -0
  458. package/dist/output_parsers/expression_type_handlers/object_literal_expression_handler.cjs +16 -0
  459. package/dist/output_parsers/expression_type_handlers/object_literal_expression_handler.d.ts +16 -0
  460. package/dist/output_parsers/expression_type_handlers/object_literal_expression_handler.js +16 -0
  461. package/dist/output_parsers/expression_type_handlers/property_assignment_handler.cjs +17 -0
  462. package/dist/output_parsers/expression_type_handlers/property_assignment_handler.d.ts +17 -0
  463. package/dist/output_parsers/expression_type_handlers/property_assignment_handler.js +17 -0
  464. package/dist/output_parsers/expression_type_handlers/string_literal_handler.cjs +16 -0
  465. package/dist/output_parsers/expression_type_handlers/string_literal_handler.d.ts +16 -0
  466. package/dist/output_parsers/expression_type_handlers/string_literal_handler.js +16 -0
  467. package/dist/output_parsers/expression_type_handlers/types.d.ts +50 -0
  468. package/dist/output_parsers/fix.cjs +25 -0
  469. package/dist/output_parsers/fix.d.ts +25 -0
  470. package/dist/output_parsers/fix.js +25 -0
  471. package/dist/output_parsers/list.cjs +24 -0
  472. package/dist/output_parsers/list.d.ts +24 -0
  473. package/dist/output_parsers/list.js +24 -0
  474. package/dist/output_parsers/noop.cjs +18 -0
  475. package/dist/output_parsers/noop.d.ts +18 -0
  476. package/dist/output_parsers/noop.js +18 -0
  477. package/dist/output_parsers/openai_functions.cjs +31 -0
  478. package/dist/output_parsers/openai_functions.d.ts +34 -0
  479. package/dist/output_parsers/openai_functions.js +31 -0
  480. package/dist/output_parsers/regex.cjs +12 -0
  481. package/dist/output_parsers/regex.d.ts +15 -0
  482. package/dist/output_parsers/regex.js +12 -0
  483. package/dist/output_parsers/router.cjs +15 -0
  484. package/dist/output_parsers/router.d.ts +19 -0
  485. package/dist/output_parsers/router.js +15 -0
  486. package/dist/output_parsers/structured.cjs +30 -0
  487. package/dist/output_parsers/structured.d.ts +36 -0
  488. package/dist/output_parsers/structured.js +30 -0
  489. package/dist/prompts/base.cjs +26 -0
  490. package/dist/prompts/base.d.ts +36 -0
  491. package/dist/prompts/base.js +26 -0
  492. package/dist/prompts/chat.cjs +48 -0
  493. package/dist/prompts/chat.d.ts +69 -0
  494. package/dist/prompts/chat.js +48 -0
  495. package/dist/prompts/few_shot.cjs +5 -0
  496. package/dist/prompts/few_shot.d.ts +5 -0
  497. package/dist/prompts/few_shot.js +5 -0
  498. package/dist/prompts/pipeline.cjs +26 -0
  499. package/dist/prompts/pipeline.d.ts +34 -0
  500. package/dist/prompts/pipeline.js +26 -0
  501. package/dist/prompts/prompt.cjs +10 -0
  502. package/dist/prompts/prompt.d.ts +10 -0
  503. package/dist/prompts/prompt.js +10 -0
  504. package/dist/prompts/selectors/LengthBasedExampleSelector.cjs +32 -0
  505. package/dist/prompts/selectors/LengthBasedExampleSelector.d.ts +33 -0
  506. package/dist/prompts/selectors/LengthBasedExampleSelector.js +32 -0
  507. package/dist/prompts/selectors/SemanticSimilarityExampleSelector.cjs +31 -0
  508. package/dist/prompts/selectors/SemanticSimilarityExampleSelector.d.ts +35 -0
  509. package/dist/prompts/selectors/SemanticSimilarityExampleSelector.js +31 -0
  510. package/dist/prompts/selectors/conditional.cjs +30 -0
  511. package/dist/prompts/selectors/conditional.d.ts +37 -0
  512. package/dist/prompts/selectors/conditional.js +30 -0
  513. package/dist/prompts/serde.d.ts +24 -0
  514. package/dist/prompts/template.d.ts +17 -0
  515. package/dist/retrievers/amazon_kendra.cjs +62 -0
  516. package/dist/retrievers/amazon_kendra.d.ts +66 -0
  517. package/dist/retrievers/amazon_kendra.js +62 -0
  518. package/dist/retrievers/contextual_compression.cjs +5 -0
  519. package/dist/retrievers/contextual_compression.d.ts +10 -0
  520. package/dist/retrievers/contextual_compression.js +5 -0
  521. package/dist/retrievers/databerry.cjs +5 -0
  522. package/dist/retrievers/databerry.d.ts +9 -0
  523. package/dist/retrievers/databerry.js +5 -0
  524. package/dist/retrievers/document_compressors/chain_extract.cjs +18 -0
  525. package/dist/retrievers/document_compressors/chain_extract.d.ts +22 -0
  526. package/dist/retrievers/document_compressors/chain_extract.js +18 -0
  527. package/dist/retrievers/document_compressors/index.d.ts +9 -0
  528. package/dist/retrievers/hyde.cjs +9 -0
  529. package/dist/retrievers/hyde.d.ts +17 -0
  530. package/dist/retrievers/hyde.js +9 -0
  531. package/dist/retrievers/metal.cjs +7 -0
  532. package/dist/retrievers/metal.d.ts +12 -0
  533. package/dist/retrievers/metal.js +7 -0
  534. package/dist/retrievers/parent_document.cjs +17 -1
  535. package/dist/retrievers/parent_document.d.ts +15 -0
  536. package/dist/retrievers/parent_document.js +17 -1
  537. package/dist/retrievers/remote/base.cjs +4 -0
  538. package/dist/retrievers/remote/base.d.ts +28 -0
  539. package/dist/retrievers/remote/base.js +4 -0
  540. package/dist/retrievers/remote/chatgpt-plugin.cjs +17 -0
  541. package/dist/retrievers/remote/chatgpt-plugin.d.ts +21 -0
  542. package/dist/retrievers/remote/chatgpt-plugin.js +17 -0
  543. package/dist/retrievers/remote/remote-retriever.cjs +20 -0
  544. package/dist/retrievers/remote/remote-retriever.d.ts +20 -0
  545. package/dist/retrievers/remote/remote-retriever.js +20 -0
  546. package/dist/retrievers/self_query/base.cjs +28 -0
  547. package/dist/retrievers/self_query/base.d.ts +45 -0
  548. package/dist/retrievers/self_query/base.js +28 -0
  549. package/dist/retrievers/self_query/chroma.cjs +6 -0
  550. package/dist/retrievers/self_query/chroma.d.ts +6 -0
  551. package/dist/retrievers/self_query/chroma.js +6 -0
  552. package/dist/retrievers/self_query/functional.cjs +40 -0
  553. package/dist/retrievers/self_query/functional.d.ts +49 -0
  554. package/dist/retrievers/self_query/functional.js +40 -0
  555. package/dist/retrievers/self_query/index.cjs +14 -0
  556. package/dist/retrievers/self_query/index.d.ts +18 -0
  557. package/dist/retrievers/self_query/index.js +14 -0
  558. package/dist/retrievers/self_query/pinecone.cjs +7 -0
  559. package/dist/retrievers/self_query/pinecone.d.ts +7 -0
  560. package/dist/retrievers/self_query/pinecone.js +7 -0
  561. package/dist/retrievers/self_query/supabase.cjs +63 -0
  562. package/dist/retrievers/self_query/supabase.d.ts +67 -0
  563. package/dist/retrievers/self_query/supabase.js +63 -0
  564. package/dist/retrievers/self_query/supabase_utils.cjs +78 -0
  565. package/dist/retrievers/self_query/supabase_utils.d.ts +78 -0
  566. package/dist/retrievers/self_query/supabase_utils.js +78 -0
  567. package/dist/retrievers/self_query/utils.cjs +17 -0
  568. package/dist/retrievers/self_query/utils.d.ts +17 -0
  569. package/dist/retrievers/self_query/utils.js +17 -0
  570. package/dist/retrievers/self_query/weaviate.cjs +42 -0
  571. package/dist/retrievers/self_query/weaviate.d.ts +42 -0
  572. package/dist/retrievers/self_query/weaviate.js +42 -0
  573. package/dist/retrievers/supabase.cjs +30 -0
  574. package/dist/retrievers/supabase.d.ts +30 -0
  575. package/dist/retrievers/supabase.js +30 -0
  576. package/dist/retrievers/time_weighted.cjs +8 -0
  577. package/dist/retrievers/time_weighted.d.ts +12 -0
  578. package/dist/retrievers/time_weighted.js +8 -0
  579. package/dist/retrievers/vespa.cjs +18 -0
  580. package/dist/retrievers/vespa.d.ts +18 -0
  581. package/dist/retrievers/vespa.js +18 -0
  582. package/dist/retrievers/zep.cjs +4 -0
  583. package/dist/retrievers/zep.d.ts +8 -0
  584. package/dist/retrievers/zep.js +4 -0
  585. package/dist/schema/document.cjs +7 -0
  586. package/dist/schema/document.d.ts +7 -0
  587. package/dist/schema/document.js +7 -0
  588. package/dist/schema/index.cjs +70 -0
  589. package/dist/schema/index.d.ts +70 -0
  590. package/dist/schema/index.js +70 -0
  591. package/dist/schema/output_parser.cjs +43 -0
  592. package/dist/schema/output_parser.d.ts +51 -0
  593. package/dist/schema/output_parser.js +43 -0
  594. package/dist/schema/query_constructor.cjs +5 -0
  595. package/dist/schema/query_constructor.d.ts +5 -0
  596. package/dist/schema/query_constructor.js +5 -0
  597. package/dist/schema/retriever.cjs +18 -0
  598. package/dist/schema/retriever.d.ts +18 -0
  599. package/dist/schema/retriever.js +18 -0
  600. package/dist/schema/storage.d.ts +20 -0
  601. package/dist/storage/encoder_backed.cjs +27 -0
  602. package/dist/storage/encoder_backed.d.ts +27 -0
  603. package/dist/storage/encoder_backed.js +27 -0
  604. package/dist/storage/in_memory.cjs +25 -0
  605. package/dist/storage/in_memory.d.ts +25 -0
  606. package/dist/storage/in_memory.js +25 -0
  607. package/dist/storage/ioredis.cjs +25 -0
  608. package/dist/storage/ioredis.d.ts +25 -0
  609. package/dist/storage/ioredis.js +25 -0
  610. package/dist/stores/doc/gcs.cjs +28 -0
  611. package/dist/stores/doc/gcs.d.ts +33 -0
  612. package/dist/stores/doc/gcs.js +28 -0
  613. package/dist/stores/doc/in_memory.cjs +27 -0
  614. package/dist/stores/doc/in_memory.d.ts +27 -0
  615. package/dist/stores/doc/in_memory.js +27 -0
  616. package/dist/stores/file/in_memory.cjs +20 -0
  617. package/dist/stores/file/in_memory.d.ts +20 -0
  618. package/dist/stores/file/in_memory.js +20 -0
  619. package/dist/stores/file/node.cjs +15 -0
  620. package/dist/stores/file/node.d.ts +15 -0
  621. package/dist/stores/file/node.js +15 -0
  622. package/dist/stores/message/dynamodb.cjs +17 -0
  623. package/dist/stores/message/dynamodb.d.ts +23 -0
  624. package/dist/stores/message/dynamodb.js +17 -0
  625. package/dist/stores/message/firestore.cjs +19 -0
  626. package/dist/stores/message/firestore.d.ts +24 -0
  627. package/dist/stores/message/firestore.js +19 -0
  628. package/dist/stores/message/in_memory.cjs +19 -0
  629. package/dist/stores/message/in_memory.d.ts +19 -0
  630. package/dist/stores/message/in_memory.js +19 -0
  631. package/dist/stores/message/ioredis.cjs +17 -0
  632. package/dist/stores/message/ioredis.d.ts +22 -0
  633. package/dist/stores/message/ioredis.js +17 -0
  634. package/dist/stores/message/momento.cjs +18 -0
  635. package/dist/stores/message/momento.d.ts +18 -0
  636. package/dist/stores/message/momento.js +18 -0
  637. package/dist/stores/message/planetscale.cjs +26 -0
  638. package/dist/stores/message/planetscale.d.ts +30 -0
  639. package/dist/stores/message/planetscale.js +26 -0
  640. package/dist/stores/message/redis.cjs +24 -0
  641. package/dist/stores/message/redis.d.ts +27 -0
  642. package/dist/stores/message/redis.js +24 -0
  643. package/dist/stores/message/upstash_redis.cjs +17 -0
  644. package/dist/stores/message/upstash_redis.d.ts +21 -0
  645. package/dist/stores/message/upstash_redis.js +17 -0
  646. package/dist/stores/message/utils.cjs +21 -0
  647. package/dist/stores/message/utils.d.ts +21 -0
  648. package/dist/stores/message/utils.js +21 -0
  649. package/dist/stores/message/xata.cjs +25 -0
  650. package/dist/stores/message/xata.d.ts +29 -0
  651. package/dist/stores/message/xata.js +25 -0
  652. package/dist/tools/IFTTTWebhook.cjs +6 -0
  653. package/dist/tools/IFTTTWebhook.d.ts +6 -0
  654. package/dist/tools/IFTTTWebhook.js +6 -0
  655. package/dist/tools/aiplugin.cjs +12 -0
  656. package/dist/tools/aiplugin.d.ts +16 -0
  657. package/dist/tools/aiplugin.js +12 -0
  658. package/dist/tools/aws_lambda.cjs +9 -0
  659. package/dist/tools/aws_lambda.d.ts +7 -0
  660. package/dist/tools/aws_lambda.js +9 -0
  661. package/dist/tools/aws_sfn.cjs +19 -0
  662. package/dist/tools/aws_sfn.d.ts +19 -0
  663. package/dist/tools/aws_sfn.js +19 -0
  664. package/dist/tools/base.cjs +22 -0
  665. package/dist/tools/base.d.ts +25 -0
  666. package/dist/tools/base.js +22 -0
  667. package/dist/tools/bingserpapi.cjs +10 -0
  668. package/dist/tools/bingserpapi.d.ts +10 -0
  669. package/dist/tools/bingserpapi.js +10 -0
  670. package/dist/tools/brave_search.cjs +6 -0
  671. package/dist/tools/brave_search.d.ts +10 -0
  672. package/dist/tools/brave_search.js +6 -0
  673. package/dist/tools/calculator.cjs +4 -0
  674. package/dist/tools/calculator.d.ts +4 -0
  675. package/dist/tools/calculator.js +4 -0
  676. package/dist/tools/chain.cjs +6 -0
  677. package/dist/tools/chain.d.ts +11 -0
  678. package/dist/tools/chain.js +6 -0
  679. package/dist/tools/convert_to_openai.cjs +6 -0
  680. package/dist/tools/convert_to_openai.d.ts +6 -0
  681. package/dist/tools/convert_to_openai.js +6 -0
  682. package/dist/tools/dadjokeapi.cjs +6 -0
  683. package/dist/tools/dadjokeapi.d.ts +6 -0
  684. package/dist/tools/dadjokeapi.js +6 -0
  685. package/dist/tools/dataforseo_api_search.d.ts +9 -0
  686. package/dist/tools/dynamic.cjs +6 -0
  687. package/dist/tools/dynamic.d.ts +12 -0
  688. package/dist/tools/dynamic.js +6 -0
  689. package/dist/tools/fs.cjs +8 -0
  690. package/dist/tools/fs.d.ts +14 -0
  691. package/dist/tools/fs.js +8 -0
  692. package/dist/tools/google_custom_search.cjs +5 -0
  693. package/dist/tools/google_custom_search.d.ts +8 -0
  694. package/dist/tools/google_custom_search.js +5 -0
  695. package/dist/tools/json.cjs +22 -0
  696. package/dist/tools/json.d.ts +22 -0
  697. package/dist/tools/json.js +22 -0
  698. package/dist/tools/requests.cjs +11 -0
  699. package/dist/tools/requests.d.ts +15 -0
  700. package/dist/tools/requests.js +11 -0
  701. package/dist/tools/searxng_search.cjs +7 -0
  702. package/dist/tools/searxng_search.d.ts +10 -0
  703. package/dist/tools/searxng_search.js +7 -0
  704. package/dist/tools/serpapi.cjs +7 -0
  705. package/dist/tools/serpapi.d.ts +7 -0
  706. package/dist/tools/serpapi.js +7 -0
  707. package/dist/tools/serper.cjs +5 -0
  708. package/dist/tools/serper.d.ts +9 -0
  709. package/dist/tools/serper.js +5 -0
  710. package/dist/tools/sql.cjs +25 -0
  711. package/dist/tools/sql.d.ts +32 -0
  712. package/dist/tools/sql.js +25 -0
  713. package/dist/tools/vectorstore.cjs +11 -0
  714. package/dist/tools/vectorstore.d.ts +14 -0
  715. package/dist/tools/vectorstore.js +11 -0
  716. package/dist/tools/webbrowser.cjs +6 -0
  717. package/dist/tools/webbrowser.d.ts +12 -0
  718. package/dist/tools/webbrowser.js +6 -0
  719. package/dist/tools/wikipedia_query_run.cjs +16 -0
  720. package/dist/tools/wikipedia_query_run.d.ts +24 -0
  721. package/dist/tools/wikipedia_query_run.js +16 -0
  722. package/dist/tools/zapier.cjs +12 -0
  723. package/dist/tools/zapier.d.ts +12 -0
  724. package/dist/tools/zapier.js +12 -0
  725. package/dist/vectorstores/analyticdb.cjs +76 -0
  726. package/dist/vectorstores/analyticdb.d.ts +80 -0
  727. package/dist/vectorstores/analyticdb.js +76 -0
  728. package/dist/vectorstores/base.cjs +13 -0
  729. package/dist/vectorstores/base.d.ts +26 -0
  730. package/dist/vectorstores/base.js +13 -0
  731. package/dist/vectorstores/chroma.cjs +73 -0
  732. package/dist/vectorstores/chroma.d.ts +84 -0
  733. package/dist/vectorstores/chroma.js +73 -0
  734. package/dist/vectorstores/elasticsearch.cjs +73 -0
  735. package/dist/vectorstores/elasticsearch.d.ts +90 -0
  736. package/dist/vectorstores/elasticsearch.js +73 -0
  737. package/dist/vectorstores/faiss.cjs +65 -0
  738. package/dist/vectorstores/faiss.d.ts +69 -0
  739. package/dist/vectorstores/faiss.js +65 -0
  740. package/dist/vectorstores/hnswlib.cjs +71 -0
  741. package/dist/vectorstores/hnswlib.d.ts +80 -0
  742. package/dist/vectorstores/hnswlib.js +71 -0
  743. package/dist/vectorstores/lancedb.cjs +38 -0
  744. package/dist/vectorstores/lancedb.d.ts +42 -0
  745. package/dist/vectorstores/lancedb.js +38 -0
  746. package/dist/vectorstores/memory.cjs +56 -0
  747. package/dist/vectorstores/memory.d.ts +66 -0
  748. package/dist/vectorstores/memory.js +56 -0
  749. package/dist/vectorstores/milvus.cjs +91 -7
  750. package/dist/vectorstores/milvus.d.ts +80 -1
  751. package/dist/vectorstores/milvus.js +91 -7
  752. package/dist/vectorstores/mongo.cjs +45 -0
  753. package/dist/vectorstores/mongo.d.ts +49 -0
  754. package/dist/vectorstores/mongo.js +45 -0
  755. package/dist/vectorstores/mongodb_atlas.cjs +48 -0
  756. package/dist/vectorstores/mongodb_atlas.d.ts +59 -0
  757. package/dist/vectorstores/mongodb_atlas.js +48 -0
  758. package/dist/vectorstores/myscale.cjs +66 -0
  759. package/dist/vectorstores/myscale.d.ts +80 -0
  760. package/dist/vectorstores/myscale.js +66 -0
  761. package/dist/vectorstores/opensearch.cjs +60 -0
  762. package/dist/vectorstores/opensearch.d.ts +74 -0
  763. package/dist/vectorstores/opensearch.js +60 -0
  764. package/dist/vectorstores/pinecone.cjs +54 -0
  765. package/dist/vectorstores/pinecone.d.ts +58 -0
  766. package/dist/vectorstores/pinecone.js +54 -0
  767. package/dist/vectorstores/prisma.cjs +66 -0
  768. package/dist/vectorstores/prisma.d.ts +66 -0
  769. package/dist/vectorstores/prisma.js +66 -0
  770. package/dist/vectorstores/qdrant.cjs +60 -0
  771. package/dist/vectorstores/qdrant.d.ts +66 -0
  772. package/dist/vectorstores/qdrant.js +60 -0
  773. package/dist/vectorstores/redis.cjs +62 -0
  774. package/dist/vectorstores/redis.d.ts +88 -0
  775. package/dist/vectorstores/redis.js +62 -0
  776. package/dist/vectorstores/singlestore.cjs +46 -0
  777. package/dist/vectorstores/singlestore.d.ts +46 -0
  778. package/dist/vectorstores/singlestore.js +46 -0
  779. package/dist/vectorstores/supabase.cjs +50 -0
  780. package/dist/vectorstores/supabase.d.ts +53 -0
  781. package/dist/vectorstores/supabase.js +50 -0
  782. package/dist/vectorstores/tigris.cjs +49 -0
  783. package/dist/vectorstores/tigris.d.ts +53 -0
  784. package/dist/vectorstores/tigris.js +49 -0
  785. package/dist/vectorstores/typeorm.cjs +71 -0
  786. package/dist/vectorstores/typeorm.d.ts +76 -0
  787. package/dist/vectorstores/typeorm.js +71 -0
  788. package/dist/vectorstores/typesense.cjs +5 -0
  789. package/dist/vectorstores/typesense.d.ts +5 -0
  790. package/dist/vectorstores/typesense.js +5 -0
  791. package/dist/vectorstores/usearch.cjs +50 -0
  792. package/dist/vectorstores/usearch.d.ts +55 -0
  793. package/dist/vectorstores/usearch.js +50 -0
  794. package/dist/vectorstores/vectara.cjs +104 -0
  795. package/dist/vectorstores/vectara.d.ts +72 -0
  796. package/dist/vectorstores/vectara.js +104 -0
  797. package/dist/vectorstores/weaviate.cjs +61 -0
  798. package/dist/vectorstores/weaviate.d.ts +70 -0
  799. package/dist/vectorstores/weaviate.js +61 -0
  800. package/dist/vectorstores/xata.cjs +36 -0
  801. package/dist/vectorstores/xata.d.ts +43 -0
  802. package/dist/vectorstores/xata.js +36 -0
  803. package/dist/vectorstores/zep.d.ts +11 -0
  804. package/package.json +2 -2
@@ -7,9 +7,20 @@ import { extname } from "../../util/extname.js";
7
7
  import { getEnvironmentVariable } from "../../util/env.js";
8
8
  import { AsyncCaller } from "../../util/async_caller.js";
9
9
  const extensions = new Set(binaryExtensions);
10
+ /**
11
+ * A function that checks if a file path is a binary file based on its
12
+ * extension.
13
+ * @param name The file path to check.
14
+ * @returns A boolean indicating whether the file path is a binary file.
15
+ */
10
16
  function isBinaryPath(name) {
11
17
  return extensions.has(extname(name).slice(1).toLowerCase());
12
18
  }
19
+ /**
20
+ * A class that extends the BaseDocumentLoader and implements the
21
+ * GithubRepoLoaderParams interface. It represents a document loader for
22
+ * loading files from a GitHub repository.
23
+ */
13
24
  export class GithubRepoLoader extends BaseDocumentLoader {
14
25
  constructor(githubUrl, { accessToken = getEnvironmentVariable("GITHUB_ACCESS_TOKEN"), branch = "main", recursive = true, unknown = UnknownHandling.Warn, ignoreFiles = [], ignorePaths, verbose = false, maxConcurrency = 2, maxRetries = 2, ...rest } = {}) {
15
26
  super();
@@ -109,6 +120,11 @@ export class GithubRepoLoader extends BaseDocumentLoader {
109
120
  };
110
121
  }
111
122
  }
123
+ /**
124
+ * Extracts the owner, repository, and path from a GitHub URL.
125
+ * @param url The GitHub URL to extract information from.
126
+ * @returns An object containing the owner, repository, and path extracted from the GitHub URL.
127
+ */
112
128
  extractOwnerAndRepoAndPath(url) {
113
129
  const match = url.match(/https:\/\/github.com\/([^/]+)\/([^/]+)(\/tree\/[^/]+\/(.+))?/i);
114
130
  if (!match) {
@@ -116,12 +132,25 @@ export class GithubRepoLoader extends BaseDocumentLoader {
116
132
  }
117
133
  return { owner: match[1], repo: match[2], path: match[4] || "" };
118
134
  }
135
+ /**
136
+ * Fetches the files from the GitHub repository and creates Document
137
+ * instances for each file. It also handles error handling based on the
138
+ * unknown handling option.
139
+ * @returns A promise that resolves to an array of Document instances.
140
+ */
119
141
  async load() {
120
142
  return (await this.processRepo()).map((fileResponse) => new Document({
121
143
  pageContent: fileResponse.contents,
122
144
  metadata: fileResponse.metadata,
123
145
  }));
124
146
  }
147
+ /**
148
+ * Determines whether a file or directory should be ignored based on its
149
+ * path and type.
150
+ * @param path The path of the file or directory.
151
+ * @param fileType The type of the file or directory.
152
+ * @returns A boolean indicating whether the file or directory should be ignored.
153
+ */
125
154
  shouldIgnore(path, fileType) {
126
155
  if (fileType !== "dir" && isBinaryPath(path)) {
127
156
  return true;
@@ -197,6 +226,12 @@ export class GithubRepoLoader extends BaseDocumentLoader {
197
226
  return Promise.reject(error);
198
227
  }
199
228
  }
229
+ /**
230
+ * Fetches the contents of a directory and maps the file / directory paths
231
+ * to promises that will fetch the file / directory contents.
232
+ * @param path The path of the directory to process.
233
+ * @returns A promise that resolves to an array of promises that will fetch the file / directory contents.
234
+ */
200
235
  async processDirectory(path) {
201
236
  try {
202
237
  const files = await this.fetchRepoFiles(path);
@@ -207,6 +242,11 @@ export class GithubRepoLoader extends BaseDocumentLoader {
207
242
  return Promise.reject(error);
208
243
  }
209
244
  }
245
+ /**
246
+ * Fetches the files from a GitHub repository.
247
+ * @param path The path of the repository to fetch the files from.
248
+ * @returns A promise that resolves to an array of GithubFile instances.
249
+ */
210
250
  async fetchRepoFiles(path) {
211
251
  const url = `https://api.github.com/repos/${this.owner}/${this.repo}/contents/${path}?ref=${this.branch}`;
212
252
  return this.caller.call(async () => {
@@ -224,6 +264,11 @@ export class GithubRepoLoader extends BaseDocumentLoader {
224
264
  return data;
225
265
  });
226
266
  }
267
+ /**
268
+ * Fetches the content of a file from a GitHub repository.
269
+ * @param file The file to fetch the content from.
270
+ * @returns A promise that resolves to the content of the file.
271
+ */
227
272
  async fetchFileContent(file) {
228
273
  return this.caller.call(async () => {
229
274
  if (this.verbose) {
@@ -235,6 +280,11 @@ export class GithubRepoLoader extends BaseDocumentLoader {
235
280
  return response.text();
236
281
  });
237
282
  }
283
+ /**
284
+ * Handles errors based on the unknown handling option.
285
+ * @param message The error message.
286
+ * @returns void
287
+ */
238
288
  handleError(message) {
239
289
  switch (this.unknown) {
240
290
  case UnknownHandling.Ignore:
@@ -3,6 +3,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.HNLoader = void 0;
4
4
  const document_js_1 = require("../../document.cjs");
5
5
  const cheerio_js_1 = require("./cheerio.cjs");
6
+ /**
7
+ * A class that extends the CheerioWebBaseLoader class. It represents a
8
+ * loader for loading web pages from the Hacker News website.
9
+ */
6
10
  class HNLoader extends cheerio_js_1.CheerioWebBaseLoader {
7
11
  constructor(webPath) {
8
12
  super(webPath);
@@ -13,6 +17,13 @@ class HNLoader extends cheerio_js_1.CheerioWebBaseLoader {
13
17
  value: webPath
14
18
  });
15
19
  }
20
+ /**
21
+ * An asynchronous method that loads the web page. If the webPath includes
22
+ * "item", it calls the loadComments() method to load the comments from
23
+ * the web page. Otherwise, it calls the loadResults() method to load the
24
+ * results from the web page.
25
+ * @returns A Promise that resolves to an array of Document instances.
26
+ */
16
27
  async load() {
17
28
  const $ = await this.scrape();
18
29
  if (this.webPath.includes("item")) {
@@ -20,6 +31,16 @@ class HNLoader extends cheerio_js_1.CheerioWebBaseLoader {
20
31
  }
21
32
  return this.loadResults($);
22
33
  }
34
+ /**
35
+ * A private method that loads the comments from the web page. It selects
36
+ * the elements with the class "athing comtr" using the $ function
37
+ * provided by Cheerio. It also extracts the title of the web page from
38
+ * the element with the id "pagespace". It creates Document instances for
39
+ * each comment, with the comment text as the page content and the source
40
+ * and title as metadata.
41
+ * @param $ A CheerioAPI instance.
42
+ * @returns An array of Document instances.
43
+ */
23
44
  loadComments($) {
24
45
  const comments = $("tr[class='athing comtr']");
25
46
  const title = $("tr[id='pagespace']").attr("title");
@@ -31,6 +52,16 @@ class HNLoader extends cheerio_js_1.CheerioWebBaseLoader {
31
52
  });
32
53
  return documents;
33
54
  }
55
+ /**
56
+ * A private method that loads the results from the web page. It selects
57
+ * the elements with the class "athing" using the $ function provided by
58
+ * Cheerio. It extracts the ranking, link, title, and other metadata from
59
+ * each result item. It creates Document instances for each result item,
60
+ * with the title as the page content and the source, title, link, and
61
+ * ranking as metadata.
62
+ * @param $ A CheerioAPI instance.
63
+ * @returns An array of Document instances.
64
+ */
34
65
  loadResults($) {
35
66
  const items = $("tr[class='athing']");
36
67
  const documents = [];
@@ -1,9 +1,40 @@
1
1
  import { Document } from "../../document.js";
2
2
  import { CheerioWebBaseLoader } from "./cheerio.js";
3
+ /**
4
+ * A class that extends the CheerioWebBaseLoader class. It represents a
5
+ * loader for loading web pages from the Hacker News website.
6
+ */
3
7
  export declare class HNLoader extends CheerioWebBaseLoader {
4
8
  webPath: string;
5
9
  constructor(webPath: string);
10
+ /**
11
+ * An asynchronous method that loads the web page. If the webPath includes
12
+ * "item", it calls the loadComments() method to load the comments from
13
+ * the web page. Otherwise, it calls the loadResults() method to load the
14
+ * results from the web page.
15
+ * @returns A Promise that resolves to an array of Document instances.
16
+ */
6
17
  load(): Promise<Document[]>;
18
+ /**
19
+ * A private method that loads the comments from the web page. It selects
20
+ * the elements with the class "athing comtr" using the $ function
21
+ * provided by Cheerio. It also extracts the title of the web page from
22
+ * the element with the id "pagespace". It creates Document instances for
23
+ * each comment, with the comment text as the page content and the source
24
+ * and title as metadata.
25
+ * @param $ A CheerioAPI instance.
26
+ * @returns An array of Document instances.
27
+ */
7
28
  private loadComments;
29
+ /**
30
+ * A private method that loads the results from the web page. It selects
31
+ * the elements with the class "athing" using the $ function provided by
32
+ * Cheerio. It extracts the ranking, link, title, and other metadata from
33
+ * each result item. It creates Document instances for each result item,
34
+ * with the title as the page content and the source, title, link, and
35
+ * ranking as metadata.
36
+ * @param $ A CheerioAPI instance.
37
+ * @returns An array of Document instances.
38
+ */
8
39
  private loadResults;
9
40
  }
@@ -1,5 +1,9 @@
1
1
  import { Document } from "../../document.js";
2
2
  import { CheerioWebBaseLoader } from "./cheerio.js";
3
+ /**
4
+ * A class that extends the CheerioWebBaseLoader class. It represents a
5
+ * loader for loading web pages from the Hacker News website.
6
+ */
3
7
  export class HNLoader extends CheerioWebBaseLoader {
4
8
  constructor(webPath) {
5
9
  super(webPath);
@@ -10,6 +14,13 @@ export class HNLoader extends CheerioWebBaseLoader {
10
14
  value: webPath
11
15
  });
12
16
  }
17
+ /**
18
+ * An asynchronous method that loads the web page. If the webPath includes
19
+ * "item", it calls the loadComments() method to load the comments from
20
+ * the web page. Otherwise, it calls the loadResults() method to load the
21
+ * results from the web page.
22
+ * @returns A Promise that resolves to an array of Document instances.
23
+ */
13
24
  async load() {
14
25
  const $ = await this.scrape();
15
26
  if (this.webPath.includes("item")) {
@@ -17,6 +28,16 @@ export class HNLoader extends CheerioWebBaseLoader {
17
28
  }
18
29
  return this.loadResults($);
19
30
  }
31
+ /**
32
+ * A private method that loads the comments from the web page. It selects
33
+ * the elements with the class "athing comtr" using the $ function
34
+ * provided by Cheerio. It also extracts the title of the web page from
35
+ * the element with the id "pagespace". It creates Document instances for
36
+ * each comment, with the comment text as the page content and the source
37
+ * and title as metadata.
38
+ * @param $ A CheerioAPI instance.
39
+ * @returns An array of Document instances.
40
+ */
20
41
  loadComments($) {
21
42
  const comments = $("tr[class='athing comtr']");
22
43
  const title = $("tr[id='pagespace']").attr("title");
@@ -28,6 +49,16 @@ export class HNLoader extends CheerioWebBaseLoader {
28
49
  });
29
50
  return documents;
30
51
  }
52
+ /**
53
+ * A private method that loads the results from the web page. It selects
54
+ * the elements with the class "athing" using the $ function provided by
55
+ * Cheerio. It extracts the ranking, link, title, and other metadata from
56
+ * each result item. It creates Document instances for each result item,
57
+ * with the title as the page content and the source, title, link, and
58
+ * ranking as metadata.
59
+ * @param $ A CheerioAPI instance.
60
+ * @returns An array of Document instances.
61
+ */
31
62
  loadResults($) {
32
63
  const items = $("tr[class='athing']");
33
64
  const documents = [];
@@ -3,6 +3,11 @@ Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.IMSDBLoader = void 0;
4
4
  const document_js_1 = require("../../document.cjs");
5
5
  const cheerio_js_1 = require("./cheerio.cjs");
6
+ /**
7
+ * A class that extends the CheerioWebBaseLoader class. It represents a
8
+ * loader for loading web pages from the IMSDB (Internet Movie Script
9
+ * Database) website.
10
+ */
6
11
  class IMSDBLoader extends cheerio_js_1.CheerioWebBaseLoader {
7
12
  constructor(webPath) {
8
13
  super(webPath);
@@ -13,6 +18,15 @@ class IMSDBLoader extends cheerio_js_1.CheerioWebBaseLoader {
13
18
  value: webPath
14
19
  });
15
20
  }
21
+ /**
22
+ * An asynchronous method that loads the web page using the scrape()
23
+ * method inherited from the base class. It selects the element with the
24
+ * class 'scrtext' using the $ function provided by Cheerio and extracts
25
+ * the text content. It creates a Document instance with the text content
26
+ * as the page content and the source as metadata. It returns an array
27
+ * containing the Document instance.
28
+ * @returns An array containing a Document instance.
29
+ */
16
30
  async load() {
17
31
  const $ = await this.scrape();
18
32
  const text = $("td[class='scrtext']").text().trim();
@@ -1,7 +1,21 @@
1
1
  import { Document } from "../../document.js";
2
2
  import { CheerioWebBaseLoader } from "./cheerio.js";
3
+ /**
4
+ * A class that extends the CheerioWebBaseLoader class. It represents a
5
+ * loader for loading web pages from the IMSDB (Internet Movie Script
6
+ * Database) website.
7
+ */
3
8
  export declare class IMSDBLoader extends CheerioWebBaseLoader {
4
9
  webPath: string;
5
10
  constructor(webPath: string);
11
+ /**
12
+ * An asynchronous method that loads the web page using the scrape()
13
+ * method inherited from the base class. It selects the element with the
14
+ * class 'scrtext' using the $ function provided by Cheerio and extracts
15
+ * the text content. It creates a Document instance with the text content
16
+ * as the page content and the source as metadata. It returns an array
17
+ * containing the Document instance.
18
+ * @returns An array containing a Document instance.
19
+ */
6
20
  load(): Promise<Document[]>;
7
21
  }
@@ -1,5 +1,10 @@
1
1
  import { Document } from "../../document.js";
2
2
  import { CheerioWebBaseLoader } from "./cheerio.js";
3
+ /**
4
+ * A class that extends the CheerioWebBaseLoader class. It represents a
5
+ * loader for loading web pages from the IMSDB (Internet Movie Script
6
+ * Database) website.
7
+ */
3
8
  export class IMSDBLoader extends CheerioWebBaseLoader {
4
9
  constructor(webPath) {
5
10
  super(webPath);
@@ -10,6 +15,15 @@ export class IMSDBLoader extends CheerioWebBaseLoader {
10
15
  value: webPath
11
16
  });
12
17
  }
18
+ /**
19
+ * An asynchronous method that loads the web page using the scrape()
20
+ * method inherited from the base class. It selects the element with the
21
+ * class 'scrtext' using the $ function provided by Cheerio and extracts
22
+ * the text content. It creates a Document instance with the text content
23
+ * as the page content and the source as metadata. It returns an array
24
+ * containing the Document instance.
25
+ * @returns An array containing a Document instance.
26
+ */
13
27
  async load() {
14
28
  const $ = await this.scrape();
15
29
  const text = $("td[class='scrtext']").text().trim();
@@ -6,6 +6,10 @@ const notion_to_md_1 = require("notion-to-md");
6
6
  const notion_js_1 = require("notion-to-md/build/utils/notion.js");
7
7
  const base_js_1 = require("../base.cjs");
8
8
  const document_js_1 = require("../../document.cjs");
9
+ /**
10
+ * A class that extends the BaseDocumentLoader class. It represents a
11
+ * document loader for loading documents from Notion using the Notion API.
12
+ */
9
13
  class NotionAPILoader extends base_js_1.BaseDocumentLoader {
10
14
  constructor(options) {
11
15
  super();
@@ -41,6 +45,12 @@ class NotionAPILoader extends base_js_1.BaseDocumentLoader {
41
45
  this.id = options.id;
42
46
  this.type = options.type;
43
47
  }
48
+ /**
49
+ * Parses the properties of a Notion page and returns them as key-value
50
+ * pairs.
51
+ * @param page The Notion page to parse.
52
+ * @returns An object containing the parsed properties as key-value pairs.
53
+ */
44
54
  parsePageProperties(page) {
45
55
  return Object.fromEntries(Object.entries(page.properties).map(([_, prop]) => {
46
56
  switch (prop.type) {
@@ -97,6 +107,11 @@ class NotionAPILoader extends base_js_1.BaseDocumentLoader {
97
107
  }
98
108
  }));
99
109
  }
110
+ /**
111
+ * Parses the details of a Notion page and returns them as an object.
112
+ * @param page The Notion page to parse.
113
+ * @returns An object containing the parsed details of the page.
114
+ */
100
115
  parsePageDetails(page) {
101
116
  const metadata = Object.fromEntries(Object.entries(page).filter(([key, _]) => key !== "id"));
102
117
  return {
@@ -105,6 +120,11 @@ class NotionAPILoader extends base_js_1.BaseDocumentLoader {
105
120
  properties: this.parsePageProperties(page),
106
121
  };
107
122
  }
123
+ /**
124
+ * Loads a Notion block and returns it as an MdBlock object.
125
+ * @param block The Notion block to load.
126
+ * @returns A Promise that resolves to an MdBlock object.
127
+ */
108
128
  async loadBlock(block) {
109
129
  return {
110
130
  type: block.type,
@@ -113,6 +133,11 @@ class NotionAPILoader extends base_js_1.BaseDocumentLoader {
113
133
  children: [],
114
134
  };
115
135
  }
136
+ /**
137
+ * Loads Notion blocks and their child documents recursively.
138
+ * @param blocksResponse The response from the Notion API containing the blocks to load.
139
+ * @returns A Promise that resolves to an object containing the loaded MdBlocks and child Documents.
140
+ */
116
141
  async loadBlocksAndDocs(blocksResponse) {
117
142
  const blocks = blocksResponse.filter(client_1.isFullBlock);
118
143
  const [childPageDocuments, childDatabaseDocuments, blocksDocsArray] = await Promise.all([
@@ -157,6 +182,11 @@ class NotionAPILoader extends base_js_1.BaseDocumentLoader {
157
182
  ],
158
183
  };
159
184
  }
185
+ /**
186
+ * Loads a Notion page and its child documents.
187
+ * @param page The Notion page or page ID to load.
188
+ * @returns A Promise that resolves to an array of Documents.
189
+ */
160
190
  async loadPage(page) {
161
191
  // Check page is a page ID or a GetPageResponse
162
192
  const [pageData, pageId] = typeof page === "string"
@@ -176,6 +206,11 @@ class NotionAPILoader extends base_js_1.BaseDocumentLoader {
176
206
  });
177
207
  return [pageDocument, ...childDocuments];
178
208
  }
209
+ /**
210
+ * Loads a Notion database and its documents.
211
+ * @param id The ID of the Notion database to load.
212
+ * @returns A Promise that resolves to an array of Documents.
213
+ */
179
214
  async loadDatabase(id) {
180
215
  const documents = [];
181
216
  try {
@@ -193,6 +228,10 @@ class NotionAPILoader extends base_js_1.BaseDocumentLoader {
193
228
  }
194
229
  return documents;
195
230
  }
231
+ /**
232
+ * Loads the documents from Notion based on the specified options.
233
+ * @returns A Promise that resolves to an array of Documents.
234
+ */
196
235
  async load() {
197
236
  const documents = [];
198
237
  switch (this.type) {
@@ -1,23 +1,66 @@
1
1
  import { Client } from "@notionhq/client";
2
2
  import { BaseDocumentLoader } from "../base.js";
3
3
  import { Document } from "../../document.js";
4
+ /**
5
+ * Represents the type of Notion API to load documents from. The options
6
+ * are "database" or "page".
7
+ */
4
8
  export type NotionAPIType = "database" | "page";
5
9
  export type NotionAPILoaderOptions = {
6
10
  clientOptions: ConstructorParameters<typeof Client>[0];
7
11
  id: string;
8
12
  type: NotionAPIType;
9
13
  };
14
+ /**
15
+ * A class that extends the BaseDocumentLoader class. It represents a
16
+ * document loader for loading documents from Notion using the Notion API.
17
+ */
10
18
  export declare class NotionAPILoader extends BaseDocumentLoader {
11
19
  private notionClient;
12
20
  private n2mClient;
13
21
  private id;
14
22
  private type;
15
23
  constructor(options: NotionAPILoaderOptions);
24
+ /**
25
+ * Parses the properties of a Notion page and returns them as key-value
26
+ * pairs.
27
+ * @param page The Notion page to parse.
28
+ * @returns An object containing the parsed properties as key-value pairs.
29
+ */
16
30
  private parsePageProperties;
31
+ /**
32
+ * Parses the details of a Notion page and returns them as an object.
33
+ * @param page The Notion page to parse.
34
+ * @returns An object containing the parsed details of the page.
35
+ */
17
36
  private parsePageDetails;
37
+ /**
38
+ * Loads a Notion block and returns it as an MdBlock object.
39
+ * @param block The Notion block to load.
40
+ * @returns A Promise that resolves to an MdBlock object.
41
+ */
18
42
  private loadBlock;
43
+ /**
44
+ * Loads Notion blocks and their child documents recursively.
45
+ * @param blocksResponse The response from the Notion API containing the blocks to load.
46
+ * @returns A Promise that resolves to an object containing the loaded MdBlocks and child Documents.
47
+ */
19
48
  private loadBlocksAndDocs;
49
+ /**
50
+ * Loads a Notion page and its child documents.
51
+ * @param page The Notion page or page ID to load.
52
+ * @returns A Promise that resolves to an array of Documents.
53
+ */
20
54
  private loadPage;
55
+ /**
56
+ * Loads a Notion database and its documents.
57
+ * @param id The ID of the Notion database to load.
58
+ * @returns A Promise that resolves to an array of Documents.
59
+ */
21
60
  private loadDatabase;
61
+ /**
62
+ * Loads the documents from Notion based on the specified options.
63
+ * @returns A Promise that resolves to an array of Documents.
64
+ */
22
65
  load(): Promise<Document[]>;
23
66
  }
@@ -3,6 +3,10 @@ import { NotionToMarkdown } from "notion-to-md";
3
3
  import { getBlockChildren } from "notion-to-md/build/utils/notion.js";
4
4
  import { BaseDocumentLoader } from "../base.js";
5
5
  import { Document } from "../../document.js";
6
+ /**
7
+ * A class that extends the BaseDocumentLoader class. It represents a
8
+ * document loader for loading documents from Notion using the Notion API.
9
+ */
6
10
  export class NotionAPILoader extends BaseDocumentLoader {
7
11
  constructor(options) {
8
12
  super();
@@ -38,6 +42,12 @@ export class NotionAPILoader extends BaseDocumentLoader {
38
42
  this.id = options.id;
39
43
  this.type = options.type;
40
44
  }
45
+ /**
46
+ * Parses the properties of a Notion page and returns them as key-value
47
+ * pairs.
48
+ * @param page The Notion page to parse.
49
+ * @returns An object containing the parsed properties as key-value pairs.
50
+ */
41
51
  parsePageProperties(page) {
42
52
  return Object.fromEntries(Object.entries(page.properties).map(([_, prop]) => {
43
53
  switch (prop.type) {
@@ -94,6 +104,11 @@ export class NotionAPILoader extends BaseDocumentLoader {
94
104
  }
95
105
  }));
96
106
  }
107
+ /**
108
+ * Parses the details of a Notion page and returns them as an object.
109
+ * @param page The Notion page to parse.
110
+ * @returns An object containing the parsed details of the page.
111
+ */
97
112
  parsePageDetails(page) {
98
113
  const metadata = Object.fromEntries(Object.entries(page).filter(([key, _]) => key !== "id"));
99
114
  return {
@@ -102,6 +117,11 @@ export class NotionAPILoader extends BaseDocumentLoader {
102
117
  properties: this.parsePageProperties(page),
103
118
  };
104
119
  }
120
+ /**
121
+ * Loads a Notion block and returns it as an MdBlock object.
122
+ * @param block The Notion block to load.
123
+ * @returns A Promise that resolves to an MdBlock object.
124
+ */
105
125
  async loadBlock(block) {
106
126
  return {
107
127
  type: block.type,
@@ -110,6 +130,11 @@ export class NotionAPILoader extends BaseDocumentLoader {
110
130
  children: [],
111
131
  };
112
132
  }
133
+ /**
134
+ * Loads Notion blocks and their child documents recursively.
135
+ * @param blocksResponse The response from the Notion API containing the blocks to load.
136
+ * @returns A Promise that resolves to an object containing the loaded MdBlocks and child Documents.
137
+ */
113
138
  async loadBlocksAndDocs(blocksResponse) {
114
139
  const blocks = blocksResponse.filter(isFullBlock);
115
140
  const [childPageDocuments, childDatabaseDocuments, blocksDocsArray] = await Promise.all([
@@ -154,6 +179,11 @@ export class NotionAPILoader extends BaseDocumentLoader {
154
179
  ],
155
180
  };
156
181
  }
182
+ /**
183
+ * Loads a Notion page and its child documents.
184
+ * @param page The Notion page or page ID to load.
185
+ * @returns A Promise that resolves to an array of Documents.
186
+ */
157
187
  async loadPage(page) {
158
188
  // Check page is a page ID or a GetPageResponse
159
189
  const [pageData, pageId] = typeof page === "string"
@@ -173,6 +203,11 @@ export class NotionAPILoader extends BaseDocumentLoader {
173
203
  });
174
204
  return [pageDocument, ...childDocuments];
175
205
  }
206
+ /**
207
+ * Loads a Notion database and its documents.
208
+ * @param id The ID of the Notion database to load.
209
+ * @returns A Promise that resolves to an array of Documents.
210
+ */
176
211
  async loadDatabase(id) {
177
212
  const documents = [];
178
213
  try {
@@ -190,6 +225,10 @@ export class NotionAPILoader extends BaseDocumentLoader {
190
225
  }
191
226
  return documents;
192
227
  }
228
+ /**
229
+ * Loads the documents from Notion based on the specified options.
230
+ * @returns A Promise that resolves to an array of Documents.
231
+ */
193
232
  async load() {
194
233
  const documents = [];
195
234
  switch (this.type) {
@@ -51,6 +51,10 @@ class NotionDBLoader extends base_js_1.BaseDocumentLoader {
51
51
  "Notion-Version": notionApiVersion,
52
52
  };
53
53
  }
54
+ /**
55
+ * Loads the documents from Notion based on the specified options.
56
+ * @returns An array of Document objects.
57
+ */
54
58
  async load() {
55
59
  const pageIds = await this.retrievePageIds();
56
60
  const documents = [];
@@ -59,6 +63,10 @@ class NotionDBLoader extends base_js_1.BaseDocumentLoader {
59
63
  }
60
64
  return documents;
61
65
  }
66
+ /**
67
+ * Retrieves the IDs of the pages in the Notion database.
68
+ * @returns An array of page IDs.
69
+ */
62
70
  async retrievePageIds() {
63
71
  const url = `${NOTION_BASE_URL}/databases/${this.databaseId}/query`;
64
72
  const pageIds = [];
@@ -83,6 +91,11 @@ class NotionDBLoader extends base_js_1.BaseDocumentLoader {
83
91
  }
84
92
  return pageIds;
85
93
  }
94
+ /**
95
+ * Loads a Notion page and returns it as a Document object.
96
+ * @param pageId The ID of the Notion page to load.
97
+ * @returns A Document object representing the loaded Notion page.
98
+ */
86
99
  async loadPage(pageId) {
87
100
  const url = `${NOTION_BASE_URL}/pages/${pageId}`;
88
101
  const response = await fetch(url, { method: "GET", headers: this.headers });
@@ -132,6 +145,12 @@ class NotionDBLoader extends base_js_1.BaseDocumentLoader {
132
145
  metadata,
133
146
  };
134
147
  }
148
+ /**
149
+ * Loads the blocks of a Notion page and returns them as a string.
150
+ * @param blockId The ID of the block to load.
151
+ * @param numberOfTabs The number of tabs to use for indentation.
152
+ * @returns A string representing the loaded blocks.
153
+ */
135
154
  async loadBlocks(blockId, numberOfTabs = 0) {
136
155
  const resultLinesArr = [];
137
156
  let currentBlockId = blockId;
@@ -1,5 +1,10 @@
1
1
  import { BaseDocumentLoader } from "../base.js";
2
2
  import { Document } from "../../document.js";
3
+ /**
4
+ * Interface representing the parameters for the NotionDBLoader class. It
5
+ * includes the database ID, Notion integration token, Notion API version,
6
+ * and page size limit.
7
+ */
3
8
  export interface NotionDBLoaderParams {
4
9
  databaseId: string;
5
10
  notionIntegrationToken?: string;
@@ -14,8 +19,27 @@ export declare class NotionDBLoader extends BaseDocumentLoader implements Notion
14
19
  pageSizeLimit: number;
15
20
  private headers;
16
21
  constructor({ databaseId, notionApiVersion, notionIntegrationToken, pageSizeLimit, }: NotionDBLoaderParams);
22
+ /**
23
+ * Loads the documents from Notion based on the specified options.
24
+ * @returns An array of Document objects.
25
+ */
17
26
  load(): Promise<Document[]>;
27
+ /**
28
+ * Retrieves the IDs of the pages in the Notion database.
29
+ * @returns An array of page IDs.
30
+ */
18
31
  private retrievePageIds;
32
+ /**
33
+ * Loads a Notion page and returns it as a Document object.
34
+ * @param pageId The ID of the Notion page to load.
35
+ * @returns A Document object representing the loaded Notion page.
36
+ */
19
37
  private loadPage;
38
+ /**
39
+ * Loads the blocks of a Notion page and returns them as a string.
40
+ * @param blockId The ID of the block to load.
41
+ * @param numberOfTabs The number of tabs to use for indentation.
42
+ * @returns A string representing the loaded blocks.
43
+ */
20
44
  private loadBlocks;
21
45
  }