Update docstring (#283)

* chore: Fix fact ratings table

* SDK regeneration

* chore: Version bump

* chore: Version bump

* SDK regeneration

* chore: Add support for user/graph ontology targets

* SDK regeneration

* chore: Add support for setting entity/edges on a list of users/graphs

* SDK regeneration

* chore: Bump version

* SDK regeneration

* feat: Update compose context string util to include episodes and display entity attributes

* chore: Bump version

* fix: tests

* chore: Remove redundant timestamp conversion branch

* SDK regeneration

* chore: Version bump

* SDK regeneration

* SDK regeneration

* fix: tests

* chore: Version bump

* SDK regeneration

---------

Co-authored-by: fern-api <115122769+fern-api[bot]@users.noreply.github.com>

Author: paul-paliychuk

pyproject.toml

@@ -3,7 +3,7 @@ name = "zep-cloud"
 
 [tool.poetry]
 name = "zep-cloud"
-version = "3.4.0"
+version = "3.4.1"
 description = ""
 readme = "README.md"
 authors = []

reference.md

@@ -1462,7 +1462,7 @@ client.thread.delete(
 <dl>
 <dd>
 
-Returns most relevant context for a given thread.
+Returns most relevant context from the user graph (including memory from any/all past threads) based on the content of the past few messages of the given thread.
 </dd>
 </dl>
 </dd>
@@ -1500,7 +1500,7 @@ client.thread.get_user_context(
 <dl>
 <dd>
 
-**thread_id:** `str` — The ID of the thread for which to retrieve context.
+**thread_id:** `str` — The ID of the current thread (for which context is being retrieved).
 
 </dd>
 </dl>
@@ -1714,7 +1714,7 @@ that are added to a user's graph.
 <dl>
 <dd>
 
-**return_context:** `typing.Optional[bool]` — Optionally return memory context relevant to the most recent messages.
+**return_context:** `typing.Optional[bool]` — Optionally return context block relevant to the most recent messages.
 
 </dd>
 </dl>
@@ -1818,7 +1818,7 @@ that are added to a user's graph.
 <dl>
 <dd>
 
-**return_context:** `typing.Optional[bool]` — Optionally return memory context relevant to the most recent messages.
+**return_context:** `typing.Optional[bool]` — Optionally return context block relevant to the most recent messages.
 
 </dd>
 </dl>

src/zep_cloud/core/client_wrapper.py

@@ -22,10 +22,10 @@ def __init__(
 
     def get_headers(self) -> typing.Dict[str, str]:
         headers: typing.Dict[str, str] = {
-            "User-Agent": "zep-cloud/3.4.0",
+            "User-Agent": "zep-cloud/3.4.1",
             "X-Fern-Language": "Python",
             "X-Fern-SDK-Name": "zep-cloud",
-            "X-Fern-SDK-Version": "3.4.0",
+            "X-Fern-SDK-Version": "3.4.1",
             **(self.get_custom_headers() or {}),
         }
         headers["Authorization"] = f"Api-Key {self.api_key}"

src/zep_cloud/thread/client.py

@@ -159,12 +159,12 @@ def get_user_context(
         request_options: typing.Optional[RequestOptions] = None,
     ) -> ThreadContextResponse:
         """
-        Returns most relevant context for a given thread.
+        Returns most relevant context from the user graph (including memory from any/all past threads) based on the content of the past few messages of the given thread.
 
         Parameters
         ----------
         thread_id : str
-            The ID of the thread for which to retrieve context.
+            The ID of the current thread (for which context is being retrieved).
 
         min_rating : typing.Optional[float]
             The minimum rating by which to filter relevant facts.
@@ -272,7 +272,7 @@ def add_messages(
             that are added to a user's graph.
 
         return_context : typing.Optional[bool]
-            Optionally return memory context relevant to the most recent messages.
+            Optionally return context block relevant to the most recent messages.
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -334,7 +334,7 @@ def add_messages_batch(
             that are added to a user's graph.
 
         return_context : typing.Optional[bool]
-            Optionally return memory context relevant to the most recent messages.
+            Optionally return context block relevant to the most recent messages.
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -537,12 +537,12 @@ async def get_user_context(
         request_options: typing.Optional[RequestOptions] = None,
     ) -> ThreadContextResponse:
         """
-        Returns most relevant context for a given thread.
+        Returns most relevant context from the user graph (including memory from any/all past threads) based on the content of the past few messages of the given thread.
 
         Parameters
         ----------
         thread_id : str
-            The ID of the thread for which to retrieve context.
+            The ID of the current thread (for which context is being retrieved).
 
         min_rating : typing.Optional[float]
             The minimum rating by which to filter relevant facts.
@@ -666,7 +666,7 @@ async def add_messages(
             that are added to a user's graph.
 
         return_context : typing.Optional[bool]
-            Optionally return memory context relevant to the most recent messages.
+            Optionally return context block relevant to the most recent messages.
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -736,7 +736,7 @@ async def add_messages_batch(
             that are added to a user's graph.
 
         return_context : typing.Optional[bool]
-            Optionally return memory context relevant to the most recent messages.
+            Optionally return context block relevant to the most recent messages.
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.

src/zep_cloud/thread/raw_client.py

@@ -268,12 +268,12 @@ def get_user_context(
         request_options: typing.Optional[RequestOptions] = None,
     ) -> HttpResponse[ThreadContextResponse]:
         """
-        Returns most relevant context for a given thread.
+        Returns most relevant context from the user graph (including memory from any/all past threads) based on the content of the past few messages of the given thread.
 
         Parameters
         ----------
         thread_id : str
-            The ID of the thread for which to retrieve context.
+            The ID of the current thread (for which context is being retrieved).
 
         min_rating : typing.Optional[float]
             The minimum rating by which to filter relevant facts.
@@ -450,7 +450,7 @@ def add_messages(
             that are added to a user's graph.
 
         return_context : typing.Optional[bool]
-            Optionally return memory context relevant to the most recent messages.
+            Optionally return context block relevant to the most recent messages.
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -532,7 +532,7 @@ def add_messages_batch(
             that are added to a user's graph.
 
         return_context : typing.Optional[bool]
-            Optionally return memory context relevant to the most recent messages.
+            Optionally return context block relevant to the most recent messages.
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -829,12 +829,12 @@ async def get_user_context(
         request_options: typing.Optional[RequestOptions] = None,
     ) -> AsyncHttpResponse[ThreadContextResponse]:
         """
-        Returns most relevant context for a given thread.
+        Returns most relevant context from the user graph (including memory from any/all past threads) based on the content of the past few messages of the given thread.
 
         Parameters
         ----------
         thread_id : str
-            The ID of the thread for which to retrieve context.
+            The ID of the current thread (for which context is being retrieved).
 
         min_rating : typing.Optional[float]
             The minimum rating by which to filter relevant facts.
@@ -1011,7 +1011,7 @@ async def add_messages(
             that are added to a user's graph.
 
         return_context : typing.Optional[bool]
-            Optionally return memory context relevant to the most recent messages.
+            Optionally return context block relevant to the most recent messages.
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -1093,7 +1093,7 @@ async def add_messages_batch(
             that are added to a user's graph.
 
         return_context : typing.Optional[bool]
-            Optionally return memory context relevant to the most recent messages.
+            Optionally return context block relevant to the most recent messages.
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.

src/zep_cloud/types/add_thread_messages_request.py

@@ -23,7 +23,7 @@ class AddThreadMessagesRequest(UniversalBaseModel):
 
     return_context: typing.Optional[bool] = pydantic.Field(default=None)
     """
-    Optionally return memory context relevant to the most recent messages.
+    Optionally return context block relevant to the most recent messages.
     """
 
     if IS_PYDANTIC_V2:

src/zep_cloud/types/thread_context_response.py

@@ -9,7 +9,7 @@
 class ThreadContextResponse(UniversalBaseModel):
     context: typing.Optional[str] = pydantic.Field(default=None)
     """
-    Memory context containing relevant facts and entities for the session. Can be put into the prompt directly.
+    Context block containing relevant facts, entities, and messages/episodes from the user graph. Meant to be replaced in the system prompt on every chat turn.
     """
 
     if IS_PYDANTIC_V2: