SDK regeneration

.fern/metadata.json

@@ -0,0 +1,16 @@
+{
+  "cliVersion": "5.50.1",
+  "generatorName": "fernapi/fern-python-sdk",
+  "generatorVersion": "4.64.1",
+  "generatorConfig": {
+    "package_name": "zep_cloud",
+    "client": {
+      "filename": "base_client.py",
+      "class_name": "BaseClient",
+      "exported_filename": "client.py",
+      "exported_class_name": "Zep"
+    }
+  },
+  "originGitCommit": "4135f93a8bc65a8ec8f29a261ce0e721b714cc57",
+  "sdkVersion": "4.0.0a1"
+}

.fernignore

@@ -9,3 +9,5 @@
 .github
 LICENSE
 .gitattributes
+.fern/replay.lock
+.fern/replay.yml

.gitignore

@@ -1,11 +1,5 @@
-.env
-dist/
 .mypy_cache/
+.ruff_cache/
 __pycache__/
+dist/
 poetry.toml
-.idea/
-.vscode/
-*.env
-.venv/
-venv/
-.cache/

README.md

@@ -1,27 +1,25 @@
+# Zep Python Library
 
-[![Release to PyPI](https://github.com/getzep/zep-python/actions/workflows/release.yml/badge.svg)](https://github.com/getzep/zep-python/actions/workflows/release.yml) ![GitHub](https://img.shields.io/github/license/getzep/zep-python?color=blue) [![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://github.com/fern-api/fern)
+[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-Built%20with%20Fern-brightgreen)](https://buildwithfern.com?utm_source=github&utm_medium=github&utm_campaign=readme&utm_source=https%3A%2F%2Fgithub.com%2Fgetzep%2Fzep-python)
+[![pypi](https://img.shields.io/pypi/v/zep-cloud)](https://pypi.python.org/pypi/zep-cloud)
 
+The Zep Python library provides convenient access to the Zep APIs from Python.
 
-<p align="center">
-  <a href="https://www.getzep.com/">
-    <img src="https://raw.githubusercontent.com/getzep/zep/main/assets/zep-logo-icon-gradient-rgb.svg" width="150" alt="Zep Logo">
-  </a>
-</p>
+## Table of Contents
 
-<h1 align="center">
-Zep: Long-Term Context for ‍AI Assistants.
-</h1>
-<h2 align="center">Recall, understand, and extract data from chat histories. Power personalized AI experiences.</h2>
-<br />
-
-<p align="center">
-<a href="https://docs.getzep.com/deployment/quickstart/">Quick Start</a> | 
-<a href="https://docs.getzep.com/">Documentation</a> | 
-<a href="https://docs.getzep.com/sdk/langchain/">LangChain</a> and 
-<a href="https://docs.getzep.com/sdk/langchain/">LlamaIndex</a> Support | 
-<a href="https://discord.gg/W8Kw6bsgXQ">Discord</a><br />
-<a href="https://www.getzep.com">www.getzep.com</a>
-</p>
+- [What Is Zep 💬](#what-is-zep-)
+- [Installation](#installation)
+- [Reference](#reference)
+- [Usage](#usage)
+- [Async Client](#async-client)
+- [Exception Handling](#exception-handling)
+- [Pagination](#pagination)
+- [Advanced](#advanced)
+  - [Access Raw Response Data](#access-raw-response-data)
+  - [Retries](#retries)
+  - [Timeouts](#timeouts)
+  - [Custom Client](#custom-client)
+- [Contributing](#contributing)
 
 ## What is Zep? 💬
 Zep is a context engineering platform for AI Assistant apps. With Zep, you can provide AI assistants with the ability to recall past conversations, no matter how distant, while also reducing hallucinations, latency, and cost.
@@ -105,3 +103,170 @@ LANGCHAIN_PROJECT=<your-langchain-project-name># If not specified, defaults to "
 ```
 
 
+
+## Installation
+
+```sh
+pip install zep-cloud
+```
+
+## Reference
+
+A full reference for this library is available [here](https://github.com/getzep/zep-python/blob/HEAD/./reference.md).
+
+## Usage
+
+Instantiate and use the client with the following:
+
+```python
+from zep_cloud import Zep
+
+client = Zep(
+    api_key="<value>",
+)
+
+client.batch.create()
+```
+
+## Async Client
+
+The SDK also exports an `async` client so that you can make non-blocking calls to our API. Note that if you are constructing an Async httpx client class to pass into this client, use `httpx.AsyncClient()` instead of `httpx.Client()` (e.g. for the `httpx_client` parameter of this client).
+
+```python
+import asyncio
+
+from zep_cloud import AsyncZep
+
+client = AsyncZep(
+    api_key="<value>",
+)
+
+
+async def main() -> None:
+    await client.batch.create()
+
+
+asyncio.run(main())
+```
+
+## Exception Handling
+
+When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error
+will be thrown.
+
+```python
+from zep_cloud.core.api_error import ApiError
+
+try:
+    client.batch.create(...)
+except ApiError as e:
+    print(e.status_code)
+    print(e.body)
+```
+
+## Pagination
+
+Paginated requests will return a `SyncPager` or `AsyncPager`, which can be used as generators for the underlying object.
+
+```python
+from zep_cloud import Zep
+
+client = Zep(
+    api_key="<value>",
+)
+
+client.batch.list(
+    limit=1,
+    cursor="cursor",
+    status="status",
+)
+```
+
+```python
+# You can also iterate through pages and access the typed response per page
+pager = client.batch.list(...)
+for page in pager.iter_pages():
+    print(page.response)  # access the typed response for each page
+    for item in page:
+        print(item)
+```
+
+## Advanced
+
+### Access Raw Response Data
+
+The SDK provides access to raw response data, including headers, through the `.with_raw_response` property.
+The `.with_raw_response` property returns a "raw" client that can be used to access the `.headers` and `.data` attributes.
+
+```python
+from zep_cloud import Zep
+
+client = Zep(...)
+response = client.batch.with_raw_response.create(...)
+print(response.headers)  # access the response headers
+print(response.status_code)  # access the response status code
+print(response.data)  # access the underlying object
+```
+
+### Retries
+
+The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long
+as the request is deemed retryable and the number of retry attempts has not grown larger than the configured
+retry limit (default: 2).
+
+A request is deemed retryable when any of the following HTTP status codes is returned:
+
+- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout)
+- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests)
+- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors)
+
+Use the `max_retries` request option to configure this behavior.
+
+```python
+client.batch.create(..., request_options={
+    "max_retries": 1
+})
+```
+
+### Timeouts
+
+The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level.
+
+```python
+from zep_cloud import Zep
+
+client = Zep(..., timeout=20.0)
+
+# Override timeout for a specific method
+client.batch.create(..., request_options={
+    "timeout_in_seconds": 1
+})
+```
+
+### Custom Client
+
+You can override the `httpx` client to customize it for your use-case. Some common use-cases include support for proxies
+and transports.
+
+```python
+import httpx
+from zep_cloud import Zep
+
+client = Zep(
+    ...,
+    httpx_client=httpx.Client(
+        proxy="http://my.test.proxy.example.com",
+        transport=httpx.HTTPTransport(local_address="0.0.0.0"),
+    ),
+)
+```
+
+## Contributing
+
+While we value open-source contributions to this SDK, this library is generated programmatically.
+Additions made directly to this library would have to be moved over to our generation code,
+otherwise they would be overwritten upon the next generated release. Feel free to open a PR as
+a proof of concept, but know that we will not be able to merge it as-is. We suggest opening
+an issue first to discuss with us!
+
+On the other hand, contributions to the README are always very welcome!