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

Update README.md w/ spacing #56

Merged
merged 1 commit into from
Aug 27, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,8 @@ With graphiti, you can build LLM applications such as:

graphiti supports a wide range of applications in sales, customer service, health, finance, and more, enabling long-term recall and state-based reasoning for both assistants and agents.

<br />

## Why graphiti?

graphiti is designed for dynamic data and agentic use:
Expand All @@ -45,12 +47,16 @@ graphiti is designed for dynamic data and agentic use:
- **Fast**: Search results in < 100ms, with latency primarily determined by the 3rd-party embedding API call.
- **Schema Consistency**: Maintains a coherent graph structure by reusing existing schema, preventing unnecessary proliferation of node and edge types.

<br />

## graphiti and Zep Memory

graphiti powers the core of Zep's next-generation memory layer for LLM-powered Assistants and Agents.

We're excited to open-source graphiti, believing its potential reaches far beyond memory applications.

<br />

## Installation

Requirements:
Expand All @@ -72,6 +78,8 @@ or

`poetry add graphiti-core`

<br />

## Quick Start

> [!IMPORTANT]
Expand Down Expand Up @@ -136,6 +144,8 @@ await client.search('Who was the California Attorney General?', center_node_uuid
graphiti.close()
```

<br />

## Documentation

### Adding Episodes
Expand Down Expand Up @@ -340,6 +350,8 @@ print_facts(results)
> The Allbirds Wool Runners are sold by Allbirds.
```

<br />

## Status and Roadmap

graphiti is under active development. We aim to maintain API stability while working on:
Expand All @@ -354,6 +366,7 @@ graphiti is under active development. We aim to maintain API stability while wor
- [ ] Enhancing retrieval capabilities with more robust and configurable options
- [ ] Expanding test coverage to ensure reliability and catch edge cases

<br />

## Contributing

Expand Down