community[patch]: docstrings (#16810)

- added missed docstrings
- formated docstrings to the consistent form
This commit is contained in:
Leonid Ganeline
2024-02-09 12:48:57 -08:00
committed by GitHub
parent ae66bcbc10
commit 932c52c333
25 changed files with 66 additions and 18 deletions

View File

@@ -25,6 +25,8 @@ V = TypeVar("V")
class AstraDBBaseStore(Generic[V], BaseStore[str, V], ABC):
"""Base class for the DataStax AstraDB data store."""
def __init__(
self,
collection_name: str,
@@ -79,6 +81,7 @@ class AstraDBBaseStore(Generic[V], BaseStore[str, V], ABC):
class AstraDBStore(AstraDBBaseStore[Any]):
"""BaseStore implementation using DataStax AstraDB as the underlying store.
The value type can be any type serializable by json.dumps.
Can be used to store embeddings with the CacheBackedEmbeddings.
Documents in the AstraDB collection will have the format
@@ -97,6 +100,7 @@ class AstraDBStore(AstraDBBaseStore[Any]):
class AstraDBByteStore(AstraDBBaseStore[bytes], ByteStore):
"""ByteStore implementation using DataStax AstraDB as the underlying store.
The bytes values are converted to base64 encoded strings
Documents in the AstraDB collection will have the format
{