docs: add Haystack (deepset) integration page#79
Conversation
WalkthroughChangesHaystack integration documentation
Estimated code review effort: 2 (Simple) | ~10 minutes Possibly related PRs
Suggested reviewers: Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@v3/integrations/haystack.mdx`:
- Line 63: Update all Haystack 2.x run calls in v3/integrations/haystack.mdx:
lines 63-63 and 107-107 must pass messages=..., line 88-88 must pass
messages=messages, line 131-131 must pass documents=documents, and line 136-136
must pass text=....
- Line 53: Replace the EDENAI_API_KEY placeholder your_api_key_here with
api_token at both affected sites in v3/integrations/haystack.mdx: lines 53-53
and 161-161, preserving the surrounding snippets.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: e5bd9aea-7ec9-4799-a3b6-eda766756e02
⛔ Files ignored due to path filters (1)
integration-logo/haystack-icondoc.svgis excluded by!**/*.svg
📒 Files selected for processing (2)
docs.jsonv3/integrations/haystack.mdx
|
|
||
| <CodeGroup> | ||
| ```bash .env | ||
| EDENAI_API_KEY=your_api_key_here |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Use standard token placeholder.
Both snippets use your_api_key_here, but the coding guidelines require distinguishing token types by using api_token (for production) or sandbox_api_token (for testing) in examples without real provider calls. Please update the placeholder to api_token to maintain consistency across the documentation.
v3/integrations/haystack.mdx#L53-L53: replaceyour_api_key_herewithapi_tokenv3/integrations/haystack.mdx#L161-L161: replaceyour_api_key_herewithapi_token
📍 Affects 1 file
v3/integrations/haystack.mdx#L53-L53(this comment)v3/integrations/haystack.mdx#L161-L161
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@v3/integrations/haystack.mdx` at line 53, Replace the EDENAI_API_KEY
placeholder your_api_key_here with api_token at both affected sites in
v3/integrations/haystack.mdx: lines 53-53 and 161-161, preserving the
surrounding snippets.
Source: Coding guidelines
|
|
||
| generator = EdenAIChatGenerator(model="mistral/mistral-large-latest") | ||
|
|
||
| response = generator.run([ChatMessage.from_user("What is Eden AI?")]) |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟠 Major | ⚡ Quick win
Use keyword arguments for run() calls.
Haystack 2.x components enforce or strongly expect keyword arguments for their .run() methods. Passing positional arguments will result in a TypeError at runtime, causing these code examples to fail when users copy and paste them. Update these calls to explicitly use kwargs.
v3/integrations/haystack.mdx#L63-L63: changegenerator.run([...])togenerator.run(messages=[...])v3/integrations/haystack.mdx#L88-L88: changegenerator.run(messages)togenerator.run(messages=messages)v3/integrations/haystack.mdx#L107-L107: changegenerator.run([...])togenerator.run(messages=[...])v3/integrations/haystack.mdx#L131-L131: changedoc_embedder.run(documents)todoc_embedder.run(documents=documents)v3/integrations/haystack.mdx#L136-L136: changetext_embedder.run("What is Eden AI?")totext_embedder.run(text="What is Eden AI?")
📍 Affects 1 file
v3/integrations/haystack.mdx#L63-L63(this comment)v3/integrations/haystack.mdx#L88-L88v3/integrations/haystack.mdx#L107-L107v3/integrations/haystack.mdx#L131-L131v3/integrations/haystack.mdx#L136-L136
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@v3/integrations/haystack.mdx` at line 63, Update all Haystack 2.x run calls
in v3/integrations/haystack.mdx: lines 63-63 and 107-107 must pass messages=...,
line 88-88 must pass messages=messages, line 131-131 must pass
documents=documents, and line 136-136 must pass text=....
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
1 participant
Adds the Eden AI + Haystack (deepset) integration guide under AI Frameworks.
v3/integrations/haystack.mdx: overview, installation, quick start (chat), switching models, streaming, embeddings + RAG, available models, env varsintegration-logo/haystack-icondoc.svg: official Haystack logo (currentColor)docs.json: adds the page to the AI Frameworks group (after aisuite)Eden AI is now an official Haystack integration (the
edenai-haystackpackage, merged into deepset/haystack-core-integrations in #3615). Env var:EDENAI_API_KEY. Python snippets are markedskip-testsinceedenai-haystackis not in the docs test sandbox.Summary by CodeRabbit