Skip to content

docs: add chatpromptbuilder yaml#11143

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

docs: add chatpromptbuilder yaml#11143
julian-risch merged 3 commits intodeepset-ai:mainfrom
ritikraj2425:docs/add-chatpromptbuilder-yaml

Conversation

@ritikraj2425
Copy link
Copy Markdown
Contributor

Related Issues

Proposed Changes:

  • Added a YAML representation of the conversational pipeline to the ChatPromptBuilder documentation.
  • Included an introductory sentence explaining that the pipeline dynamically constructs prompts and generates answers using a chat model.
  • Ensured the YAML example is consistent with the Python code block demonstrating the integration of ChatPromptBuilder and OpenAIChatGenerator.

How did you test it?

  • Manual verification: Verified the YAML structure against standard Haystack serialization formats.
  • Confirmed that the YAML correctly maps the prompt_builder.prompt output to the llm.messages input as shown in the Python example.

Notes for the reviewer

The YAML example was placed at the end of the "Usage" section to match the documentation pattern of other components recently updated with YAML examples.

Checklist

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

vercel Bot commented Apr 19, 2026

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

A member of the Team first needs to authorize it.

@CLAassistant
Copy link
Copy Markdown

CLAassistant commented Apr 19, 2026

CLA assistant check
All committers have signed the CLA.

@ritikraj2425 ritikraj2425 changed the title Docs/add chatpromptbuilder yaml docs: add chatpromptbuilder yaml Apr 19, 2026
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 another contribution @ritikraj2425 ! I tested this exact YAML as part of #11146 already in a google colab notebook and can confirm it works. 👍

…aaa43.yaml

`docs` section does not exist in reno and we typically don't include small docs updates in release notes
@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.

1 Skipped Deployment
Project Deployment Actions Updated (UTC)
haystack-docs Ignored Ignored Preview Apr 20, 2026 7:10am

Request Review

@julian-risch julian-risch merged commit aa6454f into deepset-ai:main Apr 20, 2026
24 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 ChatPromptBuilder

3 participants