Skip to content

feat: add minimal end-to-end example for running the agent locally#44

Open
tisha-varma wants to merge 1 commit intoINCF:mainfrom
tisha-varma:feature/add-examples-demo
Open

feat: add minimal end-to-end example for running the agent locally#44
tisha-varma wants to merge 1 commit intoINCF:mainfrom
tisha-varma:feature/add-examples-demo

Conversation

@tisha-varma
Copy link

@tisha-varma tisha-varma commented Jan 30, 2026

This PR implements the minimal end-to-end example proposed in #35.

It adds a small examples/ directory with:
- a basic demo script showing how to initialize and run the KnowledgeSpace agent locally,
- a concise README for setup and onboarding,
- and illustrative mock dataset entries for reference.

The demo is designed for local development and onboarding.
When backend search services are not configured, the agent may return zero search results, which is expected and handled gracefully.

Fixes #35

Closes INCF#35

Added examples/ directory with:
- basic_demo.py: Minimal Python script demonstrating agent usage
- README.md: Setup instructions and workflow documentation
- local_knowledge.json: Sample mock dataset entries for reference

The demo is designed for local development and onboarding.
When backend search services are not configured, the agent may return
zero search results, which is expected and handled gracefully.
@Kartikharitwal
Copy link

Thanks for the PR! I’m going to pull this locally and test it. If I notice any small improvements (README clarity, env variable examples, or Windows notes), I’ll propose a follow-up PR.

@tisha-varma
Copy link
Author

Thanks for the PR! I’m going to pull this locally and test it. If I notice any small improvements (README clarity, env variable examples, or Windows notes), I’ll propose a follow-up PR.

Hi Kartik, thanks a lot for taking the time to test this locally!

I really appreciate it. Happy to incorporate any suggestions you have, and thanks for offering to propose a follow-up PR if needed.

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 a minimal reproducible end-to-end example for running the knowledge-space agent locally

2 participants