OBS目录加载器#
- class langchain_community.document_loaders.obs_directory.OBSDirectoryLoader(bucket: str, endpoint: str, config: dict | None = None, prefix: str = '')[来源]#
从华为OBS目录加载。
使用指定的设置初始化OBSDirectoryLoader。
- Parameters:
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,ak、sk和token将被忽略。
prefix (str, optional) – 要添加到OBS键的前缀。默认为“”。
注意
在使用此类之前,请确保您已注册OBS并拥有必要的凭证。除非get_token_from_ecs为True或存储桶策略为公共读取,否则ak、sk和endpoint值是必需的。使用临时凭证时,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。
一个用于文档的懒加载器。
aload
()将数据加载到Document对象中。
一个用于文档的懒加载器。
load
()加载文档。
load_and_split
([text_splitter])加载文档并将其分割成块。
- __init__(bucket: str, endpoint: str, config: dict | None = None, prefix: str = '')[来源]#
使用指定的设置初始化OBSDirectoryLoader。
- Parameters:
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,ak、sk和token将被忽略。
prefix (str, optional) – 要添加到OBS键的前缀。默认为“”。
注意
在使用此类之前,请确保您已注册OBS并拥有必要的凭证。除非get_token_from_ecs为True或存储桶策略为公共读取,否则ak、sk和endpoint值是必需的。使用临时凭证时,token是必需的。
示例
要创建一个新的OBSDirectoryLoader: ``` config = {
“ak”: “your-access-key”, “sk”: “your-secret-key”
}#
directory_loader = OBSDirectoryLoader(“your-bucket-name”, “your-end-endpoint”, config, “your-prefix”)
- load_and_split(text_splitter: TextSplitter | None = None) list[Document] #
加载文档并将其分割成块。块以文档形式返回。
不要重写此方法。它应该被视为已弃用!
- Parameters:
text_splitter (可选[TextSplitter]) – 用于分割文档的TextSplitter实例。 默认为RecursiveCharacterTextSplitter。
- Returns:
文档列表。
- Return type:
列表[Document]
使用 OBSDirectoryLoader 的示例