langchain_astradb.document_loaders.AstraDBLoader

class langchain_astradb.document_loaders.AstraDBLoader(collection_name: str, *, token: ~typing.Optional[~typing.Union[str, ~astrapy.authentication.TokenProvider]] = None, api_endpoint: ~typing.Optional[str] = None, environment: ~typing.Optional[str] = None, astra_db_client: ~typing.Optional[~astrapy.core.db.AstraDB] = None, async_astra_db_client: ~typing.Optional[~astrapy.core.db.AsyncAstraDB] = None, namespace: ~typing.Optional[str] = None, filter_criteria: ~typing.Optional[~typing.Dict[str, ~typing.Any]] = None, projection: ~typing.Optional[~typing.Dict[str, ~typing.Any]] = <object object>, find_options: ~typing.Optional[~typing.Dict[str, ~typing.Any]] = None, limit: ~typing.Optional[int] = None, nb_prefetched: int = <object object>, page_content_mapper: ~typing.Callable[[~typing.Dict], str] = <function dumps>, metadata_mapper: ~typing.Optional[~typing.Callable[[~typing.Dict], ~typing.Dict[str, ~typing.Any]]] = None)[source]

加载数据Stax Astra DB文档。

参数

  • collection_name (str) – 要使用的Astra DB集合名称。

  • token (可选[Union[str, TokenProvider]]) – 用于Astra DB的API令牌，可以是字符串形式或cite>astrapy.authentication.TokenProvider的子类。如果不提供，将检查环境变量ASTRA_DB_APPLICATION_TOKEN。

  • api_endpoint (可选[str]) – API端点的完整URL，例如https://<DB-ID>-us-east1.apps.astra.datastax.com。如果不提供，将检查环境变量ASTRA_DB_API_ENDPOINT。

  • environment (可选[str]) – 目标数据API的环境字符串。如果省略，则默认为“prod”（Astra DB生产环境）。其他值在astrapy.constants.Environment枚举类中。

  • astra_db_client (可选[AstraDB]) – 从版本0.3.5开始已弃用。请使用“token”，“api_endpoint”和可选项“environment”。可以传递已创建的astrapy.db.AstraDB实例（作为“token”，“api_endpoint”和“environment”的替代）。

  • async_astra_db_client (可选[AsyncAstraDB]) – 从版本0.3.5开始已弃用。请使用“token”，“api_endpoint”和可选项“environment”。可以传递已创建的astrapy.db.AsyncAstraDB实例（作为“token”，“api_endpoint”和“environment”的替代）。

  • namespace (可选[str]) – 集合所在命名空间（即键空间）。如果未提供，将检查环境变量ASTRA_DB_KEYSPACE。默认为数据库的“默认命名空间”。

  • filter_criteria (可选[Dict[str, Any]]) – 过滤文档的条件。

  • 投影 (可选[字典[str, Any]]) – 指定要返回的字段。如果未提供，读取会回退到数据API的默认投影。

  • find_options (可选[字典[str, Any]]) – 查询的附加选项。已弃用，从版本0.3.5开始。 限制请使用`limit`。其他选项将被忽略。

  • limit (可选[int]) – 读取查询返回的最大文档数。

  • nb_prefetched (int) – 最大预取文档数。从v. 0.3.5开始忽略：astrapy v1.0+ 不支持它。

  • page_content_mapper (可调用[[字典], str]) – 应用到集合文档的函数，以创建LangChain文档的 page_content。默认为 json.dumps。

  • metadata_mapper (可选[可调用[[字典], 字典[str, Any]]]) –

方法

__init__(collection_name, *[, token, ...])

加载数据Stax Astra DB文档。

alazy_load()

文档的延迟加载器。

aload()

将数据加载到文档对象中。

lazy_load()

文档的延迟加载器。

load()

将数据加载到文档对象中。

load_and_split([text_splitter])

