You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 64139cb
Browse filesBrowse the repository at this point in the historyBrowse files
The Go DSL excludes a field with `zep:"-"`, so a model reused for other
purposes can leave one out. Python raised on any field without a property
marker with no way to opt out, so the same model could not be expressed here
without splitting it. An `Excluded` marker, following the existing `Identity`
pattern, skips the field before the marker check.
The README still described capabilities this package does not ship: document
collections, the langchain chat-history and vector-store classes, a community
install of a differently named package, and an examples directory removed from
the repository.
Copy file name to clipboardExpand all lines: README.md
-60Lines changed: 0 additions & 60 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -32,78 +32,18 @@ pip install zep-cloud
32
32
> [!NOTE]
33
33
> Zep Cloud [overview](https://help.getzep.com/concepts) and [cloud sdk guide](https://help.getzep.com/sdks).
34
34
35
-
### Community Installation
36
-
```bash
37
-
pip install zep-python
38
-
```
39
-
> [!NOTE]
40
-
> Zep Community Edition [quick start](https://help.getzep.com/ce/quickstart) and [sdk guide](https://help.getzep.com/ce/sdks).
41
-
42
-
### Zep v0.x Compatible SDK
43
-
You can install Zep v0.x compatible sdk by running:
44
-
```bash
45
-
pip install "zep-python>=1.5.0,<2.0.0"
46
-
```
47
-
> [!NOTE]
48
-
> Zep v0.x [quick start](https://help.getzep.com/ce/legacy/deployment/quickstart) and [sdk guide](https://help.getzep.com/ce/legacy/sdk).
49
-
50
35
### How Zep works
51
36
52
37
Zep persists and recalls chat histories, and automatically generates summaries and other artifacts from these chat histories. It also embeds messages and summaries, enabling you to search Zep for relevant context from past conversations. Zep does all of this asynchronously, ensuring these operations don't impact your user's chat experience. Data is persisted to database, allowing you to scale out when growth demands.
53
38
54
-
Zep also provides a simple, easy to use abstraction for document vector search called Document Collections. This is designed to complement Zep's core context features, but is not designed to be a general purpose vector database.
55
-
56
39
Zep allows you to be more intentional about constructing your prompt:
57
40
1. automatically adding a few recent messages, with the number customized for your app;
58
41
2. a summary of recent conversations prior to the messages above;
59
42
3. and/or contextually relevant summaries or messages surfaced from the entire chat session.
60
-
4. and/or relevant Business data from Zep Document Collections.
61
-
62
-
Zep Cloud offers:
63
-
-**Fact Extraction:** Automatically build fact tables from conversations, without having to define a data schema upfront.
64
-
-**Dialog Classification:** Instantly and accurately classify chat dialog. Understand user intent and emotion, segment users, and more. Route chains based on semantic context, and trigger events.
65
-
-**Structured Data Extraction:** Quickly extract business data from chat conversations using a schema you define. Understand what your Assistant should ask for next in order to complete its task.
66
43
67
44
You will also need to provide a Zep Project API key to your zep client.
68
45
You can find out about zep projects in our [cloud docs](https://help.getzep.com/projects.html)
69
46
70
-
### Using LangChain Zep Classes with `zep-python`
71
-
72
-
(Currently only available on release candidate versions)
73
-
74
-
In the pre-release version `zep-python` sdk comes with `ZepChatMessageHistory` and `ZepVectorStore`
75
-
classes that are compatible with [LangChain's Python expression language](https://python.langchain.com/docs/expression_language/)
76
-
77
-
In order to use these classes in your application, you need to make sure that you have
78
-
`langchain_core` package installed, please refer to [Langchain's docs installation section](https://python.langchain.com/docs/get_started/installation#langchain-core).
79
-
80
-
We support `langchain_core@>=0.1.3<0.2.0`
81
-
82
-
You can import these classes in the following way:
83
-
84
-
```python
85
-
from zep_cloud.langchain import ZepChatMessageHistory, ZepVectorStore
86
-
```
87
-
88
-
### Running Examples
89
-
You will need to set the following environment variables to run examples in the `examples` directory:
90
-
91
-
```dotenv
92
-
# Please use examples/.env.example as a template for .env file
93
-
94
-
# Required
95
-
ZEP_API_KEY=<zep-project-api-key># Your Zep Project API Key
96
-
ZEP_COLLECTION=<zep-collection-name># used in ingestion script and in vector store examples
97
-
OPENAI_API_KEY=<openai-api-key># Your OpenAI API Key
98
-
99
-
# Optional (If you want to use langsmith with LangServe Sample App)
100
-
LANGCHAIN_TRACING_V2=true
101
-
LANGCHAIN_API_KEY=<your-langchain-api-key>
102
-
LANGCHAIN_PROJECT=<your-langchain-project-name># If not specified, defaults to "default"
0 commit comments