@mastra/mcp-docs-server 1.1.7-alpha.0 → 1.1.8-alpha.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 (276) hide show
  1. package/.docs/docs/agents/agent-approval.md +61 -31
  2. package/.docs/docs/agents/supervisor-agents.md +1 -1
  3. package/.docs/docs/getting-started/manual-install.md +1 -1
  4. package/.docs/docs/index.md +68 -24
  5. package/.docs/docs/mastra-cloud/setup.md +1 -1
  6. package/.docs/docs/memory/observational-memory.md +9 -0
  7. package/.docs/docs/memory/semantic-recall.md +17 -1
  8. package/.docs/docs/workspace/skills.md +7 -5
  9. package/.docs/guides/deployment/aws-lambda.md +76 -165
  10. package/.docs/guides/deployment/azure-app-services.md +38 -61
  11. package/.docs/guides/deployment/cloudflare.md +1 -1
  12. package/.docs/guides/deployment/netlify.md +1 -1
  13. package/.docs/guides/deployment/vercel.md +1 -1
  14. package/.docs/models/gateways/netlify.md +5 -1
  15. package/.docs/models/index.md +1 -1
  16. package/.docs/models/providers/anthropic.md +9 -9
  17. package/.docs/models/providers/deepseek.md +1 -1
  18. package/.docs/models/providers/google.md +11 -11
  19. package/.docs/models/providers/openai.md +19 -19
  20. package/.docs/models/providers/opencode.md +33 -33
  21. package/.docs/models/providers/xai.md +3 -3
  22. package/.docs/reference/agents/agent.md +20 -20
  23. package/.docs/reference/agents/generate.md +200 -66
  24. package/.docs/reference/agents/generateLegacy.md +77 -35
  25. package/.docs/reference/agents/getDefaultGenerateOptions.md +4 -6
  26. package/.docs/reference/agents/getDefaultOptions.md +4 -6
  27. package/.docs/reference/agents/getDefaultStreamOptions.md +4 -6
  28. package/.docs/reference/agents/getDescription.md +1 -1
  29. package/.docs/reference/agents/getInstructions.md +4 -6
  30. package/.docs/reference/agents/getLLM.md +6 -8
  31. package/.docs/reference/agents/getMemory.md +4 -6
  32. package/.docs/reference/agents/getModel.md +4 -6
  33. package/.docs/reference/agents/getTools.md +5 -7
  34. package/.docs/reference/agents/getVoice.md +4 -6
  35. package/.docs/reference/agents/listAgents.md +4 -6
  36. package/.docs/reference/agents/listScorers.md +4 -6
  37. package/.docs/reference/agents/listTools.md +4 -6
  38. package/.docs/reference/agents/listWorkflows.md +4 -6
  39. package/.docs/reference/agents/network.md +69 -23
  40. package/.docs/reference/ai-sdk/chat-route.md +7 -7
  41. package/.docs/reference/ai-sdk/handle-chat-stream.md +12 -12
  42. package/.docs/reference/ai-sdk/handle-network-stream.md +4 -4
  43. package/.docs/reference/ai-sdk/handle-workflow-stream.md +11 -11
  44. package/.docs/reference/ai-sdk/network-route.md +3 -3
  45. package/.docs/reference/ai-sdk/to-ai-sdk-stream.md +9 -9
  46. package/.docs/reference/ai-sdk/to-ai-sdk-v4-messages.md +9 -9
  47. package/.docs/reference/ai-sdk/to-ai-sdk-v5-messages.md +5 -5
  48. package/.docs/reference/ai-sdk/with-mastra.md +12 -12
  49. package/.docs/reference/ai-sdk/workflow-route.md +3 -3
  50. package/.docs/reference/auth/auth0.md +6 -6
  51. package/.docs/reference/auth/better-auth.md +5 -5
  52. package/.docs/reference/auth/clerk.md +5 -5
  53. package/.docs/reference/auth/firebase.md +7 -7
  54. package/.docs/reference/auth/jwt.md +1 -1
  55. package/.docs/reference/auth/supabase.md +4 -4
  56. package/.docs/reference/auth/workos.md +6 -6
  57. package/.docs/reference/cli/create-mastra.md +14 -14
  58. package/.docs/reference/client-js/mastra-client.md +23 -23
  59. package/.docs/reference/client-js/workflows.md +3 -3
  60. package/.docs/reference/core/addGateway.md +2 -2
  61. package/.docs/reference/core/getAgent.md +2 -2
  62. package/.docs/reference/core/getAgentById.md +2 -2
  63. package/.docs/reference/core/getDeployer.md +1 -1
  64. package/.docs/reference/core/getGateway.md +2 -2
  65. package/.docs/reference/core/getGatewayById.md +2 -2
  66. package/.docs/reference/core/getLogger.md +1 -1
  67. package/.docs/reference/core/getMCPServer.md +2 -2
  68. package/.docs/reference/core/getMCPServerById.md +3 -3
  69. package/.docs/reference/core/getMemory.md +2 -2
  70. package/.docs/reference/core/getScorer.md +2 -2
  71. package/.docs/reference/core/getScorerById.md +2 -2
  72. package/.docs/reference/core/getServer.md +1 -1
  73. package/.docs/reference/core/getStorage.md +1 -1
  74. package/.docs/reference/core/getStoredAgentById.md +18 -20
  75. package/.docs/reference/core/getTelemetry.md +1 -1
  76. package/.docs/reference/core/getVector.md +2 -2
  77. package/.docs/reference/core/getWorkflow.md +3 -3
  78. package/.docs/reference/core/listAgents.md +1 -1
  79. package/.docs/reference/core/listGateways.md +1 -1
  80. package/.docs/reference/core/listLogs.md +9 -11
  81. package/.docs/reference/core/listLogsByRunId.md +9 -9
  82. package/.docs/reference/core/listMCPServers.md +1 -1
  83. package/.docs/reference/core/listMemory.md +1 -1
  84. package/.docs/reference/core/listScorers.md +1 -1
  85. package/.docs/reference/core/listStoredAgents.md +9 -11
  86. package/.docs/reference/core/listVectors.md +1 -1
  87. package/.docs/reference/core/listWorkflows.md +2 -2
  88. package/.docs/reference/core/mastra-class.md +17 -17
  89. package/.docs/reference/core/mastra-model-gateway.md +15 -15
  90. package/.docs/reference/core/setLogger.md +2 -4
  91. package/.docs/reference/core/setStorage.md +1 -1
  92. package/.docs/reference/datasets/addItem.md +20 -4
  93. package/.docs/reference/datasets/addItems.md +8 -2
  94. package/.docs/reference/datasets/compareExperiments.md +15 -3
  95. package/.docs/reference/datasets/create.md +6 -6
  96. package/.docs/reference/datasets/dataset.md +1 -1
  97. package/.docs/reference/datasets/delete.md +2 -2
  98. package/.docs/reference/datasets/deleteExperiment.md +2 -2
  99. package/.docs/reference/datasets/deleteItem.md +2 -2
  100. package/.docs/reference/datasets/deleteItems.md +2 -2
  101. package/.docs/reference/datasets/get.md +2 -2
  102. package/.docs/reference/datasets/getDetails.md +9 -9
  103. package/.docs/reference/datasets/getExperiment.md +2 -2
  104. package/.docs/reference/datasets/getItem.md +3 -3
  105. package/.docs/reference/datasets/getItemHistory.md +22 -2
  106. package/.docs/reference/datasets/list.md +7 -3
  107. package/.docs/reference/datasets/listExperimentResults.md +34 -4
  108. package/.docs/reference/datasets/listExperiments.md +41 -3
  109. package/.docs/reference/datasets/listItems.md +18 -6
  110. package/.docs/reference/datasets/listVersions.md +23 -3
  111. package/.docs/reference/datasets/startExperiment.md +62 -12
  112. package/.docs/reference/datasets/startExperimentAsync.md +5 -1
  113. package/.docs/reference/datasets/update.md +6 -6
  114. package/.docs/reference/datasets/updateItem.md +5 -5
  115. package/.docs/reference/deployer.md +8 -8
  116. package/.docs/reference/evals/answer-relevancy.md +11 -11
  117. package/.docs/reference/evals/answer-similarity.md +17 -19
  118. package/.docs/reference/evals/bias.md +10 -10
  119. package/.docs/reference/evals/completeness.md +3 -3
  120. package/.docs/reference/evals/content-similarity.md +6 -6
  121. package/.docs/reference/evals/context-precision.md +4 -4
  122. package/.docs/reference/evals/context-relevance.md +4 -4
  123. package/.docs/reference/evals/create-scorer.md +47 -49
  124. package/.docs/reference/evals/faithfulness.md +11 -11
  125. package/.docs/reference/evals/hallucination.md +17 -21
  126. package/.docs/reference/evals/keyword-coverage.md +4 -4
  127. package/.docs/reference/evals/mastra-scorer.md +14 -14
  128. package/.docs/reference/evals/noise-sensitivity.md +4 -4
  129. package/.docs/reference/evals/prompt-alignment.md +4 -4
  130. package/.docs/reference/evals/run-evals.md +16 -16
  131. package/.docs/reference/evals/scorer-utils.md +3 -3
  132. package/.docs/reference/evals/textual-difference.md +3 -3
  133. package/.docs/reference/evals/tone-consistency.md +3 -3
  134. package/.docs/reference/evals/tool-call-accuracy.md +5 -5
  135. package/.docs/reference/evals/toxicity.md +8 -8
  136. package/.docs/reference/harness/harness-class.md +34 -42
  137. package/.docs/reference/logging/pino-logger.md +5 -5
  138. package/.docs/reference/memory/clone-utilities.md +5 -5
  139. package/.docs/reference/memory/cloneThread.md +17 -21
  140. package/.docs/reference/memory/createThread.md +10 -10
  141. package/.docs/reference/memory/deleteMessages.md +2 -2
  142. package/.docs/reference/memory/getThreadById.md +2 -2
  143. package/.docs/reference/memory/listThreads.md +5 -5
  144. package/.docs/reference/memory/memory-class.md +12 -14
  145. package/.docs/reference/memory/observational-memory.md +102 -94
  146. package/.docs/reference/memory/recall.md +14 -16
  147. package/.docs/reference/observability/tracing/configuration.md +27 -10
  148. package/.docs/reference/observability/tracing/exporters/console-exporter.md +4 -7
  149. package/.docs/reference/processors/batch-parts-processor.md +8 -10
  150. package/.docs/reference/processors/language-detector.md +14 -16
  151. package/.docs/reference/processors/message-history-processor.md +7 -9
  152. package/.docs/reference/processors/moderation-processor.md +13 -15
  153. package/.docs/reference/processors/pii-detector.md +14 -16
  154. package/.docs/reference/processors/processor-interface.md +62 -62
  155. package/.docs/reference/processors/prompt-injection-detector.md +11 -13
  156. package/.docs/reference/processors/semantic-recall-processor.md +14 -16
  157. package/.docs/reference/processors/system-prompt-scrubber.md +12 -14
  158. package/.docs/reference/processors/token-limiter-processor.md +11 -13
  159. package/.docs/reference/processors/tool-call-filter.md +5 -7
  160. package/.docs/reference/processors/tool-search-processor.md +9 -11
  161. package/.docs/reference/processors/unicode-normalizer.md +8 -10
  162. package/.docs/reference/processors/working-memory-processor.md +14 -18
  163. package/.docs/reference/rag/chunk.md +38 -38
  164. package/.docs/reference/rag/database-config.md +11 -7
  165. package/.docs/reference/rag/document.md +2 -2
  166. package/.docs/reference/rag/embeddings.md +12 -12
  167. package/.docs/reference/rag/extract-params.md +23 -23
  168. package/.docs/reference/rag/graph-rag.md +12 -12
  169. package/.docs/reference/rag/rerank.md +25 -17
  170. package/.docs/reference/rag/rerankWithScorer.md +25 -17
  171. package/.docs/reference/server/create-route.md +14 -14
  172. package/.docs/reference/server/express-adapter.md +10 -10
  173. package/.docs/reference/server/fastify-adapter.md +10 -10
  174. package/.docs/reference/server/hono-adapter.md +10 -10
  175. package/.docs/reference/server/koa-adapter.md +10 -10
  176. package/.docs/reference/server/mastra-server.md +10 -10
  177. package/.docs/reference/server/register-api-route.md +13 -13
  178. package/.docs/reference/storage/cloudflare-d1.md +5 -5
  179. package/.docs/reference/storage/cloudflare.md +6 -6
  180. package/.docs/reference/storage/composite.md +9 -9
  181. package/.docs/reference/storage/convex.md +3 -3
  182. package/.docs/reference/storage/dynamodb.md +9 -9
  183. package/.docs/reference/storage/lance.md +3 -3
  184. package/.docs/reference/storage/libsql.md +2 -2
  185. package/.docs/reference/storage/mongodb.md +5 -5
  186. package/.docs/reference/storage/mssql.md +2 -2
  187. package/.docs/reference/storage/postgresql.md +25 -25
  188. package/.docs/reference/storage/upstash.md +3 -3
  189. package/.docs/reference/streaming/ChunkType.md +251 -59
  190. package/.docs/reference/streaming/agents/MastraModelOutput.md +86 -16
  191. package/.docs/reference/streaming/agents/stream.md +155 -43
  192. package/.docs/reference/streaming/agents/streamLegacy.md +79 -39
  193. package/.docs/reference/streaming/workflows/resumeStream.md +18 -8
  194. package/.docs/reference/streaming/workflows/stream.md +21 -9
  195. package/.docs/reference/streaming/workflows/timeTravelStream.md +4 -4
  196. package/.docs/reference/tools/create-tool.md +25 -21
  197. package/.docs/reference/tools/document-chunker-tool.md +7 -7
  198. package/.docs/reference/tools/graph-rag-tool.md +16 -18
  199. package/.docs/reference/tools/mcp-client.md +38 -27
  200. package/.docs/reference/tools/mcp-server.md +45 -45
  201. package/.docs/reference/tools/vector-query-tool.md +34 -22
  202. package/.docs/reference/vectors/astra.md +22 -22
  203. package/.docs/reference/vectors/chroma.md +44 -44
  204. package/.docs/reference/vectors/convex.md +26 -26
  205. package/.docs/reference/vectors/couchbase.md +30 -30
  206. package/.docs/reference/vectors/duckdb.md +29 -29
  207. package/.docs/reference/vectors/elasticsearch.md +27 -27
  208. package/.docs/reference/vectors/lance.md +46 -38
  209. package/.docs/reference/vectors/libsql.md +31 -31
  210. package/.docs/reference/vectors/mongodb.md +32 -32
  211. package/.docs/reference/vectors/opensearch.md +27 -27
  212. package/.docs/reference/vectors/pg.md +60 -44
  213. package/.docs/reference/vectors/pinecone.md +38 -38
  214. package/.docs/reference/vectors/qdrant.md +36 -36
  215. package/.docs/reference/vectors/s3vectors.md +24 -24
  216. package/.docs/reference/vectors/turbopuffer.md +29 -29
  217. package/.docs/reference/vectors/upstash.md +25 -25
  218. package/.docs/reference/vectors/vectorize.md +27 -27
  219. package/.docs/reference/voice/azure.md +19 -15
  220. package/.docs/reference/voice/cloudflare.md +10 -12
  221. package/.docs/reference/voice/composite-voice.md +10 -10
  222. package/.docs/reference/voice/deepgram.md +20 -14
  223. package/.docs/reference/voice/elevenlabs.md +20 -22
  224. package/.docs/reference/voice/google-gemini-live.md +42 -44
  225. package/.docs/reference/voice/google.md +25 -21
  226. package/.docs/reference/voice/mastra-voice.md +20 -20
  227. package/.docs/reference/voice/murf.md +24 -28
  228. package/.docs/reference/voice/openai-realtime.md +26 -26
  229. package/.docs/reference/voice/openai.md +14 -12
  230. package/.docs/reference/voice/playai.md +13 -15
  231. package/.docs/reference/voice/sarvam.md +21 -25
  232. package/.docs/reference/voice/speechify.md +11 -13
  233. package/.docs/reference/voice/voice.addInstructions.md +1 -1
  234. package/.docs/reference/voice/voice.addTools.md +1 -1
  235. package/.docs/reference/voice/voice.answer.md +1 -1
  236. package/.docs/reference/voice/voice.connect.md +3 -3
  237. package/.docs/reference/voice/voice.events.md +11 -11
  238. package/.docs/reference/voice/voice.getSpeakers.md +30 -30
  239. package/.docs/reference/voice/voice.listen.md +9 -9
  240. package/.docs/reference/voice/voice.off.md +2 -2
  241. package/.docs/reference/voice/voice.on.md +2 -2
  242. package/.docs/reference/voice/voice.send.md +1 -1
  243. package/.docs/reference/voice/voice.speak.md +11 -11
  244. package/.docs/reference/voice/voice.updateConfig.md +3 -3
  245. package/.docs/reference/workflows/run-methods/cancel.md +2 -2
  246. package/.docs/reference/workflows/run-methods/restart.md +17 -5
  247. package/.docs/reference/workflows/run-methods/resume.md +23 -9
  248. package/.docs/reference/workflows/run-methods/start.md +22 -8
  249. package/.docs/reference/workflows/run-methods/startAsync.md +12 -6
  250. package/.docs/reference/workflows/run-methods/timeTravel.md +29 -13
  251. package/.docs/reference/workflows/run.md +12 -12
  252. package/.docs/reference/workflows/step.md +24 -26
  253. package/.docs/reference/workflows/workflow-methods/branch.md +2 -2
  254. package/.docs/reference/workflows/workflow-methods/commit.md +1 -1
  255. package/.docs/reference/workflows/workflow-methods/create-run.md +4 -4
  256. package/.docs/reference/workflows/workflow-methods/dountil.md +3 -3
  257. package/.docs/reference/workflows/workflow-methods/dowhile.md +3 -3
  258. package/.docs/reference/workflows/workflow-methods/foreach.md +9 -9
  259. package/.docs/reference/workflows/workflow-methods/map.md +2 -2
  260. package/.docs/reference/workflows/workflow-methods/parallel.md +2 -2
  261. package/.docs/reference/workflows/workflow-methods/sleep.md +2 -2
  262. package/.docs/reference/workflows/workflow-methods/sleepUntil.md +2 -2
  263. package/.docs/reference/workflows/workflow-methods/then.md +2 -2
  264. package/.docs/reference/workflows/workflow.md +40 -50
  265. package/.docs/reference/workspace/daytona-sandbox.md +33 -33
  266. package/.docs/reference/workspace/e2b-sandbox.md +20 -20
  267. package/.docs/reference/workspace/filesystem.md +22 -22
  268. package/.docs/reference/workspace/gcs-filesystem.md +15 -15
  269. package/.docs/reference/workspace/local-filesystem.md +35 -35
  270. package/.docs/reference/workspace/local-sandbox.md +26 -26
  271. package/.docs/reference/workspace/s3-filesystem.md +18 -18
  272. package/.docs/reference/workspace/sandbox.md +8 -8
  273. package/.docs/reference/workspace/workspace-class.md +30 -34
  274. package/CHANGELOG.md +16 -0
  275. package/package.json +6 -6
  276. package/.docs/docs/getting-started/start.md +0 -28