加载文档并将它们拆分为块。
__init__(collection_name: str, *, token: ~typing.Optional[~typing.Union[str, ~astrapy.authentication.TokenProvider]] = None, api_endpoint: ~typing.Optional[str] = None, environment: ~typing.Optional[str] = None, astra_db_client: ~typing.Optional[~astrapy.core.db.AstraDB] = None, async_astra_db_client: ~typing.Optional[~astrapy.core.db.AsyncAstraDB] = None, namespace: ~typing.Optional[str] = None, filter_criteria: ~typing.Optional[~typing.Dict[str, ~typing.Any]] = None, projection: ~typing.Optional[~typing.Dict[str, ~typing.Any]] = <object object>, find_options: ~typing.Optional[~typing.Dict[str, ~typing.Any]] = None, limit: ~typing.Optional[int] = None, nb_prefetched: int = <object object>, page_content_mapper: ~typing.Callable[[~typing.Dict], str] = <function dumps>, metadata_mapper: ~typing.Optional[~typing.Callable[[~typing.Dict], ~typing.Dict[str, ~typing.Any]]] = None) → None[source]

加载数据Stax Astra DB文档。

参数

  • collection_name (str) – 要使用的Astra DB集合名称。

  • token (可选[Union[str, TokenProvider]]) – 用于Astra DB的API令牌，可以是字符串形式或cite>astrapy.authentication.TokenProvider的子类。如果不提供，将检查环境变量ASTRA_DB_APPLICATION_TOKEN。

  • api_endpoint (可选[str]) – API端点的完整URL，例如https://<DB-ID>-us-east1.apps.astra.datastax.com。如果不提供，将检查环境变量ASTRA_DB_API_ENDPOINT。

  • environment (可选[str]) – 目标数据API的环境字符串。如果省略，则默认为“prod”（Astra DB生产环境）。其他值在astrapy.constants.Environment枚举类中。

  • astra_db_client (可选[AstraDB]) – 已弃用，从版本0.3.5开始。 请使用‘token’、‘api_endpoint’和可选的‘environment’。可以传递已创建的‘astrapy.db.AstraDB’实例（作为‘token’、‘api_endpoint’和‘environment’的替代）。

  • async_astra_db_client (可选[AsyncAstraDB]) – 从版本0.3.5开始已弃用。请使用“token”，“api_endpoint”和可选项“environment”。可以传递已创建的astrapy.db.AsyncAstraDB实例（作为“token”，“api_endpoint”和“environment”的替代）。

  • namespace (可选[str]) – 集合所在命名空间（即键空间）。如果未提供，将检查环境变量ASTRA_DB_KEYSPACE。默认为数据库的“默认命名空间”。

  • filter_criteria (可选[Dict[str, Any]]) – 过滤文档的条件。

  • 投影 (可选[字典[str, Any]]) – 指定要返回的字段。如果未提供，读取会回退到数据API的默认投影。

  • find_options (可选[字典[str, Any]]) – 查询的附加选项。已弃用，从版本0.3.5开始。 限制请使用`limit`。其他选项将被忽略。

  • limit (可选[int]) – 读取查询返回的最大文档数。

  • nb_prefetched (int) – 最大预取文档数。从v. 0.3.5开始忽略：astrapy v1.0+ 不支持它。

  • page_content_mapper (可调用[[字典], str]) – 应用到集合文档的函数，以创建LangChain文档的 page_content。默认为 json.dumps。

  • metadata_mapper (可选[可调用[[字典], 字典[str, Any]]]) –

返回类型

None

async alazy_load() → AsyncIterator[Document][source]

文档的延迟加载器。

返回类型

AsyncIterator[Document]

async aload() → List[Document][source]

将数据加载到文档对象中。

返回类型

List[Document]

lazy_load() → Iterator[Document][source]

文档的延迟加载器。

返回类型

Iterator[Document]

load() → List[Document]

将数据加载到文档对象中。

返回类型

List[Document]

load_and_split(text_splitter: Optional[TextSplitter] = None) → List[Document]

加载文档并将它们拆分为块。块作为Document返回。

不要重写此方法。应将其视为已弃用！

参数

text_splitter (可选[TextSplitter]) – 用于分割文档的TextSplitter实例。默认为RecursiveCharacterTextSplitter。

返回

文档列表。

返回类型

列表[Document]

使用AstraDBLoader的示例