langchain_community.document_loaders.obs_directory.OBSDirectoryLoader

class langchain_community.document_loaders.obs_directory.OBSDirectoryLoader(bucket: str, endpoint: str, config: Optional[dict] = None, prefix: str = '')[source]

从华为OBS目录加载数据。

使用指定的设置初始化OBSDirectoryLoader。

参数
  • bucket (str) – 要使用的OBS桶的名称。

  • endpoint (str) – 您OBS桶的端点URL。

  • config (dict) – 连接到OBS的参数,作为字典提供。该字典可以包含以下键:- “ak” (str, 可选):您的OBS访问密钥(如果get_token_from_ecs为False且桶策略不是公共读取,则必须提供)。- “sk” (str, 可选):您的OBS密钥(如果get_token_from_ecs为False且桶策略不是公共读取,则必须提供)。- “token” (str, 可选):您的安全令牌(如果使用临时凭证,则必须提供)。- “get_token_from_ecs” (bool, 可选):是否从ECS检索安全令牌。如果未提供,默认为False。如果设置为True,则忽略aksktoken

  • prefix (str可选) – 要添加到OBS键的前缀。默认为“”。

注意

在使用此类之前,请确保您已注册OBS并具有必要的凭据。除非get_token_from_ecs为True或桶策略是公共读取,否则必须提供akskendpoint值。在使用临时凭证时,需要提供token

示例

创建一个新的OBSDirectoryLoader: ``` config = {

“ak”: “your-access-key”, “sk”: “your-secret-key”

}

directory_loader = OBSDirectoryLoader(“your-bucket-name”, “your-end-endpoint”, config, “your-prefix”)

方法

__init__(bucket, endpoint[, config, prefix])

使用指定的设置初始化OBSDirectoryLoader。

alazy_load()

文档的懒加载器。

aload()

将数据加载到Document对象中。

lazy_load()

文档的懒加载器。

load()

加载文档。

load_and_split([text_splitter])

加载文档并分成块。

__init__(bucket: str, endpoint: str, config: Optional[dict] = None, prefix: str = '')[源代码]

使用指定的设置初始化OBSDirectoryLoader。

参数
  • bucket (str) – 要使用的OBS桶的名称。

  • endpoint (str) – 您OBS桶的端点URL。

  • config (dict) – 连接到OBS的参数,作为字典提供。该字典可以包含以下键:- “ak” (str, 可选):您的OBS访问密钥(如果get_token_from_ecs为False且桶策略不是公共读取,则必须提供)。- “sk” (str, 可选):您的OBS密钥(如果get_token_from_ecs为False且桶策略不是公共读取,则必须提供)。- “token” (str, 可选):您的安全令牌(如果使用临时凭证,则必须提供)。- “get_token_from_ecs” (bool, 可选):是否从ECS检索安全令牌。如果未提供,默认为False。如果设置为True,则忽略aksktoken

  • prefix (str可选) – 要添加到OBS键的前缀。默认为“”。

注意

在使用此类之前,请确保您已注册OBS并具有必要的凭据。除非get_token_from_ecs为True或桶策略是公共读取,否则必须提供akskendpoint值。在使用临时凭证时,需要提供token

示例

创建一个新的OBSDirectoryLoader: ```config = !!}`

“ak”: “your-access-key”, “sk”: “your-secret-key”

}`

directory_loader = OBSDirectoryLoader(“your-bucket-name”, “your-end-endpoint”, config, “your-prefix”)

asyncalazy_load() AsyncIterator[Document]

文档的懒加载器。

返回类型

AsyncIterator[Document]

asyncaload() List[Document]

将数据加载到Document对象中。

返回类型

列表[Document]

lazy_load() Iterator[Document]

文档的懒加载器。

返回类型

迭代器[Document]

load() List[Document][源代码]

加载文档。

返回类型

列表[Document]

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

加载数据文档并将其分割为数据块。数据块以文档列表的形式返回。

不要重写此方法。应考虑其已弃用!

参数

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

返回

文档列表。

返回类型

列表[Document]

使用 OBSDirectoryLoader 的示例