langchain_community.document_loaders.athena.AthenaLoader

class langchain_community.document_loaders.athena.AthenaLoader(query: str, database: str, s3_output_uri: str, profile_name: Optional[str] = None, metadata_columns: Optional[List[str]] = None)[源代码]

从 AWS Athena 加载文档。

每个文档代表查询结果中的一行。- 默认情况下，所有列都写入文档的 page_content 中，不写入文档的 metadata。- 如果提供了 metadata_columns，则这些列写入文档的 metadata 中，其余列写入文档的 page_content。

为了认证，AWS 客户端使用此方法自动加载凭证：[https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html](https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html)

如果应使用特定的凭证配置文件，必须从 ~/.aws/credentials 文件中传递要使用的配置文件名。

确保使用的凭证/角色具有访问 Amazon Textract 服务的所需策略。

初始化 Athena 文档加载器。

参数

  • query (str) – 在 Athena 中运行的查询。

  • database (str) – Athena 数据库。

  • s3_output_uri (str) – Athena 输出路径。

  • profile_name (Optional[str]) – 可选。如果在使用配置文件，则 AWS 凭证配置文件。

  • metadata_columns (Optional[List[str]]) – 可选。写入文档 metadata 的列。

方法

__init__(query, database, s3_output_uri[, ...])

初始化 Athena 文档加载器。

alazy_load()

文档的懒加载器。

aload()

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

lazy_load()

文档的懒加载器。

load()

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

load_and_split([text_splitter])

加载文档并将其拆分为块。
__init__(query: str, database: str, s3_output_uri: str, profile_name: Optional[str] = None, metadata_columns: Optional[List[str]] = None)[源代码]

初始化 Athena 文档加载器。

参数

  • query (str) – 在 Athena 中运行的查询。

  • database (str) – Athena 数据库。

  • s3_output_uri (str) – Athena 输出路径。

  • profile_name (Optional[str]) – 可选。如果在使用配置文件，则 AWS 凭证配置文件。

  • metadata_columns (Optional[List[str]]) – 可选。写入文档 metadata 的列。

async alazy_load() → AsyncIterator[Document]

文档的懒加载器。

返回类型

AsyncIterator[Document]

async aload() → List[Document]

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

返回类型

List[Document]

lazy_load() → Iterator[Document][源代码]

文档的懒加载器。

返回类型

Iterator[Document]

load() → List[Document]

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

返回类型

List[Document]

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

加载文档并将其分割成块。块将作为文档返回。

不要重写此方法。应考虑将其废弃！

参数

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

返回值

文档列表。

返回类型

列表[Document]

AthenaLoader 使用实例