Skip to content

Commit

Permalink
community[patch]: Add AstraDBLoader docstring (#17873)
Browse files Browse the repository at this point in the history
  • Loading branch information
cbornet committed Feb 21, 2024
1 parent c1bb5fd commit e6311d9
Showing 1 changed file with 20 additions and 3 deletions.
23 changes: 20 additions & 3 deletions libs/community/langchain_community/document_loaders/astradb.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,6 @@


class AstraDBLoader(BaseLoader):
"""Load DataStax Astra DB documents."""

def __init__(
self,
collection_name: str,
Expand All @@ -42,6 +40,26 @@ def __init__(
nb_prefetched: int = 1000,
extraction_function: Callable[[Dict], str] = json.dumps,
) -> None:
"""Load DataStax Astra DB documents.
Args:
collection_name: name of the Astra DB collection to use.
token: API token for Astra DB usage.
api_endpoint: full URL to the API endpoint,
such as `https://<DB-ID>-us-east1.apps.astra.datastax.com`.
astra_db_client: *alternative to token+api_endpoint*,
you can pass an already-created 'astrapy.db.AstraDB' instance.
async_astra_db_client: *alternative to token+api_endpoint*,
you can pass an already-created 'astrapy.db.AsyncAstraDB' instance.
namespace: namespace (aka keyspace) where the
collection is. Defaults to the database's "default namespace".
filter_criteria: Criteria to filter documents.
projection: Specifies the fields to return.
find_options: Additional options for the query.
nb_prefetched: Max number of documents to pre-fetch. Defaults to 1000.
extraction_function: Function applied to collection documents to create
the `page_content` of the LangChain Document. Defaults to `json.dumps`.
"""
astra_env = _AstraDBEnvironment(
token=token,
api_endpoint=api_endpoint,
Expand All @@ -59,7 +77,6 @@ def __init__(
self.extraction_function = extraction_function

def load(self) -> List[Document]:
"""Eagerly load the content."""
return list(self.lazy_load())

def lazy_load(self) -> Iterator[Document]:
Expand Down

0 comments on commit e6311d9

Please sign in to comment.