<!-- .github/pull_request_template.md -->
## Description
<!--
Please provide a clear, human-generated description of the changes in
this PR.
DO NOT use AI-generated descriptions. We want to understand your thought
process and reasoning.
-->
## Type of Change
<!-- Please check the relevant option -->
- [ ] Bug fix (non-breaking change that fixes an issue)
- [ ] New feature (non-breaking change that adds functionality)
- [ ] Breaking change (fix or feature that would cause existing
functionality to change)
- [ ] Documentation update
- [x] Code refactoring
- [ ] Performance improvement
- [ ] Other (please specify):
## Screenshots/Videos (if applicable)
<!-- Add screenshots or videos to help explain your changes -->
## Pre-submission Checklist
<!-- Please check all boxes that apply before submitting your PR -->
- [ ] **I have tested my changes thoroughly before submitting this PR**
- [ ] **This PR contains minimal changes necessary to address the
issue/feature**
- [ ] My code follows the project's coding standards and style
guidelines
- [ ] I have added tests that prove my fix is effective or that my
feature works
- [ ] I have added necessary documentation (if applicable)
- [ ] All new and existing tests pass
- [ ] I have searched existing PRs to ensure this change hasn't been
submitted already
- [ ] I have linked any relevant issues in the description
- [ ] My commits have clear and descriptive messages
## DCO Affirmation
I affirm that all code in every commit of this pull request conforms to
the terms of the Topoteretes Developer Certificate of Origin.
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit
* **Documentation**
* Deprecated legacy examples and added a migration guide mapping old
paths to new locations
* Added a comprehensive new-examples README detailing configurations,
pipelines, demos, and migration notes
* **New Features**
* Added many runnable examples and demos: database configs,
embedding/LLM setups, permissions and access-control, custom pipelines
(organizational, product recommendation, code analysis, procurement),
multimedia, visualization, temporal/ontology demos, and a local UI
starter
* **Chores**
* Updated CI/test entrypoints to use the new-examples layout
<sub>✏️ Tip: You can customize this high-level summary in your review
settings.</sub>
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
---------
Co-authored-by: lxobr <122801072+lxobr@users.noreply.github.com>
87 lines
2.8 KiB
Python
87 lines
2.8 KiB
Python
import os
|
|
import asyncio
|
|
import pathlib
|
|
from cognee import config, add, cognify, search, SearchType, prune, visualize_graph
|
|
|
|
from cognee.low_level import DataPoint
|
|
|
|
|
|
async def main():
|
|
data_directory_path = str(
|
|
pathlib.Path(os.path.join(pathlib.Path(__file__).parent, ".data_storage")).resolve()
|
|
)
|
|
# Set up the data directory. Cognee will store files here.
|
|
config.data_root_directory(data_directory_path)
|
|
|
|
cognee_directory_path = str(
|
|
pathlib.Path(os.path.join(pathlib.Path(__file__).parent, ".cognee_system")).resolve()
|
|
)
|
|
# Set up the Cognee system directory. Cognee will store system files and databases here.
|
|
config.system_root_directory(cognee_directory_path)
|
|
|
|
# Prune data and system metadata before running, only if we want "fresh" state.
|
|
await prune.prune_data()
|
|
await prune.prune_system(metadata=True)
|
|
|
|
text = "The Python programming language is widely used in data analysis, web development, and machine learning."
|
|
|
|
# Add the text data to Cognee.
|
|
await add(text)
|
|
|
|
# Define a custom graph model for programming languages.
|
|
class FieldType(DataPoint):
|
|
name: str = "Field"
|
|
|
|
class Field(DataPoint):
|
|
name: str
|
|
is_type: FieldType
|
|
metadata: dict = {"index_fields": ["name"]}
|
|
|
|
class ProgrammingLanguageType(DataPoint):
|
|
name: str = "Programming Language"
|
|
|
|
class ProgrammingLanguage(DataPoint):
|
|
name: str
|
|
used_in: list[Field] = []
|
|
is_type: ProgrammingLanguageType
|
|
metadata: dict = {"index_fields": ["name"]}
|
|
|
|
# Cognify the text data.
|
|
await cognify(graph_model=ProgrammingLanguage)
|
|
|
|
# Or use our simple graph preview
|
|
graph_file_path = str(
|
|
pathlib.Path(
|
|
os.path.join(pathlib.Path(__file__).parent, ".artifacts/graph_visualization.html")
|
|
).resolve()
|
|
)
|
|
await visualize_graph(graph_file_path)
|
|
|
|
# Completion query that uses graph data to form context.
|
|
graph_completion = await search(
|
|
query_text="What is python?", query_type=SearchType.GRAPH_COMPLETION
|
|
)
|
|
print("Graph completion result is:")
|
|
print(graph_completion)
|
|
|
|
# Completion query that uses document chunks to form context.
|
|
rag_completion = await search(
|
|
query_text="What is Python?", query_type=SearchType.RAG_COMPLETION
|
|
)
|
|
print("Completion result is:")
|
|
print(rag_completion)
|
|
|
|
# Query all summaries related to query.
|
|
summaries = await search(query_text="Python", query_type=SearchType.SUMMARIES)
|
|
print("Summary results are:")
|
|
for summary in summaries:
|
|
print(summary)
|
|
|
|
chunks = await search(query_text="Python", query_type=SearchType.CHUNKS)
|
|
print("Chunk results are:")
|
|
for chunk in chunks:
|
|
print(chunk)
|
|
|
|
|
|
if __name__ == "__main__":
|
|
asyncio.run(main())
|