Skip to content

docs: add LiteLLMChatGenerator documentation page#11472

Open
julian-risch wants to merge 3 commits into
mainfrom
docs/litellm-chat-generator
Open

docs: add LiteLLMChatGenerator documentation page#11472
julian-risch wants to merge 3 commits into
mainfrom
docs/litellm-chat-generator

Conversation

@julian-risch
Copy link
Copy Markdown
Member

@julian-risch julian-risch commented Jun 1, 2026

Related Issues

Part of deepset-ai/haystack-core-integrations#3367

Proposed Changes:

Adds a documentation page for the new LiteLLMChatGenerator component, introduced in haystack-core-integrations via deepset-ai/haystack-core-integrations#3257.

  • New page docs-website/docs/pipeline-components/generators/litellmchatgenerator.mdx documenting the component (overview, parameters, tool support, streaming, async, usage examples on its own and in a pipeline).
  • Registered the page in the Generators overview table (generators.mdx).
  • Added the page to the sidebar navigation (sidebars.js).

How did you test it?

  • Code examples mirror the working integration tests in haystack-core-integrations (default model openai/gpt-4o).
  • I ran the code examples locally

Checklist

  • I have read the contributors guidelines and the code of conduct.
  • I have updated the related issue with new insights and changes.
  • I have added unit tests and updated the docstrings.
  • I've used one of the conventional commit types for my PR title: fix:, feat:, build:, chore:, ci:, docs:, style:, refactor:, perf:, test: and added ! in case the PR includes breaking changes.
  • I have documented my code.
  • I have added a release note file, following the contributors guidelines.
  • I have run pre-commit hooks and fixed any issue.

🤖 Generated with Claude Code

Add a documentation page for the new LiteLLMChatGenerator component
(litellm-haystack integration), register it in the generators overview
table, and add it to the sidebar navigation.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@vercel
Copy link
Copy Markdown

vercel Bot commented Jun 1, 2026

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

Project Deployment Actions Updated (UTC)
haystack-docs Ready Ready Preview, Comment Jun 1, 2026 6:09pm

Request Review

Updated the description for LiteLLMChatGenerator to clarify its functionality.
@julian-risch julian-risch marked this pull request as ready for review June 1, 2026 18:07
@julian-risch julian-risch requested a review from a team as a code owner June 1, 2026 18:07
@julian-risch julian-risch requested review from davidsbatista and removed request for a team June 1, 2026 18:07
@julian-risch julian-risch enabled auto-merge (squash) June 1, 2026 18:07
@claude
Copy link
Copy Markdown

claude Bot commented Jun 1, 2026

Code review

No issues found. Checked for bugs and CLAUDE.md compliance.

1 similar comment
@claude
Copy link
Copy Markdown

claude Bot commented Jun 1, 2026

Code review

No issues found. Checked for bugs and CLAUDE.md compliance.

@sjrl
Copy link
Copy Markdown
Contributor

sjrl commented Jun 2, 2026

@julian-risch we probably want to add this to previous versions of the docs as well right? At least one previous version so it will show up on our current docs website.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants