docs: sync Core Integrations API reference (opensearch) on Docusaurus

[HaystackBot]

This PR syncs the Core Integrations API reference (opensearch) on Docusaurus. Just approve and merge it.

[vercel]

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Review	Updated (UTC)
haystack-docs	Ready	Preview, Comment	Jan 16, 2026 11:59am

[anakin87]

12:08:17.464 Running build in Washington, D.C., USA (East) – iad1
12:08:17.465 Build machine configuration: 4 cores, 8 GB
12:08:17.573 Cloning github.com/deepset-ai/haystack (Branch: sync-docusaurus-api-reference-opensearch, Commit: dcdd215)
12:08:18.802 Cloning completed: 1.229s
12:08:19.194 Restored build cache from previous deployment (JCmkfynhFbuNCzZgWkN3QTyqZAGt)
12:08:19.365 Running "git diff HEAD^ HEAD --quiet -- ."
12:08:20.277 Warning: Due to "engines": { "node": ">=18.0" } in your package.json file, the Node.js Version defined in your Project Settings ("22.x") will not apply, Node.js Version "24.x" will be used instead. Learn More: https://vercel.link/node-version
12:08:20.277 Warning: Detected "engines": { "node": ">=18.0" } in your package.json that will automatically upgrade when a new major Node.js Version is released. Learn More: https://vercel.link/node-version
12:08:20.277 Running "vercel build"
12:08:21.121 Vercel CLI 50.4.3
12:08:21.947 Warning: Due to "engines": { "node": ">=18.0" } in your package.json file, the Node.js Version defined in your Project Settings ("22.x") will not apply, Node.js Version "24.x" will be used instead. Learn More: https://vercel.link/node-version
12:08:21.947 Warning: Detected "engines": { "node": ">=18.0" } in your package.json that will automatically upgrade when a new major Node.js Version is released. Learn More: https://vercel.link/node-version
12:08:21.951 Installing dependencies...
12:08:29.606
12:08:29.606 up to date in 7s
12:08:29.606
12:08:29.607 432 packages are looking for funding
12:08:29.607 run npm fund for details
12:08:29.660 Running "npm run build"
12:08:29.762
12:08:29.762 > my-website@0.0.0 build
12:08:29.762 > docusaurus build
12:08:29.762
12:08:31.209 [INFO] [en] Creating an optimized production build...
12:08:31.737 Generated: /vercel/path1/static/llms.txt (production mode)
12:09:33.055 [ERROR] Client bundle compiled with errors therefore further build is impossible.
12:09:33.055 ╰─▶ × Error: MDX compilation failed for file "/vercel/path1/reference/integrations-api/opensearch.md"
12:09:33.056 │ Cause: Could not parse expression with acorn
12:09:33.056 │ Details:
12:09:33.056 │ {
12:09:33.056 │ "cause": {
12:09:33.056 │ "pos": 46955,
12:09:33.056 │ "loc": {
12:09:33.056 │ "line": 1238,
12:09:33.056 │ "column": 17
12:09:33.056 │ }
12:09:33.056 │ },
12:09:33.056 │ "column": 18,
12:09:33.056 │ "file": "",
12:09:33.056 │ "message": "Could not parse expression with acorn",
12:09:33.056 │ "line": 1238,
12:09:33.057 │ "name": "1238:18",
12:09:33.057 │ "place": {
12:09:33.057 │ "line": 1238,
12:09:33.057 │ "column": 18,
12:09:33.057 │ "offset": 46955
12:09:33.057 │ },
12:09:33.057 │ "reason": "Could not parse expression with acorn",
12:09:33.057 │ "ruleId": "acorn",
12:09:33.057 │ "source": "micromark-extension-mdx-expression",
12:09:33.057 │ "url": "https://github.com/micromark/micromark-extension-mdx-expression/tree/main/packages/micromark-extension-mdx-expression#could-not-parse-expression-with-acorn"
12:09:33.057 │ }
12:09:33.057 │
12:09:33.057 │ at compileToJSX (/vercel/path1/node_modules/@docusaurus/mdx-loader/lib/utils.js:93:15)
12:09:33.057 │ at async loadMDX (/vercel/path1/node_modules/@docusaurus/mdx-loader/lib/loader.js:22:20)
12:09:33.057 │ at async Object.mdxLoader (/vercel/path1/node_modules/@docusaurus/mdx-loader/lib/loader.js:157:24)
12:09:33.058
12:09:33.058 --------------------------
12:09:33.058
12:09:33.058 ╰─▶ × Error: MDX compilation failed for file "/vercel/path1/reference_versioned_docs/version-2.18/integrations-api/opensearch.md"
12:09:33.058 │ Cause: Could not parse expression with acorn
12:09:33.058 │ Details:
12:09:33.058 │ {
12:09:33.058 │ "cause": {
12:09:33.058 │ "pos": 46955,
12:09:33.058 │ "loc": {
12:09:33.058 │ "line": 1238,
12:09:33.058 │ "column": 17
12:09:33.058 │ }
12:09:33.058 │ },
12:09:33.058 │ "column": 18,
12:09:33.058 │ "file": "",
12:09:33.058 │ "message": "Could not parse expression with acorn",
12:09:33.059 │ "line": 1238,
12:09:33.059 │ "name": "1238:18",
12:09:33.059 │ "place": {
12:09:33.059 │ "line": 1238,
12:09:33.059 │ "column": 18,
12:09:33.059 │ "offset": 46955
12:09:33.059 │ },
12:09:33.059 │ "reason": "Could not parse expression with acorn",
12:09:33.059 │ "ruleId": "acorn",
12:09:33.059 │ "source": "micromark-extension-mdx-expression",
12:09:33.059 │ "url": "https://github.com/micromark/micromark-extension-mdx-expression/tree/main/packages/micromark-extension-mdx-expression#could-not-parse-expression-with-acorn"
12:09:33.059 │ }
12:09:33.059 │
12:09:33.059 │ at compileToJSX (/vercel/path1/node_modules/@docusaurus/mdx-loader/lib/utils.js:93:15)
12:09:33.059 │ at async loadMDX (/vercel/path1/node_modules/@docusaurus/mdx-loader/lib/loader.js:22:20)
12:09:33.060 │ at async Object.mdxLoader (/vercel/path1/node_modules/@docusaurus/mdx-loader/lib/loader.js:157:24)
12:09:33.060
12:09:33.060 --------------------------
12:09:33.060
12:09:33.060 ╰─▶ × Error: MDX compilation failed for file "/vercel/path1/reference_versioned_docs/version-2.19/integrations-api/opensearch.md"
12:09:33.060 │ Cause: Could not parse expression with acorn
12:09:33.060 │ Details:
12:09:33.060 │ {
12:09:33.060 │ "cause": {
12:09:33.060 │ "pos": 46955,
12:09:33.060 │ "loc": {
12:09:33.060 │ "line": 1238,
12:09:33.060 │ "column": 17
12:09:33.060 │ }
12:09:33.061 │ },
12:09:33.061 │ "column": 18,
12:09:33.061 │ "file": "",
12:09:33.061 │ "message": "Could not parse expression with acorn",
12:09:33.061 │ "line": 1238,
12:09:33.061 │ "name": "1238:18",
12:09:33.061 │ "place": {
12:09:33.061 │ "line": 1238,
12:09:33.061 │ "column": 18,
12:09:33.061 │ "offset": 46955
12:09:33.061 │ },
12:09:33.061 │ "reason": "Could not parse expression with acorn",
12:09:33.061 │ "ruleId": "acorn",
12:09:33.061 │ "source": "micromark-extension-mdx-expression",
12:09:33.061 │ "url": "https://github.com/micromark/micromark-extension-mdx-expression/tree/main/packages/micromark-extension-mdx-expression#could-not-parse-expression-with-acorn"
12:09:33.062 │ }
12:09:33.062 │
12:09:33.063 │ at compileToJSX (/vercel/path1/node_modules/@docusaurus/mdx-loader/lib/utils.js:93:15)
12:09:33.063 │ at async loadMDX (/vercel/path1/node_modules/@docusaurus/mdx-loader/lib/loader.js:22:20)
12:09:33.063 │ at async Object.mdxLoader (/vercel/path1/node_modules/@docusaurus/mdx-loader/lib/loader.js:157:24)
12:09:33.063
12:09:33.063 --------------------------
12:09:33.063
12:09:33.063 ╰─▶ × Error: MDX compilation failed for file "/vercel/path1/reference_versioned_docs/version-2.20/integrations-api/opensearch.md"
12:09:33.063 │ Cause: Could not parse expression with acorn
12:09:33.063 │ Details:
12:09:33.063 │ {
12:09:33.063 │ "cause": {
12:09:33.063 │ "pos": 46955,
12:09:33.063 │ "loc": {
12:09:33.063 │ "line": 1238,
12:09:33.063 │ "column": 17
12:09:33.064 │ }
12:09:33.064 │ },
12:09:33.064 │ "column": 18,
12:09:33.064 │ "file": "",
12:09:33.064 │ "message": "Could not parse expression with acorn",
12:09:33.064 │ "line": 1238,
12:09:33.064 │ "name": "1238:18",
12:09:33.064 │ "place": {
12:09:33.064 │ "line": 1238,
12:09:33.064 │ "column": 18,
12:09:33.064 │ "offset": 46955
12:09:33.064 │ },
12:09:33.064 │ "reason": "Could not parse expression with acorn",
12:09:33.064 │ "ruleId": "acorn",
12:09:33.065 │ "source": "micromark-extension-mdx-expression",
12:09:33.066 │ "url": "https://github.com/micromark/micromark-extension-mdx-expression/tree/main/packages/micromark-extension-mdx-expression#could-not-parse-expression-with-acorn"
12:09:33.066 │ }
12:09:33.066 │
12:09:33.066 │ at compileToJSX (/vercel/path1/node_modules/@docusaurus/mdx-loader/lib/utils.js:93:15)
12:09:33.066 │ at async loadMDX (/vercel/path1/node_modules/@docusaurus/mdx-loader/lib/loader.js:22:20)
12:09:33.066 │ at async Object.mdxLoader (/vercel/path1/node_modules/@docusaurus/mdx-loader/lib/loader.js:157:24)
12:09:33.066
12:09:33.066 --------------------------
12:09:33.066
12:09:33.066 ╰─▶ × Error: MDX compilation failed for file "/vercel/path1/reference_versioned_docs/version-2.21/integrations-api/opensearch.md"
12:09:33.067 │ Cause: Could not parse expression with acorn
12:09:33.067 │ Details:
12:09:33.067 │ {
12:09:33.067 │ "cause": {
12:09:33.067 │ "pos": 46955,
12:09:33.067 │ "loc": {
12:09:33.067 │ "line": 1238,
12:09:33.067 │ "column": 17
12:09:33.067 │ }
12:09:33.067 │ },
12:09:33.067 │ "column": 18,
12:09:33.067 │ "file": "",
12:09:33.067 │ "message": "Could not parse expression with acorn",
12:09:33.067 │ "line": 1238,
12:09:33.067 │ "name": "1238:18",
12:09:33.067 │ "place": {
12:09:33.067 │ "line": 1238,
12:09:33.067 │ "column": 18,
12:09:33.067 │ "offset": 46955
12:09:33.067 │ },
12:09:33.068 │ "reason": "Could not parse expression with acorn",
12:09:33.068 │ "ruleId": "acorn",
12:09:33.068 │ "source": "micromark-extension-mdx-expression",
12:09:33.068 │ "url": "https://github.com/micromark/micromark-extension-mdx-expression/tree/main/packages/micromark-extension-mdx-expression#could-not-parse-expression-with-acorn"
12:09:33.068 │ }
12:09:33.068 │
12:09:33.068 │ at compileToJSX (/vercel/path1/node_modules/@docusaurus/mdx-loader/lib/utils.js:93:15)
12:09:33.068 │ at async loadMDX (/vercel/path1/node_modules/@docusaurus/mdx-loader/lib/loader.js:22:20)
12:09:33.068 │ at async Object.mdxLoader (/vercel/path1/node_modules/@docusaurus/mdx-loader/lib/loader.js:157:24)
12:09:33.068
12:09:33.068 --------------------------
12:09:33.068
12:09:33.068 ╰─▶ × Error: MDX compilation failed for file "/vercel/path1/reference_versioned_docs/version-2.22/integrations-api/opensearch.md"
12:09:33.068 │ Cause: Could not parse expression with acorn
12:09:33.068 │ Details:
12:09:33.068 │ {
12:09:33.069 │ "cause": {
12:09:33.069 │ "pos": 46955,
12:09:33.069 │ "loc": {
12:09:33.069 │ "line": 1238,
12:09:33.069 │ "column": 17
12:09:33.069 │ }
12:09:33.069 │ },
12:09:33.069 │ "column": 18,
12:09:33.069 │ "file": "",
12:09:33.069 │ "message": "Could not parse expression with acorn",
12:09:33.069 │ "line": 1238,
12:09:33.069 │ "name": "1238:18",
12:09:33.069 │ "place": {
12:09:33.069 │ "line": 1238,
12:09:33.069 │ "column": 18,
12:09:33.069 │ "offset": 46955
12:09:33.069 │ },
12:09:33.069 │ "reason": "Could not parse expression with acorn",
12:09:33.069 │ "ruleId": "acorn",
12:09:33.070 │ "source": "micromark-extension-mdx-expression",
12:09:33.070 │ "url": "https://github.com/micromark/micromark-extension-mdx-expression/tree/main/packages/micromark-extension-mdx-expression#could-not-parse-expression-with-acorn"
12:09:33.070 │ }
12:09:33.070 │
12:09:33.070 │ at compileToJSX (/vercel/path1/node_modules/@docusaurus/mdx-loader/lib/utils.js:93:15)
12:09:33.070 │ at async loadMDX (/vercel/path1/node_modules/@docusaurus/mdx-loader/lib/loader.js:22:20)
12:09:33.070 │ at async Object.mdxLoader (/vercel/path1/node_modules/@docusaurus/mdx-loader/lib/loader.js:157:24)
12:09:33.228 Error: Command "npm run build" exited with 1

[anakin87]

@davidsbatista there's something wrong in docstrings of the component.

Could you please fix this in core-integrations?

[davidsbatista]

@anakin87 looking into it, I suspect where it comes from

[anakin87]

last problem in this method's docstring
https://github.com/deepset-ai/haystack-core-integrations/blob/905343c3399d76ce0562[…]stack_integrations/document_stores/opensearch/document_store.py