Revise README and handle error messages in ChromaDB#41
Merged
Conversation
Removed unused import of Streamlit.
Updated the README to reflect new features and usage instructions for GnosisPages, including semantic search capabilities and local setup requirements.
This file contains hidden or 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
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.
This pull request introduces several improvements to GnosisPages, focusing on enhanced documentation, better environment configuration, more robust agent prompt management, and improved error handling for database queries. The changes make the app easier to set up and use, clarify its architecture and use cases, and ensure more reliable user feedback in case of misconfiguration.
Documentation & Setup Improvements:
README.mdto clarify the product's purpose, architecture, data flow, setup instructions, and deployment process. It now includes detailed explanations, usage scenarios, and a project structure overview..example.envwith placeholders for the OpenAI API key and system prompt path, making it easier for users to configure the application.Agent & Prompt Handling:
gnosis/agent.pyto load the system prompt from a file path or environment variable, with a sensible default fallback. This allows for easier customization of the assistant's behavior.prompts/demo-prompt.md) with clear guidelines for the recruitment assistant use case.Error Handling & State Management:
gnosis/search.pyto handle missing API keys, inaccessible collections, and empty databases, providing clear user feedback in each case.Summary of most important changes:
Documentation and Setup
README.mdto clarify use cases, architecture, setup, and deployment, making onboarding easier for new users..example.envto guide users in configuring environment variables.Agent Prompt Handling
prompts/demo-prompt.mdfor improved LLM guidance.Robustness and Error Handling