Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

📝 docs: Added RAG_USE_FULL_CONTEXT to .env.example #4494

Merged
merged 1 commit into from
Oct 31, 2024

Conversation

timmanik
Copy link
Contributor

Summary

Currently, there isn't documentation that highlights the ability to use full context of the documents uploaded for RAG. This causes new users like myself to run into subpar RAG results in certain scenarios. Adding the RAG_USE_FULL_CONTEXT to the .env.example file for better visibility.

Relevant PRs

Change Type

Please delete any irrelevant options.

  • This change requires a documentation update

Testing

The functionality of using RAG_USE_FULL_CONTEXT has already existed and been tested. Though, I tested it again and it works. The results of the RAG output visibly includes more context when setting RAG_USE_FULL_CONTEXT=true and not having the variable defined at all in .env. It is more apparent when using smaller models (8b params or less).

Test Configuration:

Checklist

Please delete any irrelevant options.

  • My code adheres to this project's style guidelines
  • I have performed a self-review of my own code
  • I have made pertinent documentation changes
  • Local unit tests pass with my changes
  • A pull request for updating the documentation has been submitted.

@danny-avila danny-avila changed the title Added the RAG_USE_FULL_CONTEXT variable for awareness 📝 docs: Added RAG_USE_FULL_CONTEXT to .env.example Oct 31, 2024
@danny-avila danny-avila merged commit 1909efd into danny-avila:main Oct 31, 2024
owengo pushed a commit to openwengo/LibreChat that referenced this pull request Nov 5, 2024
BertKiv pushed a commit to BertKiv/LibreChat that referenced this pull request Dec 10, 2024
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