Skip to content

docs: add YAML example to OpenAIChatGenerator#11146

Merged
julian-risch merged 2 commits intodeepset-ai:mainfrom
ritikraj2425:docs/add-openaichatgenerator-yaml
Apr 20, 2026
Merged

docs: add YAML example to OpenAIChatGenerator#11146
julian-risch merged 2 commits intodeepset-ai:mainfrom
ritikraj2425:docs/add-openaichatgenerator-yaml

Conversation

@ritikraj2425
Copy link
Copy Markdown
Contributor

Related Issues:
fixes #11135

Proposed Changes:

  • Added a YAML representation of the conversational pipeline to the OpenAIChatGenerator documentation.
  • Ensured YAML accurately reflects the connection (prompt_builder.prompt -> llm.messages) defined in the Python snippet.

How did you test it?

  • Manual validation: Verified the serialized keys for OpenAIChatGenerator (e.g. api_key environment variables mapping).

Checklist

  • I have read the contributors guidelines...
  • I have updated the related issue...
  • I have added unit tests and updated the docstrings. (N/A for documentation changes)
  • I've used one of the conventional commit types... docs:
  • I have documented my code.
  • I have added a release note file.
  • I have run pre-commit hooks and fixed any issue.

@ritikraj2425 ritikraj2425 requested a review from a team as a code owner April 19, 2026 16:01
@ritikraj2425 ritikraj2425 requested review from julian-risch and removed request for a team April 19, 2026 16:01
@vercel
Copy link
Copy Markdown

vercel Bot commented Apr 19, 2026

@ritikraj2425 is attempting to deploy a commit to the deepset Team on Vercel.

A member of the Team first needs to authorize it.

@julian-risch julian-risch added the ignore-for-release-notes PRs with this flag won't be included in the release notes. label Apr 20, 2026
@vercel
Copy link
Copy Markdown

vercel Bot commented Apr 20, 2026

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

Project Deployment Actions Updated (UTC)
haystack-docs Ready Ready Preview, Comment Apr 20, 2026 6:57am

Request Review

Copy link
Copy Markdown
Member

@julian-risch julian-risch left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for your contribution @ritikraj2425 ! I tested the YAML in a google colab notebook and can confirm it works. 👍

…656ff08.yaml

`docs` section does not exist in reno and we typically do not include small docs updates in release notes
@julian-risch julian-risch merged commit f297288 into deepset-ai:main Apr 20, 2026
17 of 18 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ignore-for-release-notes PRs with this flag won't be included in the release notes.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add pipeline YAML example to Haystack documentation page of OpenAIChatGenerator

2 participants