docs[minor]: Add missing {context} variable in example #6486
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Just adding a missing period.
Make the code example cleaner and easier to read by removing unnecessary else/if statements.
`createStuffDocumentsChain` requires a `context` variable to be included in the prompt passed to it. Otherwise, the following error is thrown if one tries to reproduce the example given: `Error: Prompt must include a "context" variable`
dosubot
bot
added
the
size:XS
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
kostasx
changed the title
|
Thanks! |
This was referenced Aug 12, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The example included under the deprecated
RetrievalQAChainmethod is missing the required{context}variable.The
createStuffDocumentsChain"expects a dictionary as input with a list ofDocuments being passed under the "context" key." as per the specs.If one tries to replicate the example without including the
{context}variable in the prompt template, the following error is produced:Which is based on
DOCUMENTS_KEY = "context";I believe the example must include the required variable to avoid any confusion and streamline the process of migrating to the alternative syntax.