langchain 0.0.203 → 0.0.204-rc.0

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 (494) hide show
  1. package/dist/cache/cloudflare_kv.cjs +15 -69
  2. package/dist/cache/cloudflare_kv.d.ts +1 -42
  3. package/dist/cache/cloudflare_kv.js +1 -67
  4. package/dist/cache/momento.cjs +15 -135
  5. package/dist/cache/momento.d.ts +1 -91
  6. package/dist/cache/momento.js +1 -133
  7. package/dist/cache/upstash_redis.cjs +15 -72
  8. package/dist/cache/upstash_redis.d.ts +1 -45
  9. package/dist/cache/upstash_redis.js +1 -70
  10. package/dist/callbacks/handlers/llmonitor.cjs +14 -238
  11. package/dist/callbacks/handlers/llmonitor.d.ts +1 -35
  12. package/dist/callbacks/handlers/llmonitor.js +1 -233
  13. package/dist/chains/openai_moderation.cjs +2 -2
  14. package/dist/chains/openai_moderation.d.ts +1 -1
  15. package/dist/chains/openai_moderation.js +1 -1
  16. package/dist/chat_models/anthropic.d.ts +4 -4
  17. package/dist/chat_models/baiduwenxin.cjs +15 -411
  18. package/dist/chat_models/baiduwenxin.d.ts +1 -150
  19. package/dist/chat_models/baiduwenxin.js +1 -409
  20. package/dist/chat_models/bedrock/index.cjs +15 -33
  21. package/dist/chat_models/bedrock/index.d.ts +1 -23
  22. package/dist/chat_models/bedrock/index.js +1 -29
  23. package/dist/chat_models/bedrock/web.cjs +15 -360
  24. package/dist/chat_models/bedrock/web.d.ts +1 -82
  25. package/dist/chat_models/bedrock/web.js +1 -356
  26. package/dist/chat_models/cloudflare_workersai.cjs +15 -216
  27. package/dist/chat_models/cloudflare_workersai.d.ts +1 -68
  28. package/dist/chat_models/cloudflare_workersai.js +1 -214
  29. package/dist/chat_models/fireworks.cjs +15 -89
  30. package/dist/chat_models/fireworks.d.ts +1 -43
  31. package/dist/chat_models/fireworks.js +1 -87
  32. package/dist/chat_models/googlepalm.cjs +15 -235
  33. package/dist/chat_models/googlepalm.d.ts +1 -108
  34. package/dist/chat_models/googlepalm.js +1 -233
  35. package/dist/chat_models/googlevertexai/index.cjs +15 -40
  36. package/dist/chat_models/googlevertexai/index.d.ts +1 -28
  37. package/dist/chat_models/googlevertexai/index.js +1 -38
  38. package/dist/chat_models/googlevertexai/web.cjs +15 -39
  39. package/dist/chat_models/googlevertexai/web.d.ts +1 -28
  40. package/dist/chat_models/googlevertexai/web.js +1 -37
  41. package/dist/chat_models/iflytek_xinghuo/index.cjs +14 -40
  42. package/dist/chat_models/iflytek_xinghuo/index.d.ts +1 -13
  43. package/dist/chat_models/iflytek_xinghuo/index.js +1 -36
  44. package/dist/chat_models/iflytek_xinghuo/web.cjs +15 -36
  45. package/dist/chat_models/iflytek_xinghuo/web.d.ts +1 -13
  46. package/dist/chat_models/iflytek_xinghuo/web.js +1 -34
  47. package/dist/chat_models/llama_cpp.cjs +15 -275
  48. package/dist/chat_models/llama_cpp.d.ts +1 -71
  49. package/dist/chat_models/llama_cpp.js +1 -273
  50. package/dist/chat_models/minimax.cjs +15 -578
  51. package/dist/chat_models/minimax.d.ts +1 -369
  52. package/dist/chat_models/minimax.js +1 -576
  53. package/dist/chat_models/ollama.cjs +15 -394
  54. package/dist/chat_models/ollama.d.ts +1 -127
  55. package/dist/chat_models/ollama.js +1 -392
  56. package/dist/chat_models/openai.cjs +4 -698
  57. package/dist/chat_models/openai.d.ts +4 -137
  58. package/dist/chat_models/openai.js +2 -695
  59. package/dist/chat_models/portkey.cjs +15 -167
  60. package/dist/chat_models/portkey.d.ts +1 -17
  61. package/dist/chat_models/portkey.js +1 -165
  62. package/dist/chat_models/yandex.cjs +15 -132
  63. package/dist/chat_models/yandex.d.ts +1 -30
  64. package/dist/chat_models/yandex.js +1 -130
  65. package/dist/document_loaders/fs/openai_whisper_audio.cjs +2 -2
  66. package/dist/document_loaders/fs/openai_whisper_audio.d.ts +1 -1
  67. package/dist/document_loaders/fs/openai_whisper_audio.js +1 -1
  68. package/dist/document_transformers/html_to_text.cjs +15 -47
  69. package/dist/document_transformers/html_to_text.d.ts +1 -30
  70. package/dist/document_transformers/html_to_text.js +1 -45
  71. package/dist/document_transformers/mozilla_readability.cjs +15 -53
  72. package/dist/document_transformers/mozilla_readability.d.ts +1 -31
  73. package/dist/document_transformers/mozilla_readability.js +1 -51
  74. package/dist/embeddings/bedrock.cjs +15 -109
  75. package/dist/embeddings/bedrock.d.ts +1 -71
  76. package/dist/embeddings/bedrock.js +1 -107
  77. package/dist/embeddings/cloudflare_workersai.cjs +15 -67
  78. package/dist/embeddings/cloudflare_workersai.d.ts +1 -28
  79. package/dist/embeddings/cloudflare_workersai.js +1 -65
  80. package/dist/embeddings/cohere.cjs +15 -124
  81. package/dist/embeddings/cohere.d.ts +1 -66
  82. package/dist/embeddings/cohere.js +1 -122
  83. package/dist/embeddings/googlepalm.cjs +15 -88
  84. package/dist/embeddings/googlepalm.d.ts +1 -61
  85. package/dist/embeddings/googlepalm.js +1 -86
  86. package/dist/embeddings/googlevertexai.cjs +15 -81
  87. package/dist/embeddings/googlevertexai.d.ts +1 -54
  88. package/dist/embeddings/googlevertexai.js +1 -79
  89. package/dist/embeddings/gradient_ai.cjs +15 -101
  90. package/dist/embeddings/gradient_ai.d.ts +1 -48
  91. package/dist/embeddings/gradient_ai.js +1 -99
  92. package/dist/embeddings/hf.cjs +15 -75
  93. package/dist/embeddings/hf.d.ts +1 -41
  94. package/dist/embeddings/hf.js +1 -73
  95. package/dist/embeddings/hf_transformers.cjs +15 -87
  96. package/dist/embeddings/hf_transformers.d.ts +1 -47
  97. package/dist/embeddings/hf_transformers.js +1 -85
  98. package/dist/embeddings/llama_cpp.cjs +15 -81
  99. package/dist/embeddings/llama_cpp.d.ts +1 -42
  100. package/dist/embeddings/llama_cpp.js +1 -79
  101. package/dist/embeddings/minimax.cjs +15 -165
  102. package/dist/embeddings/minimax.d.ts +1 -119
  103. package/dist/embeddings/minimax.js +1 -163
  104. package/dist/embeddings/ollama.cjs +15 -118
  105. package/dist/embeddings/ollama.d.ts +1 -34
  106. package/dist/embeddings/ollama.js +1 -116
  107. package/dist/embeddings/openai.cjs +2 -240
  108. package/dist/embeddings/openai.d.ts +1 -82
  109. package/dist/embeddings/openai.js +1 -239
  110. package/dist/embeddings/tensorflow.cjs +3 -96
  111. package/dist/embeddings/tensorflow.d.ts +1 -59
  112. package/dist/embeddings/tensorflow.js +1 -83
  113. package/dist/embeddings/voyage.cjs +15 -118
  114. package/dist/embeddings/voyage.d.ts +1 -66
  115. package/dist/embeddings/voyage.js +1 -116
  116. package/dist/experimental/chat_models/ollama_functions.d.ts +1 -1
  117. package/dist/experimental/openai_assistant/index.cjs +3 -3
  118. package/dist/experimental/openai_assistant/index.d.ts +1 -1
  119. package/dist/experimental/openai_assistant/index.js +1 -1
  120. package/dist/experimental/openai_assistant/schema.d.ts +1 -1
  121. package/dist/experimental/openai_files/index.cjs +2 -2
  122. package/dist/experimental/openai_files/index.d.ts +1 -1
  123. package/dist/experimental/openai_files/index.js +1 -1
  124. package/dist/graphs/neo4j_graph.cjs +3 -254
  125. package/dist/graphs/neo4j_graph.d.ts +1 -63
  126. package/dist/graphs/neo4j_graph.js +1 -241
  127. package/dist/llms/ai21.cjs +15 -200
  128. package/dist/llms/ai21.d.ts +1 -100
  129. package/dist/llms/ai21.js +1 -198
  130. package/dist/llms/aleph_alpha.cjs +15 -374
  131. package/dist/llms/aleph_alpha.d.ts +1 -161
  132. package/dist/llms/aleph_alpha.js +1 -372
  133. package/dist/llms/bedrock/web.cjs +15 -310
  134. package/dist/llms/bedrock/web.d.ts +1 -66
  135. package/dist/llms/bedrock/web.js +1 -308
  136. package/dist/llms/cloudflare_workersai.cjs +15 -168
  137. package/dist/llms/cloudflare_workersai.d.ts +1 -55
  138. package/dist/llms/cloudflare_workersai.js +1 -166
  139. package/dist/llms/cohere.cjs +15 -110
  140. package/dist/llms/cohere.d.ts +1 -54
  141. package/dist/llms/cohere.js +1 -108
  142. package/dist/llms/fireworks.cjs +15 -90
  143. package/dist/llms/fireworks.d.ts +1 -33
  144. package/dist/llms/fireworks.js +1 -88
  145. package/dist/llms/googlepalm.cjs +15 -134
  146. package/dist/llms/googlepalm.d.ts +1 -92
  147. package/dist/llms/googlepalm.js +1 -132
  148. package/dist/llms/googlevertexai/index.cjs +15 -45
  149. package/dist/llms/googlevertexai/index.d.ts +1 -38
  150. package/dist/llms/googlevertexai/index.js +1 -43
  151. package/dist/llms/googlevertexai/web.cjs +15 -42
  152. package/dist/llms/googlevertexai/web.d.ts +1 -36
  153. package/dist/llms/googlevertexai/web.js +1 -40
  154. package/dist/llms/gradient_ai.cjs +15 -110
  155. package/dist/llms/gradient_ai.d.ts +1 -55
  156. package/dist/llms/gradient_ai.js +1 -108
  157. package/dist/llms/hf.cjs +15 -136
  158. package/dist/llms/hf.d.ts +1 -68
  159. package/dist/llms/hf.js +1 -134
  160. package/dist/llms/llama_cpp.cjs +15 -111
  161. package/dist/llms/llama_cpp.d.ts +1 -41
  162. package/dist/llms/llama_cpp.js +1 -109
  163. package/dist/llms/ollama.cjs +15 -353
  164. package/dist/llms/ollama.d.ts +1 -106
  165. package/dist/llms/ollama.js +1 -351
  166. package/dist/llms/openai-chat.cjs +3 -445
  167. package/dist/llms/openai-chat.d.ts +4 -123
  168. package/dist/llms/openai-chat.js +2 -443
  169. package/dist/llms/openai.cjs +6 -530
  170. package/dist/llms/openai.d.ts +4 -123
  171. package/dist/llms/openai.js +2 -525
  172. package/dist/llms/portkey.cjs +14 -168
  173. package/dist/llms/portkey.d.ts +1 -57
  174. package/dist/llms/portkey.js +1 -162
  175. package/dist/llms/raycast.cjs +15 -94
  176. package/dist/llms/raycast.d.ts +1 -50
  177. package/dist/llms/raycast.js +1 -92
  178. package/dist/llms/replicate.cjs +15 -132
  179. package/dist/llms/replicate.d.ts +1 -51
  180. package/dist/llms/replicate.js +1 -130
  181. package/dist/llms/sagemaker_endpoint.cjs +15 -203
  182. package/dist/llms/sagemaker_endpoint.d.ts +1 -121
  183. package/dist/llms/sagemaker_endpoint.js +1 -200
  184. package/dist/llms/watsonx_ai.cjs +15 -152
  185. package/dist/llms/watsonx_ai.d.ts +1 -72
  186. package/dist/llms/watsonx_ai.js +1 -150
  187. package/dist/llms/writer.cjs +15 -165
  188. package/dist/llms/writer.d.ts +1 -60
  189. package/dist/llms/writer.js +1 -163
  190. package/dist/llms/yandex.cjs +15 -98
  191. package/dist/llms/yandex.d.ts +1 -40
  192. package/dist/llms/yandex.js +1 -96
  193. package/dist/load/index.cjs +3 -1
  194. package/dist/load/index.d.ts +1 -1
  195. package/dist/load/index.js +3 -1
  196. package/dist/retrievers/amazon_kendra.cjs +15 -273
  197. package/dist/retrievers/amazon_kendra.d.ts +1 -142
  198. package/dist/retrievers/amazon_kendra.js +1 -271
  199. package/dist/retrievers/chaindesk.cjs +15 -88
  200. package/dist/retrievers/chaindesk.d.ts +1 -31
  201. package/dist/retrievers/chaindesk.js +1 -86
  202. package/dist/retrievers/databerry.cjs +15 -82
  203. package/dist/retrievers/databerry.d.ts +1 -34
  204. package/dist/retrievers/databerry.js +1 -80
  205. package/dist/retrievers/metal.cjs +15 -51
  206. package/dist/retrievers/metal.d.ts +1 -36
  207. package/dist/retrievers/metal.js +1 -49
  208. package/dist/retrievers/supabase.cjs +15 -167
  209. package/dist/retrievers/supabase.d.ts +1 -82
  210. package/dist/retrievers/supabase.js +1 -165
  211. package/dist/retrievers/tavily_search_api.cjs +15 -142
  212. package/dist/retrievers/tavily_search_api.d.ts +1 -38
  213. package/dist/retrievers/tavily_search_api.js +1 -140
  214. package/dist/retrievers/zep.cjs +15 -150
  215. package/dist/retrievers/zep.d.ts +1 -76
  216. package/dist/retrievers/zep.js +1 -148
  217. package/dist/schema/document.cjs +2 -16
  218. package/dist/schema/document.d.ts +1 -11
  219. package/dist/schema/document.js +1 -16
  220. package/dist/schema/index.cjs +2 -7
  221. package/dist/schema/index.d.ts +2 -10
  222. package/dist/schema/index.js +1 -6
  223. package/dist/storage/convex.cjs +15 -143
  224. package/dist/storage/convex.d.ts +1 -106
  225. package/dist/storage/convex.js +1 -141
  226. package/dist/storage/ioredis.cjs +15 -158
  227. package/dist/storage/ioredis.d.ts +1 -71
  228. package/dist/storage/ioredis.js +1 -156
  229. package/dist/storage/upstash_redis.cjs +15 -172
  230. package/dist/storage/upstash_redis.d.ts +1 -78
  231. package/dist/storage/upstash_redis.js +1 -170
  232. package/dist/storage/vercel_kv.cjs +15 -161
  233. package/dist/storage/vercel_kv.d.ts +1 -62
  234. package/dist/storage/vercel_kv.js +1 -159
  235. package/dist/stores/doc/in_memory.cjs +15 -105
  236. package/dist/stores/doc/in_memory.d.ts +1 -46
  237. package/dist/stores/doc/in_memory.js +1 -102
  238. package/dist/stores/message/cassandra.cjs +15 -158
  239. package/dist/stores/message/cassandra.d.ts +1 -69
  240. package/dist/stores/message/cassandra.js +1 -156
  241. package/dist/stores/message/cloudflare_d1.cjs +15 -150
  242. package/dist/stores/message/cloudflare_d1.d.ts +1 -67
  243. package/dist/stores/message/cloudflare_d1.js +1 -148
  244. package/dist/stores/message/convex.cjs +15 -118
  245. package/dist/stores/message/convex.d.ts +1 -81
  246. package/dist/stores/message/convex.js +1 -116
  247. package/dist/stores/message/dynamodb.cjs +15 -159
  248. package/dist/stores/message/dynamodb.d.ts +1 -51
  249. package/dist/stores/message/dynamodb.js +1 -157
  250. package/dist/stores/message/firestore.cjs +15 -185
  251. package/dist/stores/message/firestore.d.ts +1 -68
  252. package/dist/stores/message/firestore.js +1 -183
  253. package/dist/stores/message/ioredis.cjs +15 -98
  254. package/dist/stores/message/ioredis.d.ts +1 -64
  255. package/dist/stores/message/ioredis.js +1 -96
  256. package/dist/stores/message/momento.cjs +15 -160
  257. package/dist/stores/message/momento.d.ts +1 -97
  258. package/dist/stores/message/momento.js +1 -158
  259. package/dist/stores/message/mongodb.cjs +15 -57
  260. package/dist/stores/message/mongodb.d.ts +1 -26
  261. package/dist/stores/message/mongodb.js +1 -55
  262. package/dist/stores/message/planetscale.cjs +15 -170
  263. package/dist/stores/message/planetscale.d.ts +1 -75
  264. package/dist/stores/message/planetscale.js +1 -168
  265. package/dist/stores/message/redis.cjs +15 -114
  266. package/dist/stores/message/redis.d.ts +1 -69
  267. package/dist/stores/message/redis.js +1 -112
  268. package/dist/stores/message/upstash_redis.cjs +15 -85
  269. package/dist/stores/message/upstash_redis.d.ts +1 -43
  270. package/dist/stores/message/upstash_redis.js +1 -83
  271. package/dist/stores/message/utils.cjs +3 -23
  272. package/dist/stores/message/utils.d.ts +1 -17
  273. package/dist/stores/message/utils.js +1 -21
  274. package/dist/stores/message/xata.cjs +15 -216
  275. package/dist/stores/message/xata.d.ts +1 -76
  276. package/dist/stores/message/xata.js +1 -214
  277. package/dist/tools/IFTTTWebhook.cjs +15 -87
  278. package/dist/tools/IFTTTWebhook.d.ts +1 -50
  279. package/dist/tools/IFTTTWebhook.js +1 -85
  280. package/dist/tools/aiplugin.cjs +15 -73
  281. package/dist/tools/aiplugin.d.ts +1 -34
  282. package/dist/tools/aiplugin.js +1 -71
  283. package/dist/tools/aws_sfn.cjs +15 -201
  284. package/dist/tools/aws_sfn.d.ts +1 -57
  285. package/dist/tools/aws_sfn.js +1 -197
  286. package/dist/tools/bingserpapi.cjs +15 -76
  287. package/dist/tools/bingserpapi.d.ts +1 -23
  288. package/dist/tools/bingserpapi.js +1 -75
  289. package/dist/tools/brave_search.cjs +15 -64
  290. package/dist/tools/brave_search.d.ts +1 -23
  291. package/dist/tools/brave_search.js +1 -62
  292. package/dist/tools/connery.cjs +15 -277
  293. package/dist/tools/connery.d.ts +1 -145
  294. package/dist/tools/connery.js +1 -274
  295. package/dist/tools/convert_to_openai.d.ts +1 -1
  296. package/dist/tools/dadjokeapi.cjs +15 -46
  297. package/dist/tools/dadjokeapi.d.ts +1 -15
  298. package/dist/tools/dadjokeapi.js +1 -45
  299. package/dist/tools/dataforseo_api_search.cjs +15 -280
  300. package/dist/tools/dataforseo_api_search.d.ts +1 -170
  301. package/dist/tools/dataforseo_api_search.js +1 -278
  302. package/dist/tools/gmail/index.cjs +15 -11
  303. package/dist/tools/gmail/index.d.ts +1 -11
  304. package/dist/tools/gmail/index.js +1 -5
  305. package/dist/tools/google_custom_search.cjs +15 -70
  306. package/dist/tools/google_custom_search.d.ts +1 -25
  307. package/dist/tools/google_custom_search.js +1 -68
  308. package/dist/tools/google_places.cjs +15 -79
  309. package/dist/tools/google_places.d.ts +1 -21
  310. package/dist/tools/google_places.js +1 -77
  311. package/dist/tools/searchapi.cjs +15 -164
  312. package/dist/tools/searchapi.d.ts +1 -91
  313. package/dist/tools/searchapi.js +1 -162
  314. package/dist/tools/searxng_search.cjs +15 -156
  315. package/dist/tools/searxng_search.d.ts +1 -114
  316. package/dist/tools/searxng_search.js +1 -154
  317. package/dist/tools/serpapi.cjs +15 -199
  318. package/dist/tools/serpapi.d.ts +1 -302
  319. package/dist/tools/serpapi.js +1 -197
  320. package/dist/tools/serper.cjs +15 -94
  321. package/dist/tools/serper.d.ts +1 -32
  322. package/dist/tools/serper.js +1 -92
  323. package/dist/tools/wikipedia_query_run.cjs +15 -133
  324. package/dist/tools/wikipedia_query_run.d.ts +1 -54
  325. package/dist/tools/wikipedia_query_run.js +1 -131
  326. package/dist/tools/wolframalpha.cjs +15 -47
  327. package/dist/tools/wolframalpha.d.ts +1 -21
  328. package/dist/tools/wolframalpha.js +1 -45
  329. package/dist/types/openai-types.d.ts +1 -1
  330. package/dist/util/convex.d.ts +1 -1
  331. package/dist/util/event-source-parse.cjs +15 -224
  332. package/dist/util/event-source-parse.d.ts +1 -39
  333. package/dist/util/event-source-parse.js +1 -219
  334. package/dist/util/math.cjs +15 -123
  335. package/dist/util/math.d.ts +1 -40
  336. package/dist/util/math.js +1 -116
  337. package/dist/util/openapi.d.ts +2 -2
  338. package/dist/vectorstores/analyticdb.cjs +3 -333
  339. package/dist/vectorstores/analyticdb.d.ts +1 -110
  340. package/dist/vectorstores/analyticdb.js +1 -317
  341. package/dist/vectorstores/base.cjs +15 -165
  342. package/dist/vectorstores/base.d.ts +1 -104
  343. package/dist/vectorstores/base.js +1 -161
  344. package/dist/vectorstores/cassandra.cjs +15 -478
  345. package/dist/vectorstores/cassandra.d.ts +1 -162
  346. package/dist/vectorstores/cassandra.js +1 -476
  347. package/dist/vectorstores/chroma.cjs +3 -312
  348. package/dist/vectorstores/chroma.d.ts +1 -133
  349. package/dist/vectorstores/chroma.js +1 -299
  350. package/dist/vectorstores/clickhouse.cjs +3 -272
  351. package/dist/vectorstores/clickhouse.d.ts +1 -126
  352. package/dist/vectorstores/clickhouse.js +1 -259
  353. package/dist/vectorstores/closevector/node.cjs +15 -107
  354. package/dist/vectorstores/closevector/node.d.ts +1 -83
  355. package/dist/vectorstores/closevector/node.js +1 -105
  356. package/dist/vectorstores/closevector/web.cjs +15 -107
  357. package/dist/vectorstores/closevector/web.d.ts +1 -80
  358. package/dist/vectorstores/closevector/web.js +1 -105
  359. package/dist/vectorstores/cloudflare_vectorize.cjs +3 -186
  360. package/dist/vectorstores/cloudflare_vectorize.d.ts +1 -90
  361. package/dist/vectorstores/cloudflare_vectorize.js +1 -173
  362. package/dist/vectorstores/convex.cjs +15 -175
  363. package/dist/vectorstores/convex.d.ts +1 -134
  364. package/dist/vectorstores/convex.js +1 -173
  365. package/dist/vectorstores/elasticsearch.cjs +3 -287
  366. package/dist/vectorstores/elasticsearch.d.ts +1 -143
  367. package/dist/vectorstores/elasticsearch.js +1 -274
  368. package/dist/vectorstores/faiss.cjs +3 -378
  369. package/dist/vectorstores/faiss.d.ts +1 -127
  370. package/dist/vectorstores/faiss.js +1 -365
  371. package/dist/vectorstores/googlevertexai.cjs +3 -538
  372. package/dist/vectorstores/googlevertexai.d.ts +1 -181
  373. package/dist/vectorstores/googlevertexai.js +1 -521
  374. package/dist/vectorstores/hnswlib.cjs +15 -273
  375. package/dist/vectorstores/hnswlib.d.ts +1 -122
  376. package/dist/vectorstores/hnswlib.js +1 -271
  377. package/dist/vectorstores/lancedb.cjs +15 -126
  378. package/dist/vectorstores/lancedb.d.ts +1 -61
  379. package/dist/vectorstores/lancedb.js +1 -124
  380. package/dist/vectorstores/memory.cjs +15 -143
  381. package/dist/vectorstores/memory.d.ts +1 -92
  382. package/dist/vectorstores/memory.js +1 -141
  383. package/dist/vectorstores/milvus.cjs +3 -592
  384. package/dist/vectorstores/milvus.d.ts +1 -139
  385. package/dist/vectorstores/milvus.js +1 -579
  386. package/dist/vectorstores/momento_vector_index.cjs +3 -305
  387. package/dist/vectorstores/momento_vector_index.d.ts +1 -143
  388. package/dist/vectorstores/momento_vector_index.js +1 -292
  389. package/dist/vectorstores/mongodb_atlas.cjs +15 -218
  390. package/dist/vectorstores/mongodb_atlas.d.ts +1 -118
  391. package/dist/vectorstores/mongodb_atlas.js +1 -216
  392. package/dist/vectorstores/myscale.cjs +3 -263
  393. package/dist/vectorstores/myscale.d.ts +1 -129
  394. package/dist/vectorstores/myscale.js +1 -250
  395. package/dist/vectorstores/neo4j_vector.cjs +3 -578
  396. package/dist/vectorstores/neo4j_vector.d.ts +1 -75
  397. package/dist/vectorstores/neo4j_vector.js +1 -562
  398. package/dist/vectorstores/opensearch.cjs +3 -274
  399. package/dist/vectorstores/opensearch.d.ts +1 -119
  400. package/dist/vectorstores/opensearch.js +1 -261
  401. package/dist/vectorstores/pgvector.cjs +14 -404
  402. package/dist/vectorstores/pgvector.d.ts +1 -160
  403. package/dist/vectorstores/pgvector.js +1 -400
  404. package/dist/vectorstores/pinecone.cjs +3 -280
  405. package/dist/vectorstores/pinecone.d.ts +1 -120
  406. package/dist/vectorstores/pinecone.js +1 -264
  407. package/dist/vectorstores/prisma.cjs +15 -305
  408. package/dist/vectorstores/prisma.d.ts +1 -180
  409. package/dist/vectorstores/prisma.js +1 -303
  410. package/dist/vectorstores/qdrant.cjs +15 -195
  411. package/dist/vectorstores/qdrant.d.ts +1 -95
  412. package/dist/vectorstores/qdrant.js +1 -193
  413. package/dist/vectorstores/redis.cjs +15 -333
  414. package/dist/vectorstores/redis.d.ts +1 -186
  415. package/dist/vectorstores/redis.js +1 -331
  416. package/dist/vectorstores/rockset.cjs +15 -351
  417. package/dist/vectorstores/rockset.d.ts +1 -202
  418. package/dist/vectorstores/rockset.js +1 -347
  419. package/dist/vectorstores/singlestore.cjs +15 -220
  420. package/dist/vectorstores/singlestore.d.ts +1 -88
  421. package/dist/vectorstores/singlestore.js +1 -218
  422. package/dist/vectorstores/supabase.cjs +15 -217
  423. package/dist/vectorstores/supabase.d.ts +1 -118
  424. package/dist/vectorstores/supabase.js +1 -215
  425. package/dist/vectorstores/tigris.cjs +3 -143
  426. package/dist/vectorstores/tigris.d.ts +1 -74
  427. package/dist/vectorstores/tigris.js +1 -130
  428. package/dist/vectorstores/typeorm.cjs +15 -259
  429. package/dist/vectorstores/typeorm.d.ts +1 -109
  430. package/dist/vectorstores/typeorm.js +1 -256
  431. package/dist/vectorstores/typesense.cjs +15 -223
  432. package/dist/vectorstores/typesense.d.ts +1 -131
  433. package/dist/vectorstores/typesense.js +1 -221
  434. package/dist/vectorstores/usearch.cjs +3 -203
  435. package/dist/vectorstores/usearch.d.ts +1 -85
  436. package/dist/vectorstores/usearch.js +1 -187
  437. package/dist/vectorstores/vectara.cjs +3 -409
  438. package/dist/vectorstores/vectara.d.ts +1 -148
  439. package/dist/vectorstores/vectara.js +1 -396
  440. package/dist/vectorstores/vercel_postgres.cjs +15 -320
  441. package/dist/vectorstores/vercel_postgres.d.ts +1 -145
  442. package/dist/vectorstores/vercel_postgres.js +1 -318
  443. package/dist/vectorstores/voy.cjs +15 -156
  444. package/dist/vectorstores/voy.d.ts +1 -73
  445. package/dist/vectorstores/voy.js +1 -154
  446. package/dist/vectorstores/weaviate.cjs +3 -347
  447. package/dist/vectorstores/weaviate.d.ts +1 -140
  448. package/dist/vectorstores/weaviate.js +1 -333
  449. package/dist/vectorstores/xata.cjs +15 -108
  450. package/dist/vectorstores/xata.d.ts +1 -70
  451. package/dist/vectorstores/xata.js +1 -106
  452. package/dist/vectorstores/zep.cjs +15 -313
  453. package/dist/vectorstores/zep.d.ts +1 -146
  454. package/dist/vectorstores/zep.js +1 -311
  455. package/package.json +4 -26
  456. package/dist/chat_models/googlevertexai/common.cjs +0 -274
  457. package/dist/chat_models/googlevertexai/common.d.ts +0 -123
  458. package/dist/chat_models/googlevertexai/common.js +0 -269
  459. package/dist/chat_models/iflytek_xinghuo/common.cjs +0 -340
  460. package/dist/chat_models/iflytek_xinghuo/common.d.ts +0 -165
  461. package/dist/chat_models/iflytek_xinghuo/common.js +0 -336
  462. package/dist/llms/googlevertexai/common.cjs +0 -168
  463. package/dist/llms/googlevertexai/common.d.ts +0 -82
  464. package/dist/llms/googlevertexai/common.js +0 -164
  465. package/dist/tools/gmail/base.cjs +0 -69
  466. package/dist/tools/gmail/base.d.ts +0 -19
  467. package/dist/tools/gmail/base.js +0 -65
  468. package/dist/tools/gmail/create_draft.cjs +0 -62
  469. package/dist/tools/gmail/create_draft.d.ts +0 -35
  470. package/dist/tools/gmail/create_draft.js +0 -58
  471. package/dist/tools/gmail/descriptions.cjs +0 -118
  472. package/dist/tools/gmail/descriptions.d.ts +0 -5
  473. package/dist/tools/gmail/descriptions.js +0 -115
  474. package/dist/tools/gmail/get_message.cjs +0 -83
  475. package/dist/tools/gmail/get_message.d.ts +0 -18
  476. package/dist/tools/gmail/get_message.js +0 -79
  477. package/dist/tools/gmail/get_thread.cjs +0 -89
  478. package/dist/tools/gmail/get_thread.d.ts +0 -18
  479. package/dist/tools/gmail/get_thread.js +0 -85
  480. package/dist/tools/gmail/search.cjs +0 -118
  481. package/dist/tools/gmail/search.d.ts +0 -29
  482. package/dist/tools/gmail/search.js +0 -114
  483. package/dist/tools/gmail/send_message.cjs +0 -74
  484. package/dist/tools/gmail/send_message.d.ts +0 -35
  485. package/dist/tools/gmail/send_message.js +0 -70
  486. package/dist/util/openai-format-fndef.cjs +0 -81
  487. package/dist/util/openai-format-fndef.d.ts +0 -44
  488. package/dist/util/openai-format-fndef.js +0 -77
  489. package/dist/util/openai.cjs +0 -21
  490. package/dist/util/openai.d.ts +0 -1
  491. package/dist/util/openai.js +0 -17
  492. package/dist/vectorstores/closevector/common.cjs +0 -128
  493. package/dist/vectorstores/closevector/common.d.ts +0 -82
  494. package/dist/vectorstores/closevector/common.js +0 -124
