AthenaLoader#

class langchain_community.document_loaders.athena.AthenaLoader(query: str, database: str, s3_output_uri: str, profile_name: str | None = None, metadata_columns: List[str] | None = None)[来源]#

AWS Athena加载文档。

每个文档代表结果的一行。 - 默认情况下,所有列都被写入文档的page_content中, 而没有任何内容被写入文档的metadata中。 - 如果提供了metadata_columns,则这些列被写入 文档的metadata中,而其余的列 被写入文档的page_content中。

为了进行身份验证,AWS客户端使用此方法自动加载凭据: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html

如果应该使用特定的凭证配置文件,您必须传递要使用的来自~/.aws/credentials文件的配置文件的名称。

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

初始化Athena文档加载器。

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

  • database (str) – Athena 数据库。

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

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

  • metadata_columns (可选[列表[字符串]]) – 可选。写入文档metadata的列。

方法

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

初始化Athena文档加载器。

alazy_load()

文档的懒加载器。

aload()

将数据加载到Document对象中。

lazy_load()

一个用于文档的懒加载器。

load()

将数据加载到Document对象中。

load_and_split([text_splitter])

加载文档并将其分割成块。

__init__(query: str, database: str, s3_output_uri: str, profile_name: str | None = None, metadata_columns: List[str] | None = None)[source]#

初始化Athena文档加载器。

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

  • database (str) – Athena 数据库。

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

  • profile_name (str | None) – 可选。如果正在使用配置文件,则为AWS凭证配置文件。

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

async alazy_load() AsyncIterator[Document]#

文档的懒加载器。

Return type:

AsyncIterator[Document]

async aload() list[Document]#

将数据加载到Document对象中。

Return type:

列表[Document]

lazy_load() Iterator[Document][source]#

文档的懒加载器。

Return type:

迭代器[文档]

load() list[Document]#

将数据加载到Document对象中。

Return type:

列表[Document]

load_and_split(text_splitter: TextSplitter | None = None) list[Document]#

加载文档并将其分割成块。块以文档形式返回。

不要重写此方法。它应该被视为已弃用!

Parameters:

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

Returns:

文档列表。

Return type:

列表[Document]

使用AthenaLoader的示例