@@ -6,9 +6,9 @@ The LanceVectorStore class provides vector search using [LanceDB](https://lanced
6
6
 
7
7
  The LanceVectorStore uses a factory pattern for creation. You should use the static `create()` method rather than the constructor directly.
8
8
 
9
- **uri:** (`string`): Path to LanceDB database or URI for cloud deployments
9
+ **uri** (`string`): Path to LanceDB database or URI for cloud deployments
10
10
 
11
- **options?:** (`ConnectionOptions`): Additional connection options for LanceDB
11
+ **options** (`ConnectionOptions`): Additional connection options for LanceDB
12
12
 
13
13
  ## Constructor Examples
14
14
 
@@ -33,59 +33,67 @@ const s3Store = await LanceVectorStore.create('s3://bucket/db', {
33
33
 
34
34
  ### createIndex()
35
35
 
36
- **tableName:** (`string`): Name of the table to create index in
36
+ **tableName** (`string`): Name of the table to create index in
37
37
 
38
- **indexName:** (`string`): Name of the index (column name) to create
38
+ **indexName** (`string`): Name of the index (column name) to create
39
39
 
40
- **dimension:** (`number`): Vector dimension (must match your embedding model)
40
+ **dimension** (`number`): Vector dimension (must match your embedding model)
41
41
 
42
- **metric?:** (`'cosine' | 'euclidean' | 'dotproduct'`): Distance metric for similarity search (Default: `cosine`)
42
+ **metric** (`'cosine' | 'euclidean' | 'dotproduct'`): Distance metric for similarity search (Default: `cosine`)
43
43
 
44
- **indexConfig?:** (`LanceIndexConfig`): Index configuration (Default: `{ type: 'hnsw' }`)
44
+ **indexConfig** (`LanceIndexConfig`): Index configuration (Default: `{ type: 'hnsw' }`)
45
45
 
46
46
  #### LanceIndexConfig
47
47
 
48
- **type:** (`'ivfflat' | 'hnsw'`): stringivfflat:ivfflatClusters vectors into lists for approximate search.hnsw:hnswGraph-based index offering fast search times and high recall. (Default: `hnsw`)
48
+ **type** (`'ivfflat' | 'hnsw'`): Index type (Default: `hnsw`)
49
49
 
50
- **numPartitions?:** (`number`): Number of partitions for IVF indexes (Default: `128`)
50
+ **type.ivfflat** (`ivfflat`): Clusters vectors into lists for approximate search.
51
51
 
52
- **numSubVectors?:** (`number`): Number of sub-vectors for product quantization (Default: `16`)
52
+ **type.hnsw** (`hnsw`): Graph-based index offering fast search times and high recall.
53
53
 
54
- **hnsw?:** (`HNSWConfig`): objectm?:numberMaximum number of connections per node (default: 16)efConstruction?:numberBuild-time complexity (default: 100)
54
+ **numPartitions** (`number`): Number of partitions for IVF indexes (Default: `128`)
55
+
56
+ **numSubVectors** (`number`): Number of sub-vectors for product quantization (Default: `16`)
57
+
58
+ **hnsw** (`HNSWConfig`): HNSW configuration
59
+
60
+ **hnsw\.m** (`number`): Maximum number of connections per node (default: 16)
61
+
62
+ **hnsw\.efConstruction** (`number`): Build-time complexity (default: 100)
55
63
 
56
64
  ### createTable()
57
65
 
58
- **tableName:** (`string`): Name of the table to create
66
+ **tableName** (`string`): Name of the table to create
59
67
 
60
- **data:** (`Record<string, unknown>[] | TableLike`): Initial data for the table
68
+ **data** (`Record<string, unknown>[] | TableLike`): Initial data for the table
61
69
 
62
- **options?:** (`Partial<CreateTableOptions>`): Additional table creation options
70
+ **options** (`Partial<CreateTableOptions>`): Additional table creation options
63
71
 
64
72
  ### upsert()
65
73
 
66
- **tableName:** (`string`): Name of the table to upsert vectors into
74
+ **tableName** (`string`): Name of the table to upsert vectors into
67
75
 
68
- **vectors:** (`number[][]`): Array of embedding vectors
76
+ **vectors** (`number[][]`): Array of embedding vectors
69
77
 
70
- **metadata?:** (`Record<string, any>[]`): Metadata for each vector
78
+ **metadata** (`Record<string, any>[]`): Metadata for each vector
71
79
 
72
- **ids?:** (`string[]`): Optional vector IDs (auto-generated if not provided)
80
+ **ids** (`string[]`): Optional vector IDs (auto-generated if not provided)
73
81
 
74
82
  ### query()
75
83
 
76
- **tableName:** (`string`): Name of the table to query
84
+ **tableName** (`string`): Name of the table to query
77
85
 
78
- **queryVector:** (`number[]`): Query vector
86
+ **queryVector** (`number[]`): Query vector
79
87
 
80
- **topK?:** (`number`): Number of results to return (Default: `10`)
88
+ **topK** (`number`): Number of results to return (Default: `10`)
81
89
 
82
- **filter?:** (`Record<string, any>`): Metadata filters
90
+ **filter** (`Record<string, any>`): Metadata filters
83
91
 
84
- **includeVector?:** (`boolean`): Whether to include the vector in the result (Default: `false`)
92
+ **includeVector** (`boolean`): Whether to include the vector in the result (Default: `false`)
85
93
 
86
- **columns?:** (`string[]`): Specific columns to include in the result (Default: `[]`)
94
+ **columns** (`string[]`): Specific columns to include in the result (Default: `[]`)
87
95
 
88
- **includeAllColumns?:** (`boolean`): Whether to include all columns in the result (Default: `false`)
96
+ **includeAllColumns** (`boolean`): Whether to include all columns in the result (Default: `false`)
89
97
 
90
98
  ### listTables()
91
99
 
@@ -98,13 +106,13 @@ const tables = await vectorStore.listTables()
98
106
 
99
107
  ### getTableSchema()
100
108
 
101
- **tableName:** (`string`): Name of the table to describe
109
+ **tableName** (`string`): Name of the table to describe
102
110
 
103
111
  Returns the schema of the specified table.
104
112
 
105
113
  ### deleteTable()
106
114
 
107
- **tableName:** (`string`): Name of the table to delete
115
+ **tableName** (`string`): Name of the table to delete
108
116
 
109
117
  ### deleteAllTables()
110
118
 
@@ -116,7 +124,7 @@ Returns an array of index names as strings.
116
124
 
117
125
  ### describeIndex()
118
126
 
119
- **indexName:** (`string`): Name of the index to describe
127
+ **indexName** (`string`): Name of the index to describe
120
128
 
121
129
  Returns information about the index:
122
130
 
@@ -137,35 +145,35 @@ interface IndexStats {
137
145
 
138
146
  ### deleteIndex()
139
147
 
140
- **indexName:** (`string`): Name of the index to delete
148
+ **indexName** (`string`): Name of the index to delete
141
149
 
142
150
  ### updateVector()
143
151
 
144
152
  Update a single vector by ID or by metadata filter. Either `id` or `filter` must be provided, but not both.
145
153
 
146
- **indexName:** (`string`): Name of the index containing the vector
154
+ **indexName** (`string`): Name of the index containing the vector
147
155
 
148
- **id?:** (`string`): ID of the vector to update (mutually exclusive with filter)
156
+ **id** (`string`): ID of the vector to update (mutually exclusive with filter)
149
157
 
150
- **filter?:** (`Record<string, any>`): Metadata filter to identify vector(s) to update (mutually exclusive with id)
158
+ **filter** (`Record<string, any>`): Metadata filter to identify vector(s) to update (mutually exclusive with id)
151
159
 
152
- **update:** (`{ vector?: number[]; metadata?: Record<string, any>; }`): Object containing the vector and/or metadata to update
160
+ **update** (`{ vector?: number[]; metadata?: Record<string, any>; }`): Object containing the vector and/or metadata to update
153
161
 
154
162
  ### deleteVector()
155
163
 
156
- **indexName:** (`string`): Name of the index containing the vector
164
+ **indexName** (`string`): Name of the index containing the vector
157
165
 
158
- **id:** (`string`): ID of the vector to delete
166
+ **id** (`string`): ID of the vector to delete
159
167
 
160
168
  ### deleteVectors()
161
169
 
162
170
  Delete multiple vectors by IDs or by metadata filter. Either `ids` or `filter` must be provided, but not both.
163
171
 
164
- **indexName:** (`string`): Name of the index containing the vectors to delete
172
+ **indexName** (`string`): Name of the index containing the vectors to delete
165
173
 
166
- **ids?:** (`string[]`): Array of vector IDs to delete (mutually exclusive with filter)
174
+ **ids** (`string[]`): Array of vector IDs to delete (mutually exclusive with filter)
167
175
 
168
- **filter?:** (`Record<string, any>`): Metadata filter to identify vectors to delete (mutually exclusive with ids)
176
+ **filter** (`Record<string, any>`): Metadata filter to identify vectors to delete (mutually exclusive with ids)
169
177
 
170
178
  ### close()
171
179
 
@@ -71,13 +71,13 @@ const results = await store.query({
71
71
 
72
72
  ## Constructor Options
73
73
 
74
- **url:** (`string`): libSQL database URL. Use ':memory:' for in-memory database, 'file:dbname.db' for local file, or a libSQL-compatible connection string like 'libsql://your-database.turso.io'.
74
+ **url** (`string`): libSQL database URL. Use ':memory:' for in-memory database, 'file:dbname.db' for local file, or a libSQL-compatible connection string like 'libsql://your-database.turso.io'.
75
75
 
76
- **authToken?:** (`string`): Authentication token for Turso cloud databases
76
+ **authToken** (`string`): Authentication token for Turso cloud databases
77
77
 
78
- **syncUrl?:** (`string`): URL for database replication (Turso specific)
78
+ **syncUrl** (`string`): URL for database replication (Turso specific)
79
79
 
80
- **syncInterval?:** (`number`): Interval in milliseconds for database sync (Turso specific)
80
+ **syncInterval** (`number`): Interval in milliseconds for database sync (Turso specific)
81
81
 
82
82
  ## Methods
83
83
 
@@ -85,45 +85,45 @@ const results = await store.query({
85
85
 
86
86
  Creates a new vector collection. The index name must start with a letter or underscore and can only contain letters, numbers, and underscores. The dimension must be a positive integer.
87
87
 
88
- **indexName:** (`string`): Name of the index to create
88
+ **indexName** (`string`): Name of the index to create
89
89
 
90
- **dimension:** (`number`): Vector dimension size (must match your embedding model)
90
+ **dimension** (`number`): Vector dimension size (must match your embedding model)
91
91
 
92
- **metric?:** (`'cosine' | 'euclidean' | 'dotproduct'`): Distance metric for similarity search. Note: Currently only cosine similarity is supported by libSQL. (Default: `cosine`)
92
+ **metric** (`'cosine' | 'euclidean' | 'dotproduct'`): Distance metric for similarity search. Note: Currently only cosine similarity is supported by libSQL. (Default: `cosine`)
93
93
 
94
94
  ### upsert()
95
95
 
96
96
  Adds or updates vectors and their metadata in the index. Uses a transaction to ensure all vectors are inserted atomically - if any insert fails, the entire operation is rolled back.
97
97
 
98
- **indexName:** (`string`): Name of the index to insert into
98
+ **indexName** (`string`): Name of the index to insert into
99
99
 
100
- **vectors:** (`number[][]`): Array of embedding vectors
100
+ **vectors** (`number[][]`): Array of embedding vectors
101
101
 
102
- **metadata?:** (`Record<string, any>[]`): Metadata for each vector
102
+ **metadata** (`Record<string, any>[]`): Metadata for each vector
103
103
 
104
- **ids?:** (`string[]`): Optional vector IDs (auto-generated if not provided)
104
+ **ids** (`string[]`): Optional vector IDs (auto-generated if not provided)
105
105
 
106
106
  ### query()
107
107
 
108
108
  Searches for similar vectors with optional metadata filtering.
109
109
 
110
- **indexName:** (`string`): Name of the index to search in
110
+ **indexName** (`string`): Name of the index to search in
111
111
 
112
- **queryVector:** (`number[]`): Query vector to find similar vectors for
112
+ **queryVector** (`number[]`): Query vector to find similar vectors for
113
113
 
114
- **topK?:** (`number`): Number of results to return (Default: `10`)
114
+ **topK** (`number`): Number of results to return (Default: `10`)
115
115
 
116
- **filter?:** (`Filter`): Metadata filters
116
+ **filter** (`Filter`): Metadata filters
117
117
 
118
- **includeVector?:** (`boolean`): Whether to include vector data in results (Default: `false`)
118
+ **includeVector** (`boolean`): Whether to include vector data in results (Default: `false`)
119
119
 
120
- **minScore?:** (`number`): Minimum similarity score threshold (Default: `0`)
120
+ **minScore** (`number`): Minimum similarity score threshold (Default: `0`)
121
121
 
122
122
  ### describeIndex()
123
123
 
124
124
  Gets information about an index.
125
125
 
126
- **indexName:** (`string`): Name of the index to describe
126
+ **indexName** (`string`): Name of the index to describe
127
127
 
128
128
  Returns:
129
129
 
@@ -139,7 +139,7 @@ interface IndexStats {
139
139
 
140
140
  Deletes an index and all its data.
141
141
 
142
- **indexName:** (`string`): Name of the index to delete
142
+ **indexName** (`string`): Name of the index to delete
143
143
 
144
144
  ### listIndexes()
145
145
 
@@ -151,41 +151,41 @@ Returns: `Promise<string[]>`
151
151
 
152
152
  Removes all vectors from an index while keeping the index structure.
153
153
 
154
- **indexName:** (`string`): Name of the index to truncate
154
+ **indexName** (`string`): Name of the index to truncate
155
155
 
156
156
  ### updateVector()
157
157
 
158
158
  Update a single vector by ID or by metadata filter. Either `id` or `filter` must be provided, but not both.
159
159
 
160
- **indexName:** (`string`): Name of the index containing the vector
160
+ **indexName** (`string`): Name of the index containing the vector
161
161
 
162
- **id?:** (`string`): ID of the vector entry to update (mutually exclusive with filter)
162
+ **id** (`string`): ID of the vector entry to update (mutually exclusive with filter)
163
163
 
164
- **filter?:** (`Record<string, any>`): Metadata filter to identify vector(s) to update (mutually exclusive with id)
164
+ **filter** (`Record<string, any>`): Metadata filter to identify vector(s) to update (mutually exclusive with id)
165
165
 
166
- **update:** (`object`): Update data containing vector and/or metadata
166
+ **update** (`object`): Update data containing vector and/or metadata
167
167
 
168
- **update.vector?:** (`number[]`): New vector data to update
168
+ **update.vector** (`number[]`): New vector data to update
169
169
 
170
- **update.metadata?:** (`Record<string, any>`): New metadata to update
170
+ **update.metadata** (`Record<string, any>`): New metadata to update
171
171
 
172
172
  ### deleteVector()
173
173
 
174
174
  Deletes a specific vector entry from an index by its ID.
175
175
 
176
- **indexName:** (`string`): Name of the index containing the vector
176
+ **indexName** (`string`): Name of the index containing the vector
177
177
 
178
- **id:** (`string`): ID of the vector entry to delete
178
+ **id** (`string`): ID of the vector entry to delete
179
179
 
180
180
  ### deleteVectors()
181
181
 
182
182
  Delete multiple vectors by IDs or by metadata filter. Either `ids` or `filter` must be provided, but not both.
183
183
 
184
- **indexName:** (`string`): Name of the index containing the vectors to delete
184
+ **indexName** (`string`): Name of the index containing the vectors to delete
185
185
 
186
- **ids?:** (`string[]`): Array of vector IDs to delete (mutually exclusive with filter)
186
+ **ids** (`string[]`): Array of vector IDs to delete (mutually exclusive with filter)
187
187
 
188
- **filter?:** (`Record<string, any>`): Metadata filter to identify vectors to delete (mutually exclusive with ids)
188
+ **filter** (`Record<string, any>`): Metadata filter to identify vectors to delete (mutually exclusive with ids)
189
189
 
190
190
  ## Response Types
191
191
 
@@ -57,15 +57,15 @@ const store = new MongoDBVector({
57
57
 
58
58
  ## Constructor Options
59
59
 
60
- **id:** (`string`): Unique identifier for this vector store instance
60
+ **id** (`string`): Unique identifier for this vector store instance
61
61
 
62
- **uri:** (`string`): MongoDB connection string
62
+ **uri** (`string`): MongoDB connection string
63
63
 
64
- **dbName:** (`string`): Name of the MongoDB database to use
64
+ **dbName** (`string`): Name of the MongoDB database to use
65
65
 
66
- **options?:** (`MongoClientOptions`): Optional MongoDB client options
66
+ **options** (`MongoClientOptions`): Optional MongoDB client options
67
67
 
68
- **embeddingFieldPath?:** (`string`): Path to the field that stores vector embeddings. Supports nested paths using dot notation (e.g., 'text.contentEmbedding'). (Default: `embedding`)
68
+ **embeddingFieldPath** (`string`): Path to the field that stores vector embeddings. Supports nested paths using dot notation (e.g., 'text.contentEmbedding'). (Default: `embedding`)
69
69
 
70
70
  ## Methods
71
71
 
@@ -73,47 +73,47 @@ const store = new MongoDBVector({
73
73
 
74
74
  Creates a new vector index (collection) in MongoDB.
75
75
 
76
- **indexName:** (`string`): Name of the collection to create
76
+ **indexName** (`string`): Name of the collection to create
77
77
 
78
- **dimension:** (`number`): Vector dimension (must match your embedding model)
78
+ **dimension** (`number`): Vector dimension (must match your embedding model)
79
79
 
80
- **metric?:** (`'cosine' | 'euclidean' | 'dotproduct'`): Distance metric for similarity search (Default: `cosine`)
80
+ **metric** (`'cosine' | 'euclidean' | 'dotproduct'`): Distance metric for similarity search (Default: `cosine`)
81
81
 
82
82
  ### upsert()
83
83
 
84
84
  Adds or updates vectors and their metadata in the collection.
85
85
 
86
- **indexName:** (`string`): Name of the collection to insert into
86
+ **indexName** (`string`): Name of the collection to insert into
87
87
 
88
- **vectors:** (`number[][]`): Array of embedding vectors
88
+ **vectors** (`number[][]`): Array of embedding vectors
89
89
 
90
- **metadata?:** (`Record<string, any>[]`): Metadata for each vector
90
+ **metadata** (`Record<string, any>[]`): Metadata for each vector
91
91
 
92
- **ids?:** (`string[]`): Optional vector IDs (auto-generated if not provided)
92
+ **ids** (`string[]`): Optional vector IDs (auto-generated if not provided)
93
93
 
94
94
  ### query()
95
95
 
96
96
  Searches for similar vectors with optional metadata filtering.
97
97
 
98
- **indexName:** (`string`): Name of the collection to search in
98
+ **indexName** (`string`): Name of the collection to search in
99
99
 
100
- **queryVector:** (`number[]`): Query vector to find similar vectors for
100
+ **queryVector** (`number[]`): Query vector to find similar vectors for
101
101
 
102
- **topK?:** (`number`): Number of results to return (Default: `10`)
102
+ **topK** (`number`): Number of results to return (Default: `10`)
103
103
 
104
- **filter?:** (`Record<string, any>`): Metadata filters (applies to the \`metadata\` field)
104
+ **filter** (`Record<string, any>`): Metadata filters (applies to the \`metadata\` field)
105
105
 
106
- **documentFilter?:** (`Record<string, any>`): Filters on original document fields (not just metadata)
106
+ **documentFilter** (`Record<string, any>`): Filters on original document fields (not just metadata)
107
107
 
108
- **includeVector?:** (`boolean`): Whether to include vector data in results (Default: `false`)
108
+ **includeVector** (`boolean`): Whether to include vector data in results (Default: `false`)
109
109
 
110
- **minScore?:** (`number`): Minimum similarity score threshold (Default: `0`)
110
+ **minScore** (`number`): Minimum similarity score threshold (Default: `0`)
111
111
 
112
112
  ### describeIndex()
113
113
 
114
114
  Returns information about the index (collection).
115
115
 
116
- **indexName:** (`string`): Name of the collection to describe
116
+ **indexName** (`string`): Name of the collection to describe
117
117
 
118
118
  Returns:
119
119
 
@@ -129,7 +129,7 @@ interface IndexStats {
129
129
 
130
130
  Deletes a collection and all its data.
131
131
 
132
- **indexName:** (`string`): Name of the collection to delete
132
+ **indexName** (`string`): Name of the collection to delete
133
133
 
134
134
  ### listIndexes()
135
135
 
@@ -141,35 +141,35 @@ Returns: `Promise<string[]>`
141
141
 
142
142
  Update a single vector by ID or by metadata filter. Either `id` or `filter` must be provided, but not both.
143
143
 
144
- **indexName:** (`string`): Name of the collection containing the vector
144
+ **indexName** (`string`): Name of the collection containing the vector
145
145
 
146
- **id?:** (`string`): ID of the vector entry to update (mutually exclusive with filter)
146
+ **id** (`string`): ID of the vector entry to update (mutually exclusive with filter)
147
147
 
148
- **filter?:** (`Record<string, any>`): Metadata filter to identify vector(s) to update (mutually exclusive with id)
148
+ **filter** (`Record<string, any>`): Metadata filter to identify vector(s) to update (mutually exclusive with id)
149
149
 
150
- **update:** (`object`): Update data containing vector and/or metadata
150
+ **update** (`object`): Update data containing vector and/or metadata
151
151
 
152
- **update.vector?:** (`number[]`): New vector data to update
152
+ **update.vector** (`number[]`): New vector data to update
153
153
 
154
- **update.metadata?:** (`Record<string, any>`): New metadata to update
154
+ **update.metadata** (`Record<string, any>`): New metadata to update
155
155
 
156
156
  ### deleteVector()
157
157
 
158
158
  Deletes a specific vector entry from an index by its ID.
159
159
 
160
- **indexName:** (`string`): Name of the collection containing the vector
160
+ **indexName** (`string`): Name of the collection containing the vector
161
161
 
162
- **id:** (`string`): ID of the vector entry to delete
162
+ **id** (`string`): ID of the vector entry to delete
163
163
 
164
164
  ### deleteVectors()
165
165
 
166
166
  Delete multiple vectors by IDs or by metadata filter. Either `ids` or `filter` must be provided, but not both.
167
167
 
168
- **indexName:** (`string`): Name of the collection containing the vectors to delete
168
+ **indexName** (`string`): Name of the collection containing the vectors to delete
169
169
 
170
- **ids?:** (`string[]`): Array of vector IDs to delete (mutually exclusive with filter)
170
+ **ids** (`string[]`): Array of vector IDs to delete (mutually exclusive with filter)
171
171
 
172
- **filter?:** (`Record<string, any>`): Metadata filter to identify vectors to delete (mutually exclusive with ids)
172
+ **filter** (`Record<string, any>`): Metadata filter to identify vectors to delete (mutually exclusive with ids)
173
173
 
174
174
  ### disconnect()
175
175
 
@@ -6,15 +6,15 @@ The OpenSearchVector class provides vector search using [OpenSearch](https://ope
6
6
 
7
7
  The constructor accepts all [OpenSearch ClientOptions](https://opensearch.org/docs/latest/clients/javascript/index/) plus a required `id` field.
8
8
 
9
- **id:** (`string`): Unique identifier for this vector store instance
9
+ **id** (`string`): Unique identifier for this vector store instance
10
10
 
11
- **node:** (`string | string[] | NodeOptions | NodeOptions[]`): OpenSearch node URL(s) (e.g., 'http\://localhost:9200')
11
+ **node** (`string | string[] | NodeOptions | NodeOptions[]`): OpenSearch node URL(s) (e.g., 'http\://localhost:9200')
12
12
 
13
- **auth?:** (`BasicAuth | BearerAuth | AwsSigv4Auth`): Authentication configuration
13
+ **auth** (`BasicAuth | BearerAuth | AwsSigv4Auth`): Authentication configuration
14
14
 
15
- **ssl?:** (`ConnectionOptions`): SSL/TLS configuration
15
+ **ssl** (`ConnectionOptions`): SSL/TLS configuration
16
16
 
17
- **compression?:** (`'gzip'`): Enable gzip compression
17
+ **compression** (`'gzip'`): Enable gzip compression
18
18
 
19
19
  ## Methods
20
20
 
@@ -22,11 +22,11 @@ The constructor accepts all [OpenSearch ClientOptions](https://opensearch.org/do
22
22
 
23
23
  Creates a new index with the specified configuration.
24
24
 
25
- **indexName:** (`string`): The name of the index to create
25
+ **indexName** (`string`): The name of the index to create
26
26
 
27
- **dimension:** (`number`): The dimension of the vectors to be stored in the index
27
+ **dimension** (`number`): The dimension of the vectors to be stored in the index
28
28
 
29
- **metric?:** (`'cosine' | 'euclidean' | 'dotproduct'`): The distance metric to use for vector similarity (Default: `'cosine'`)
29
+ **metric** (`'cosine' | 'euclidean' | 'dotproduct'`): The distance metric to use for vector similarity (Default: `'cosine'`)
30
30
 
31
31
  ### listIndexes()
32
32
 
@@ -38,61 +38,61 @@ Returns: `Promise<string[]>`
38
38
 
39
39
  Gets information about an index.
40
40
 
41
- **indexName:** (`string`): The name of the index to describe
41
+ **indexName** (`string`): The name of the index to describe
42
42
 
43
43
  ### deleteIndex()
44
44
 
45
- **indexName:** (`string`): The name of the index to delete
45
+ **indexName** (`string`): The name of the index to delete
46
46
 
47
47
  ### upsert()
48
48
 
49
- **indexName:** (`string`): The name of the index to upsert vectors into
49
+ **indexName** (`string`): The name of the index to upsert vectors into
50
50
 
51
- **vectors:** (`number[][]`): Array of vector embeddings to insert
51
+ **vectors** (`number[][]`): Array of vector embeddings to insert
52
52
 
53
- **metadata?:** (`Record<string, any>[]`): Array of metadata objects corresponding to each vector
53
+ **metadata** (`Record<string, any>[]`): Array of metadata objects corresponding to each vector
54
54
 
55
- **ids?:** (`string[]`): Optional array of IDs for the vectors. If not provided, random IDs will be generated
55
+ **ids** (`string[]`): Optional array of IDs for the vectors. If not provided, random IDs will be generated
56
56
 
57
57
  ### query()
58
58
 
59
- **indexName:** (`string`): The name of the index to query
59
+ **indexName** (`string`): The name of the index to query
60
60
 
61
- **queryVector:** (`number[]`): The query vector to find similar vectors for
61
+ **queryVector** (`number[]`): The query vector to find similar vectors for
62
62
 
63
- **topK?:** (`number`): The number of results to return (Default: `10`)
63
+ **topK** (`number`): The number of results to return (Default: `10`)
64
64
 
65
- **filter?:** (`VectorFilter`): Optional filter to apply to the query (MongoDB-style query syntax)
65
+ **filter** (`VectorFilter`): Optional filter to apply to the query (MongoDB-style query syntax)
66
66
 
67
67
  ### updateVector()
68
68
 
69
69
  Update a single vector by ID or by metadata filter. Either `id` or `filter` must be provided, but not both.
70
70
 
71
- **indexName:** (`string`): The name of the index to update vectors in
71
+ **indexName** (`string`): The name of the index to update vectors in
72
72
 
73
- **id?:** (`string`): The ID of the vector to update (mutually exclusive with filter)
73
+ **id** (`string`): The ID of the vector to update (mutually exclusive with filter)
74
74
 
75
- **filter?:** (`Record<string, any>`): Metadata filter to identify vector(s) to update (mutually exclusive with id)
75
+ **filter** (`Record<string, any>`): Metadata filter to identify vector(s) to update (mutually exclusive with id)
76
76
 
77
- **update:** (`{ vector?: number[]; metadata?: Record<string, any>; }`): Object containing the vector and/or metadata to update
77
+ **update** (`{ vector?: number[]; metadata?: Record<string, any>; }`): Object containing the vector and/or metadata to update
78
78
 
79
79
  ### deleteVector()
80
80
 
81
81
  Deletes a single vector by its ID from the index.
82
82
 
83
- **indexName:** (`string`): The name of the index to delete the vector from
83
+ **indexName** (`string`): The name of the index to delete the vector from
84
84
 
85
- **id:** (`string`): The ID of the vector to delete
85
+ **id** (`string`): The ID of the vector to delete
86
86
 
87
87
  ### deleteVectors()
88
88
 
89
89
  Delete multiple vectors by IDs or by metadata filter. Either `ids` or `filter` must be provided, but not both.
90
90
 
91
- **indexName:** (`string`): Name of the index containing the vectors to delete
91
+ **indexName** (`string`): Name of the index containing the vectors to delete
92
92
 
93
- **ids?:** (`string[]`): Array of vector IDs to delete (mutually exclusive with filter)
93
+ **ids** (`string[]`): Array of vector IDs to delete (mutually exclusive with filter)
94
94
 
95
- **filter?:** (`Record<string, any>`): Metadata filter to identify vectors to delete (mutually exclusive with ids)
95
+ **filter** (`Record<string, any>`): Metadata filter to identify vectors to delete (mutually exclusive with ids)
96
96
 
97
97
  ## Related
98
98