@@ -1,292 +1 @@
1
- /* eslint-disable no-instanceof/no-instanceof */
2
- /* eslint-disable @typescript-eslint/no-explicit-any */
3
- import { ALL_VECTOR_METADATA, CreateVectorIndex, VectorUpsertItemBatch, VectorDeleteItemBatch, VectorSearch, VectorSearchAndFetchVectors, } from "@gomomento/sdk-core";
4
- import * as uuid from "uuid";
5
- import { Document } from "../document.js";
6
- import { VectorStore } from "./base.js";
7
- import { maximalMarginalRelevance } from "../util/math.js";
8
- /**
9
- * A vector store that uses the Momento Vector Index.
10
- *
11
- * @remarks
12
- * To sign up for a free Momento account, visit https://console.gomomento.com.
13
- */
14
- export class MomentoVectorIndex extends VectorStore {
15
- _vectorstoreType() {
16
- return "momento";
17
- }
18
- /**
19
- * Creates a new `MomentoVectorIndex` instance.
20
- * @param embeddings The embeddings instance to use to generate embeddings from documents.
21
- * @param args The arguments to use to configure the vector store.
22
- */
23
- constructor(embeddings, args) {
24
- super(embeddings, args);
25
- Object.defineProperty(this, "client", {
26
- enumerable: true,
27
- configurable: true,
28
- writable: true,
29
- value: void 0
30
- });
31
- Object.defineProperty(this, "indexName", {
32
- enumerable: true,
33
- configurable: true,
34
- writable: true,
35
- value: void 0
36
- });
37
- Object.defineProperty(this, "textField", {
38
- enumerable: true,
39
- configurable: true,
40
- writable: true,
41
- value: void 0
42
- });
43
- Object.defineProperty(this, "_ensureIndexExists", {
44
- enumerable: true,
45
- configurable: true,
46
- writable: true,
47
- value: void 0
48
- });
49
- this.embeddings = embeddings;
50
- this.client = args.client;
51
- this.indexName = args.indexName ?? "default";
52
- this.textField = args.textField ?? "text";
53
- this._ensureIndexExists = args.ensureIndexExists ?? true;
54
- }
55
- /**
56
- * Returns the Momento Vector Index client.
57
- * @returns The Momento Vector Index client.
58
- */
59
- getClient() {
60
- return this.client;
61
- }
62
- /**
63
- * Creates the index if it does not already exist.
64
- * @param numDimensions The number of dimensions of the vectors to be stored in the index.
65
- * @returns Promise that resolves to true if the index was created, false if it already existed.
66
- */
67
- async ensureIndexExists(numDimensions) {
68
- const response = await this.client.createIndex(this.indexName, numDimensions);
69
- if (response instanceof CreateVectorIndex.Success) {
70
- return true;
71
- }
72
- else if (response instanceof CreateVectorIndex.AlreadyExists) {
73
- return false;
74
- }
75
- else if (response instanceof CreateVectorIndex.Error) {
76
- throw new Error(response.toString());
77
- }
78
- else {
79
- throw new Error(`Unknown response type: ${response.toString()}`);
80
- }
81
- }
82
- /**
83
- * Converts the documents to a format that can be stored in the index.
84
- *
85
- * This is necessary because the Momento Vector Index requires that the metadata
86
- * be a map of strings to strings.
87
- * @param vectors The vectors to convert.
88
- * @param documents The documents to convert.
89
- * @param ids The ids to convert.
90
- * @returns The converted documents.
91
- */
92
- prepareItemBatch(vectors, documents, ids) {
93
- return vectors.map((vector, idx) => ({
94
- id: ids[idx],
95
- vector,
96
- metadata: {
97
- ...documents[idx].metadata,
98
- [this.textField]: documents[idx].pageContent,
99
- },
100
- }));
101
- }
102
- /**
103
- * Adds vectors to the index.
104
- *
105
- * @remarks If the index does not already exist, it will be created if `ensureIndexExists` is true.
106
- * @param vectors The vectors to add to the index.
107
- * @param documents The documents to add to the index.
108
- * @param documentProps The properties of the documents to add to the index, specifically the ids.
109
- * @returns Promise that resolves when the vectors have been added to the index. Also returns the ids of the
110
- * documents that were added.
111
- */
112
- async addVectors(vectors, documents, documentProps) {
113
- if (vectors.length === 0) {
114
- return;
115
- }
116
- if (documents.length !== vectors.length) {
117
- throw new Error(`Number of vectors (${vectors.length}) does not equal number of documents (${documents.length})`);
118
- }
119
- if (vectors.some((v) => v.length !== vectors[0].length)) {
120
- throw new Error("All vectors must have the same length");
121
- }
122
- if (documentProps?.ids !== undefined &&
123
- documentProps.ids.length !== vectors.length) {
124
- throw new Error(`Number of ids (${documentProps?.ids?.length || "null"}) does not equal number of vectors (${vectors.length})`);
125
- }
126
- if (this._ensureIndexExists) {
127
- await this.ensureIndexExists(vectors[0].length);
128
- }
129
- const documentIds = documentProps?.ids ?? documents.map(() => uuid.v4());
130
- const batchSize = 128;
131
- const numBatches = Math.ceil(vectors.length / batchSize);
132
- // Add each batch of vectors to the index
133
- for (let i = 0; i < numBatches; i += 1) {
134
- const [startIndex, endIndex] = [
135
- i * batchSize,
136
- Math.min((i + 1) * batchSize, vectors.length),
137
- ];
138
- const batchVectors = vectors.slice(startIndex, endIndex);
139
- const batchDocuments = documents.slice(startIndex, endIndex);
140
- const batchDocumentIds = documentIds.slice(startIndex, endIndex);
141
- // Insert the items to the index
142
- const response = await this.client.upsertItemBatch(this.indexName, this.prepareItemBatch(batchVectors, batchDocuments, batchDocumentIds));
143
- if (response instanceof VectorUpsertItemBatch.Success) {
144
- // eslint-disable-next-line no-continue
145
- continue;
146
- }
147
- else if (response instanceof VectorUpsertItemBatch.Error) {
148
- throw new Error(response.toString());
149
- }
150
- else {
151
- throw new Error(`Unknown response type: ${response.toString()}`);
152
- }
153
- }
154
- }
155
- /**
156
- * Adds vectors to the index. Generates embeddings from the documents
157
- * using the `Embeddings` instance passed to the constructor.
158
- * @param documents Array of `Document` instances to be added to the index.
159
- * @returns Promise that resolves when the documents have been added to the index.
160
- */
161
- async addDocuments(documents, documentProps) {
162
- const texts = documents.map(({ pageContent }) => pageContent);
163
- await this.addVectors(await this.embeddings.embedDocuments(texts), documents, documentProps);
164
- }
165
- /**
166
- * Deletes vectors from the index by id.
167
- * @param params The parameters to use to delete the vectors, specifically the ids.
168
- */
169
- async delete(params) {
170
- const response = await this.client.deleteItemBatch(this.indexName, params.ids);
171
- if (response instanceof VectorDeleteItemBatch.Success) {
172
- // pass
173
- }
174
- else if (response instanceof VectorDeleteItemBatch.Error) {
175
- throw new Error(response.toString());
176
- }
177
- else {
178
- throw new Error(`Unknown response type: ${response.toString()}`);
179
- }
180
- }
181
- /**
182
- * Searches the index for the most similar vectors to the query vector.
183
- * @param query The query vector.
184
- * @param k The number of results to return.
185
- * @returns Promise that resolves to the documents of the most similar vectors
186
- * to the query vector.
187
- */
188
- async similaritySearchVectorWithScore(query, k) {
189
- const response = await this.client.search(this.indexName, query, {
190
- topK: k,
191
- metadataFields: ALL_VECTOR_METADATA,
192
- });
193
- if (response instanceof VectorSearch.Success) {
194
- if (response.hits === undefined) {
195
- return [];
196
- }
197
- return response.hits().map((hit) => [
198
- new Document({
199
- pageContent: hit.metadata[this.textField]?.toString() ?? "",
200
- metadata: Object.fromEntries(Object.entries(hit.metadata).filter(([key]) => key !== this.textField)),
201
- }),
202
- hit.score,
203
- ]);
204
- }
205
- else if (response instanceof VectorSearch.Error) {
206
- throw new Error(response.toString());
207
- }
208
- else {
209
- throw new Error(`Unknown response type: ${response.toString()}`);
210
- }
211
- }
212
- /**
213
- * Return documents selected using the maximal marginal relevance.
214
- * Maximal marginal relevance optimizes for similarity to the query AND diversity
215
- * among selected documents.
216
- *
217
- * @param {string} query - Text to look up documents similar to.
218
- * @param {number} options.k - Number of documents to return.
219
- * @param {number} options.fetchK - Number of documents to fetch before passing to the MMR algorithm.
220
- * @param {number} options.lambda - Number between 0 and 1 that determines the degree of diversity among the results,
221
- * where 0 corresponds to maximum diversity and 1 to minimum diversity.
222
- * @param {this["FilterType"]} options.filter - Optional filter
223
- * @param _callbacks
224
- *
225
- * @returns {Promise<Document[]>} - List of documents selected by maximal marginal relevance.
226
- */
227
- async maxMarginalRelevanceSearch(query, options) {
228
- const queryEmbedding = await this.embeddings.embedQuery(query);
229
- const response = await this.client.searchAndFetchVectors(this.indexName, queryEmbedding, { topK: options.fetchK ?? 20, metadataFields: ALL_VECTOR_METADATA });
230
- if (response instanceof VectorSearchAndFetchVectors.Success) {
231
- const hits = response.hits();
232
- // Gather the embeddings of the search results
233
- const embeddingList = hits.map((hit) => hit.vector);
234
- // Gather the ids of the most relevant results when applying MMR
235
- const mmrIndexes = maximalMarginalRelevance(queryEmbedding, embeddingList, options.lambda, options.k);
236
- const finalResult = mmrIndexes.map((index) => {
237
- const hit = hits[index];
238
- const { [this.textField]: pageContent, ...metadata } = hit.metadata;
239
- return new Document({ metadata, pageContent: pageContent });
240
- });
241
- return finalResult;
242
- }
243
- else if (response instanceof VectorSearchAndFetchVectors.Error) {
244
- throw new Error(response.toString());
245
- }
246
- else {
247
- throw new Error(`Unknown response type: ${response.toString()}`);
248
- }
249
- }
250
- /**
251
- * Stores the documents in the index.
252
- *
253
- * Converts the documents to vectors using the `Embeddings` instance passed.
254
- * @param texts The texts to store in the index.
255
- * @param metadatas The metadata to store in the index.
256
- * @param embeddings The embeddings instance to use to generate embeddings from the documents.
257
- * @param dbConfig The configuration to use to instantiate the vector store.
258
- * @param documentProps The properties of the documents to add to the index, specifically the ids.
259
- * @returns Promise that resolves to the vector store.
260
- */
261
- static async fromTexts(texts, metadatas, embeddings, dbConfig, documentProps) {
262
- if (Array.isArray(metadatas) && texts.length !== metadatas.length) {
263
- throw new Error(`Number of texts (${texts.length}) does not equal number of metadatas (${metadatas.length})`);
264
- }
265
- const docs = [];
266
- for (let i = 0; i < texts.length; i += 1) {
267
- // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
268
- const metadata = Array.isArray(metadatas)
269
- ? metadatas[i]
270
- : metadatas;
271
- const newDoc = new Document({
272
- pageContent: texts[i],
273
- metadata,
274
- });
275
- docs.push(newDoc);
276
- }
277
- return await this.fromDocuments(docs, embeddings, dbConfig, documentProps);
278
- }
279
- /**
280
- * Stores the documents in the index.
281
- * @param docs The documents to store in the index.
282
- * @param embeddings The embeddings instance to use to generate embeddings from the documents.
283
- * @param dbConfig The configuration to use to instantiate the vector store.
284
- * @param documentProps The properties of the documents to add to the index, specifically the ids.
285
- * @returns Promise that resolves to the vector store.
286
- */
287
- static async fromDocuments(docs, embeddings, dbConfig, documentProps) {
288
- const vectorStore = new MomentoVectorIndex(embeddings, dbConfig);
289
- await vectorStore.addDocuments(docs, documentProps);
290
- return vectorStore;
291
- }
292
- }
1
+ export * from "@langchain/community/vectorstores/momento_vector_index";
@@ -1,220 +1,17 @@
1
1
  "use strict";
