docs: add missing README files for four example directories#1297
docs: add missing README files for four example directories#1297mitre88 wants to merge 1 commit intogetzep:mainfrom
Conversation
…and langgraph-agent examples
|
I have read the CLA Document and I hereby sign the CLA You can retrigger this bot by commenting recheck in this Pull Request. Posted by the CLA Assistant Lite bot. |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 083363aa6c
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| 1. Install the required dependencies: | ||
|
|
||
| ```bash | ||
| pip install graphiti-core python-dotenv |
There was a problem hiding this comment.
Install Anthropic extra before running Wizard of Oz example
The setup command omits the anthropic dependency even though runner.py imports AnthropicClient, whose module raises ImportError unless anthropic is installed (graphiti-core[anthropic] or anthropic directly). Following this README in a fresh environment will fail before the example can run.
Useful? React with 👍 / 👎.
| ## Running the Example | ||
|
|
||
| ```bash | ||
| python runner.py |
There was a problem hiding this comment.
Document a runnable command for the Wizard of Oz runner
The documented command python runner.py does not work from examples/wizard_of_oz because runner.py uses from examples.wizard_of_oz.parser import ...; when run as a script from that directory, examples is not on sys.path and execution fails with ModuleNotFoundError. This needs a module-style invocation or adjusted import guidance so users can actually execute the example.
Useful? React with 👍 / 👎.
Summary
This PR adds README documentation to four example directories that were previously missing them:
examples/podcast/— Documents the podcast transcript processing example, including transcript parsing, multi-speaker episode ingestion, and temporal ordering.examples/wizard_of_oz/— Documents the literary text processing example using The Wizard of Oz, including the Anthropic LLM client usage and chapter-based episode splitting.examples/ecommerce/— Documents the e-commerce sales conversation example, covering product knowledge extraction and customer preference tracking.examples/langgraph-agent/— Documents the LangGraph integration example for building an interactive ShoeBot sales agent with Graphiti-powered memory.Motivation
The
examples/quickstart/,examples/azure-openai/,examples/opentelemetry/, andexamples/gliner2/directories all have README files, but the other four examples did not. This makes it harder for new users to discover and understand these examples.Each README follows the same structure as the existing example READMEs:
Changes
examples/podcast/README.mdexamples/wizard_of_oz/README.mdexamples/ecommerce/README.mdexamples/langgraph-agent/README.mdNo code changes.