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, optional): 您的 OBS 访问密钥（如果 get_token_from_ecs 为 False 且存储桶策略不是公共读取，则为必需）。
“sk” (str, optional): 您的 OBS 秘密密钥（如果 get_token_from_ecs 为 False 且存储桶策略不是公共读取，则为必需）。
“token” (str, optional): 您的安全令牌（在使用临时凭证时为必需）。
“get_token_from_ecs” (bool, optional): 是否从 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”)
Methods
__init__(bucket, endpoint[, config, prefix])使用指定的设置初始化 OBSDirectoryLoader。
一个用于文档的惰性加载器。
aload()将数据加载到文档对象中。
一个用于文档的惰性加载器。
load()加载文档。
load_and_split([text_splitter])加载文档并分割成块。块作为文档返回。
- Parameters
bucket (str) –
endpoint (str) –
config (Optional[dict]) –
prefix (str) –
- __init__(bucket: str, endpoint: str, config: Optional[dict] = None, prefix: str = '')[source]¶
使用指定的设置初始化 OBSDirectoryLoader。
- 参数:
bucket (str): 要使用的 OBS 存储桶的名称。 endpoint (str): 您的 OBS 存储桶的终端节点 URL。 config (dict): 用作连接到 OBS 的参数，以字典形式提供。字典可以包含以下键：
“ak” (str, optional): 您的 OBS 访问密钥（如果 get_token_from_ecs 为 False 且存储桶策略不是公共读取，则为必需）。
“sk” (str, optional): 您的 OBS 秘密密钥（如果 get_token_from_ecs 为 False 且存储桶策略不是公共读取，则为必需）。
“token” (str, optional): 您的安全令牌（在使用临时凭证时为必需）。
“get_token_from_ecs” (bool, optional): 是否从 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”)
- Parameters
bucket (str) –
endpoint (str) –
config (Optional[dict]) –
prefix (str) –
- load_and_split(text_splitter: Optional[TextSplitter] = None) List[Document]¶
加载文档并分割成块。块作为文档返回。
不要覆盖此方法。应该被视为已弃用！
- 参数：
- text_splitter: 用于分割文档的TextSplitter实例。
默认为RecursiveCharacterTextSplitter。
- 返回：
文档列表。
- Parameters
text_splitter (Optional[TextSplitter]) –
- Return type
List[Document]