2
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
+ if (k2 === undefined) k2 = k;
4
+ var desc = Object.getOwnPropertyDescriptor(m, k);
5
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
+ desc = { enumerable: true, get: function() { return m[k]; } };
7
+ }
8
+ Object.defineProperty(o, k2, desc);
9
+ }) : (function(o, m, k, k2) {
10
+ if (k2 === undefined) k2 = k;
11
+ o[k2] = m[k];
12
+ }));
13
+ var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
+ for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
+ };
2
16
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.MongoDBAtlasVectorSearch = void 0;
4
- const base_js_1 = require("./base.cjs");
5
- const document_js_1 = require("../document.cjs");
6
- const math_js_1 = require("../util/math.cjs");
7
- /**
8
- * Class that is a wrapper around MongoDB Atlas Vector Search. It is used
9
- * to store embeddings in MongoDB documents, create a vector search index,
10
- * and perform K-Nearest Neighbors (KNN) search with an approximate
11
- * nearest neighbor algorithm.
12
- */
13
- class MongoDBAtlasVectorSearch extends base_js_1.VectorStore {
14
- _vectorstoreType() {
15
- return "mongodb_atlas";
16
- }
17
- constructor(embeddings, args) {
18
- super(embeddings, args);
19
- Object.defineProperty(this, "collection", {
20
- enumerable: true,
21
- configurable: true,
22
- writable: true,
23
- value: void 0
24
- });
25
- Object.defineProperty(this, "indexName", {
26
- enumerable: true,
27
- configurable: true,
28
- writable: true,
29
- value: void 0
30
- });
31
- Object.defineProperty(this, "textKey", {
32
- enumerable: true,
33
- configurable: true,
34
- writable: true,
35
- value: void 0
36
- });
37
- Object.defineProperty(this, "embeddingKey", {
38
- enumerable: true,
39
- configurable: true,
40
- writable: true,
41
- value: void 0
42
- });
43
- this.collection = args.collection;
44
- this.indexName = args.indexName ?? "default";
45
- this.textKey = args.textKey ?? "text";
46
- this.embeddingKey = args.embeddingKey ?? "embedding";
47
- }
48
- /**
49
- * Method to add vectors and their corresponding documents to the MongoDB
50
- * collection.
51
- * @param vectors Vectors to be added.
52
- * @param documents Corresponding documents to be added.
53
- * @returns Promise that resolves when the vectors and documents have been added.
54
- */
55
- async addVectors(vectors, documents) {
56
- const docs = vectors.map((embedding, idx) => ({
57
- [this.textKey]: documents[idx].pageContent,
58
- [this.embeddingKey]: embedding,
59
- ...documents[idx].metadata,
60
- }));
61
- await this.collection.insertMany(docs);
62
- }
63
- /**
64
- * Method to add documents to the MongoDB collection. It first converts
65
- * the documents to vectors using the embeddings and then calls the
66
- * addVectors method.
67
- * @param documents Documents to be added.
68
- * @returns Promise that resolves when the documents have been added.
69
- */
70
- async addDocuments(documents) {
71
- const texts = documents.map(({ pageContent }) => pageContent);
72
- return this.addVectors(await this.embeddings.embedDocuments(texts), documents);
73
- }
74
- /**
75
- * Method that performs a similarity search on the vectors stored in the
76
- * MongoDB collection. It returns a list of documents and their
77
- * corresponding similarity scores.
78
- * @param query Query vector for the similarity search.
79
- * @param k Number of nearest neighbors to return.
80
- * @param filter Optional filter to be applied.
81
- * @returns Promise that resolves to a list of documents and their corresponding similarity scores.
82
- */
83
- async similaritySearchVectorWithScore(query, k, filter) {
84
- const postFilterPipeline = filter?.postFilterPipeline ?? [];
85
- const preFilter = filter?.preFilter ||
86
- filter?.postFilterPipeline ||
87
- filter?.includeEmbeddings
88
- ? filter.preFilter
89
- : filter;
90
- const removeEmbeddingsPipeline = !filter?.includeEmbeddings
91
- ? [
92
- {
93
- $project: {
94
- [this.embeddingKey]: 0,
95
- },
96
- },
97
- ]
98
- : [];
99
- const pipeline = [
100
- {
101
- $vectorSearch: {
102
- queryVector: MongoDBAtlasVectorSearch.fixArrayPrecision(query),
103
- index: this.indexName,
104
- path: this.embeddingKey,
105
- limit: k,
106
- numCandidates: 10 * k,
107
- ...(preFilter && { filter: preFilter }),
108
- },
109
- },
110
- {
111
- $set: {
112
- score: { $meta: "vectorSearchScore" },
113
- },
114
- },
115
- ...removeEmbeddingsPipeline,
116
- ...postFilterPipeline,
117
- ];
118
- const results = this.collection
119
- .aggregate(pipeline)
120
- .map((result) => {
121
- const { score, [this.textKey]: text, ...metadata } = result;
122
- return [new document_js_1.Document({ pageContent: text, metadata }), score];
123
- });
124
- return results.toArray();
125
- }
126
- /**
127
- * Return documents selected using the maximal marginal relevance.
128
- * Maximal marginal relevance optimizes for similarity to the query AND diversity
129
- * among selected documents.
130
- *
131
- * @param {string} query - Text to look up documents similar to.
132
- * @param {number} options.k - Number of documents to return.
133
- * @param {number} options.fetchK=20- Number of documents to fetch before passing to the MMR algorithm.
134
- * @param {number} options.lambda=0.5 - Number between 0 and 1 that determines the degree of diversity among the results,
135
- * where 0 corresponds to maximum diversity and 1 to minimum diversity.
136
- * @param {MongoDBAtlasFilter} options.filter - Optional Atlas Search operator to pre-filter on document fields
137
- * or post-filter following the knnBeta search.
138
- *
139
- * @returns {Promise<Document[]>} - List of documents selected by maximal marginal relevance.
140
- */
141
- async maxMarginalRelevanceSearch(query, options) {
142
- const { k, fetchK = 20, lambda = 0.5, filter } = options;
143
- const queryEmbedding = await this.embeddings.embedQuery(query);
144
- // preserve the original value of includeEmbeddings
145
- const includeEmbeddingsFlag = options.filter?.includeEmbeddings || false;
146
- // update filter to include embeddings, as they will be used in MMR
147
- const includeEmbeddingsFilter = {
148
- ...filter,
149
- includeEmbeddings: true,
150
- };
151
- const resultDocs = await this.similaritySearchVectorWithScore(MongoDBAtlasVectorSearch.fixArrayPrecision(queryEmbedding), fetchK, includeEmbeddingsFilter);
152
- const embeddingList = resultDocs.map((doc) => doc[0].metadata[this.embeddingKey]);
153
- const mmrIndexes = (0, math_js_1.maximalMarginalRelevance)(queryEmbedding, embeddingList, lambda, k);
154
- return mmrIndexes.map((idx) => {
155
- const doc = resultDocs[idx][0];
156
- // remove embeddings if they were not requested originally
157
- if (!includeEmbeddingsFlag) {
158
- delete doc.metadata[this.embeddingKey];
159
- }
160
- return doc;
161
- });
162
- }
163
- /**
164
- * Static method to create an instance of MongoDBAtlasVectorSearch from a
165
- * list of texts. It first converts the texts to vectors and then adds
166
- * them to the MongoDB collection.
167
- * @param texts List of texts to be converted to vectors.
168
- * @param metadatas Metadata for the texts.
169
- * @param embeddings Embeddings to be used for conversion.
170
- * @param dbConfig Database configuration for MongoDB Atlas.
171
- * @returns Promise that resolves to a new instance of MongoDBAtlasVectorSearch.
172
- */
173
- static async fromTexts(texts, metadatas, embeddings, dbConfig) {
174
- const docs = [];
175
- for (let i = 0; i < texts.length; i += 1) {
176
- const metadata = Array.isArray(metadatas) ? metadatas[i] : metadatas;
177
- const newDoc = new document_js_1.Document({
178
- pageContent: texts[i],
179
- metadata,
180
- });
181
- docs.push(newDoc);
182
- }
183
- return MongoDBAtlasVectorSearch.fromDocuments(docs, embeddings, dbConfig);
184
- }
185
- /**
186
- * Static method to create an instance of MongoDBAtlasVectorSearch from a
187
- * list of documents. It first converts the documents to vectors and then
188
- * adds them to the MongoDB collection.
189
- * @param docs List of documents to be converted to vectors.
190
- * @param embeddings Embeddings to be used for conversion.
191
- * @param dbConfig Database configuration for MongoDB Atlas.
192
- * @returns Promise that resolves to a new instance of MongoDBAtlasVectorSearch.
193
- */
194
- static async fromDocuments(docs, embeddings, dbConfig) {
195
- const instance = new this(embeddings, dbConfig);
196
- await instance.addDocuments(docs);
197
- return instance;
198
- }
199
- /**
200
- * Static method to fix the precision of the array that ensures that
201
- * every number in this array is always float when casted to other types.
202
- * This is needed since MongoDB Atlas Vector Search does not cast integer
203
- * inside vector search to float automatically.
204
- * This method shall introduce a hint of error but should be safe to use
205
- * since introduced error is very small, only applies to integer numbers
206
- * returned by embeddings, and most embeddings shall not have precision
207
- * as high as 15 decimal places.
208
- * @param array Array of number to be fixed.
209
- * @returns
210
- */
211
- static fixArrayPrecision(array) {
212
- return array.map((value) => {
213
- if (Number.isInteger(value)) {
214
- return value + 0.000000000000001;
215
- }
216
- return value;
217
- });
218
- }
219
- }
220
- exports.MongoDBAtlasVectorSearch = MongoDBAtlasVectorSearch;
17
+ __exportStar(require("@langchain/community/vectorstores/mongodb_atlas"), exports);
@@ -1,118 +1 @@
1
- import type { Collection, Document as MongoDBDocument } from "mongodb";
2
- import { MaxMarginalRelevanceSearchOptions, VectorStore } from "./base.js";
3
- import { Embeddings } from "../embeddings/base.js";
4
- import { Document } from "../document.js";
5
- /**
6
- * Type that defines the arguments required to initialize the
7
- * MongoDBAtlasVectorSearch class. It includes the MongoDB collection,
8
- * index name, text key, and embedding key.
9
- */
10
- export type MongoDBAtlasVectorSearchLibArgs = {
11
- readonly collection: Collection<MongoDBDocument>;
12
- readonly indexName?: string;
13
- readonly textKey?: string;
14
- readonly embeddingKey?: string;
15
- };
16
- /**
17
- * Type that defines the filter used in the
18
- * similaritySearchVectorWithScore and maxMarginalRelevanceSearch methods.
19
- * It includes pre-filter, post-filter pipeline, and a flag to include
20
- * embeddings.
21
- */
22
- type MongoDBAtlasFilter = {
23
- preFilter?: MongoDBDocument;
24
- postFilterPipeline?: MongoDBDocument[];
25
- includeEmbeddings?: boolean;
26
- } & MongoDBDocument;
27
- /**
28
- * Class that is a wrapper around MongoDB Atlas Vector Search. It is used
29
- * to store embeddings in MongoDB documents, create a vector search index,
30
- * and perform K-Nearest Neighbors (KNN) search with an approximate
31
- * nearest neighbor algorithm.
32
- */
33
- export declare class MongoDBAtlasVectorSearch extends VectorStore {
34
- FilterType: MongoDBAtlasFilter;
35
- private readonly collection;
36
- private readonly indexName;
37
- private readonly textKey;
38
- private readonly embeddingKey;
39
- _vectorstoreType(): string;
40
- constructor(embeddings: Embeddings, args: MongoDBAtlasVectorSearchLibArgs);
41
- /**
42
- * Method to add vectors and their corresponding documents to the MongoDB
43
- * collection.
44
- * @param vectors Vectors to be added.
45
- * @param documents Corresponding documents to be added.
46
- * @returns Promise that resolves when the vectors and documents have been added.
47
- */
48
- addVectors(vectors: number[][], documents: Document[]): Promise<void>;
49
- /**
50
- * Method to add documents to the MongoDB collection. It first converts
51
- * the documents to vectors using the embeddings and then calls the
52
- * addVectors method.
53
- * @param documents Documents to be added.
54
- * @returns Promise that resolves when the documents have been added.
55
- */
56
- addDocuments(documents: Document[]): Promise<void>;
57
- /**
58
- * Method that performs a similarity search on the vectors stored in the
59
- * MongoDB collection. It returns a list of documents and their
60
- * corresponding similarity scores.
61
- * @param query Query vector for the similarity search.
62
- * @param k Number of nearest neighbors to return.
63
- * @param filter Optional filter to be applied.
64
- * @returns Promise that resolves to a list of documents and their corresponding similarity scores.
65
- */
66
- similaritySearchVectorWithScore(query: number[], k: number, filter?: MongoDBAtlasFilter): Promise<[Document, number][]>;
67
- /**
68
- * Return documents selected using the maximal marginal relevance.
69
- * Maximal marginal relevance optimizes for similarity to the query AND diversity
70
- * among selected documents.
71
- *
72
- * @param {string} query - Text to look up documents similar to.
73
- * @param {number} options.k - Number of documents to return.
74
- * @param {number} options.fetchK=20- Number of documents to fetch before passing to the MMR algorithm.
75
- * @param {number} options.lambda=0.5 - Number between 0 and 1 that determines the degree of diversity among the results,
76
- * where 0 corresponds to maximum diversity and 1 to minimum diversity.
77
- * @param {MongoDBAtlasFilter} options.filter - Optional Atlas Search operator to pre-filter on document fields
78
- * or post-filter following the knnBeta search.
79
- *
80
- * @returns {Promise<Document[]>} - List of documents selected by maximal marginal relevance.
81
- */
82
- maxMarginalRelevanceSearch(query: string, options: MaxMarginalRelevanceSearchOptions<this["FilterType"]>): Promise<Document[]>;
83
- /**
84
- * Static method to create an instance of MongoDBAtlasVectorSearch from a
85
- * list of texts. It first converts the texts to vectors and then adds
86
- * them to the MongoDB collection.
87
- * @param texts List of texts to be converted to vectors.
88
- * @param metadatas Metadata for the texts.
89
- * @param embeddings Embeddings to be used for conversion.
90
- * @param dbConfig Database configuration for MongoDB Atlas.
91
- * @returns Promise that resolves to a new instance of MongoDBAtlasVectorSearch.
92
- */
93
- static fromTexts(texts: string[], metadatas: object[] | object, embeddings: Embeddings, dbConfig: MongoDBAtlasVectorSearchLibArgs): Promise<MongoDBAtlasVectorSearch>;
94
- /**
95
- * Static method to create an instance of MongoDBAtlasVectorSearch from a
96
- * list of documents. It first converts the documents to vectors and then
97
- * adds them to the MongoDB collection.
98
- * @param docs List of documents to be converted to vectors.
99
- * @param embeddings Embeddings to be used for conversion.
100
- * @param dbConfig Database configuration for MongoDB Atlas.
101
- * @returns Promise that resolves to a new instance of MongoDBAtlasVectorSearch.
102
- */
103
- static fromDocuments(docs: Document[], embeddings: Embeddings, dbConfig: MongoDBAtlasVectorSearchLibArgs): Promise<MongoDBAtlasVectorSearch>;
104
- /**
105
- * Static method to fix the precision of the array that ensures that
106
- * every number in this array is always float when casted to other types.
107
- * This is needed since MongoDB Atlas Vector Search does not cast integer
108
- * inside vector search to float automatically.
109
- * This method shall introduce a hint of error but should be safe to use
110
- * since introduced error is very small, only applies to integer numbers
111
- * returned by embeddings, and most embeddings shall not have precision
112
- * as high as 15 decimal places.
113
- * @param array Array of number to be fixed.
114
- * @returns
115
- */
116
- static fixArrayPrecision(array: number[]): number[];
117
- }
118
- export {};
1
+ export * from "@langchain/community/vectorstores/mongodb_atlas";