Skip to content

docs: added YAML example to OpenAIGenerator#11145

Merged
anakin87 merged 1 commit intodeepset-ai:mainfrom
ritikraj2425:docs/add-openaigenerator-yaml
Apr 20, 2026
Merged

docs: added YAML example to OpenAIGenerator#11145
anakin87 merged 1 commit intodeepset-ai:mainfrom
ritikraj2425:docs/add-openaigenerator-yaml

Conversation

@ritikraj2425
Copy link
Copy Markdown
Contributor

@ritikraj2425 ritikraj2425 commented Apr 19, 2026

Related Issues:
fixes #11134

Proposed Changes:

  • Fixed a missing closing parenthesis syntax error in the OpenAIGenerator Python code example at line 125.
  • Added a YAML representation of the RAG pipeline to the OpenAIGenerator documentation.
  • Included an introductory sentence explaining how the pipeline retrieves documents, templates the prompt, and generates an answer.

How did you test it?

  • Manual verification: Read through the YAML representation, validating that the connection mappings accurately match the Python code block.
  • Tested the syntax fix for pipe.add_component("llm", OpenAIGenerator(...)) to ensure correct Python evaluation.

Notes for the reviewer
The YAML example was placed at the end of the ### In a Pipeline section. A small Python typo in the docs was also fixed.

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 15:51
@ritikraj2425 ritikraj2425 requested review from anakin87 and removed request for a team April 19, 2026 15:51
@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.

@ritikraj2425 ritikraj2425 force-pushed the docs/add-openaigenerator-yaml branch from 75d2509 to 65b2b73 Compare April 19, 2026 15:59
Copy link
Copy Markdown
Member

@anakin87 anakin87 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!

I found some aspects to improve

Comment thread docs-website/docs/pipeline-components/generators/openaigenerator.mdx Outdated
Comment thread releasenotes/notes/add-yaml-openaigenerator-docs-da09792fa40a7a9f.yaml Outdated
Comment thread docs-website/docs/pipeline-components/generators/openaigenerator.mdx Outdated
@ritikraj2425 ritikraj2425 force-pushed the docs/add-openaigenerator-yaml branch from 65b2b73 to 5dfbf82 Compare April 20, 2026 07:38
@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 7:41am

Request Review

@ritikraj2425
Copy link
Copy Markdown
Contributor Author

Hey @anakin87,
All the comments are resolved!

Copy link
Copy Markdown
Member

@anakin87 anakin87 left a comment

Choose a reason for hiding this comment

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

Looks good

@anakin87 anakin87 merged commit c2d1bb8 into deepset-ai:main Apr 20, 2026
18 of 19 checks passed
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.

Add pipeline YAML example to Haystack documentation page of OpenAIGenerator

2 participants