Python: updated docstrings (#1225)

* updated docstrings

* fix tests and mypy

* hosted file search docstring update

* updated versions
This commit is contained in:
Eduard van Valkenburg
2025-10-06 18:04:39 +02:00
committed by GitHub
Unverified
parent b2ab9931fd
commit 714e7b50d4
32 changed files with 592 additions and 319 deletions
@@ -227,7 +227,7 @@ class RedisChatMessageStore:
Captures the Redis connection configuration and thread information needed to
reconstruct the store and reconnect to the same conversation data.
Args:
Keyword Args:
**kwargs: Additional arguments passed to Pydantic model_dump() for serialization.
Common options: exclude_none=True, by_alias=True
@@ -254,6 +254,8 @@ class RedisChatMessageStore:
Args:
serialized_store_state: Previously serialized state data from serialize_state().
Should be a dictionary with thread_id, redis_url, etc.
Keyword Args:
**kwargs: Additional arguments passed to Pydantic model validation.
Returns:
@@ -286,6 +288,8 @@ class RedisChatMessageStore:
Args:
serialized_store_state: Previously serialized state data from serialize_state().
Should be a dictionary with thread_id, redis_url, etc.
Keyword Args:
**kwargs: Additional arguments passed to Pydantic model validation.
"""
if not serialized_store_state:
@@ -154,7 +154,7 @@ class RedisProvider(ContextProvider):
Defines text and tag fields for messages plus an optional vector field enabling KNN/hybrid search.
Args:
Keyword Args:
index_name: Index name.
prefix: Key prefix.
vector_field_name: Vector field name or None.
@@ -300,7 +300,7 @@ class RedisProvider(ContextProvider):
Fills default partition fields, optionally embeds content when configured, and loads documents in a batch.
Args:
Keyword Args:
data: Single document or list of documents to insert.
metadata: Optional metadata dictionary (unused placeholder).
@@ -363,6 +363,8 @@ class RedisProvider(ContextProvider):
Args:
text: Query text.
Keyword Args:
text_scorer: Scorer to use for text ranking.
filter_expression: Additional filter expression to AND with partition filters.
return_fields: Fields to return in results.
@@ -526,7 +528,9 @@ class RedisProvider(ContextProvider):
Args:
messages: List of new messages in the thread.
kwargs: not used at present at present.
Keyword Args:
**kwargs: not used at present at present.
Returns:
Context: Context object containing instructions with memories.