langchainCommunity.documentLoaders.sharepoint.SharePointLoader

class langchainCommunity.documentLoaders.sharepoint.SharePointLoader[source]

基础:O365BaseLoaderBaseLoader

SharePoint加载。

通过解析和验证从关键字参数输入的数据来创建一个新的模型。

如果输入数据无法解析成有效的模型,则引发ValidationError

参数auth_with_token: bool = False

是否使用令牌进行认证。默认为False。

参数chunk_size: Union[int, str] = 5242880

从服务器每次api调用中检索的字节数。int或‘auto’。

参数document_library_id: str [Required]

要从其加载数据的SharePoint文档库的ID。

参数file_id: Optional[str] = None

需要认证身份的文件的ID。

参数folder_id: Optional[str] = None

要从其中加载数据的文件夹的ID。

参数folder_path: Optional[str] = None

要从其中加载数据的文件夹的路径。

param load_auth: Optional[bool] = False

是否加载授权标识。

param load_extended_metadata: Optional[bool] = False

是否加载扩展元数据。包括大小、所有者和完整路径。

param object_ids: Optional[List[str]] = None

要从其中加载数据的对象ID。

param recursive: bool = False

加载器是否应递归加载子文件夹?

param settings: _O365Settings [Optional]

Office 365 API客户端的设置。

param site_id: Optional[str] = None

用户所在Sharepoint网站的ID,文件位于该网站。

param token_path: Path = PosixPath('/home/runner/.credentials/o365_token.txt')

执行API调用时令牌的路径。

async alazy_load() AsyncIterator[Document]

文档的懒加载器。

返回类型

AsyncIterator[Document]

async aload() List[Document]

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

返回类型

List[Document]

authorized_identities(file_id: str) List[source]

检索给定文件的访问标识(用户/组电子邮件)。:param file_id: 文件的ID。:type file_id: str

返回

一组具有文件访问权限

的组名称(电子邮件地址)。

返回类型

列表

参数

file_id (str) –

get_extended_metadata(file_id: str) dict[source]

检索SharePoint中文件的扩展元数据。今天为止,以下字段在扩展元数据中受支持:- size:源文件的大小。- owner:源文件所有者的显示名称。- full_path:源文件的精美易读路径。:param file_id: 文件的ID。:type file_id: str

返回

包含文件扩展元数据的字典

,包括大小、所有者和完整路径。

返回类型

字典

参数

file_id (str) –

lazy_load() Iterator[Document][source]

懒加载数据。在处理大规模数据时使用此函数。:Yields: Document – 表示解析块文档对象的文档。

返回类型

Iterator[Document]

load() List[Document]

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

返回类型

List[Document]

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

加载数据文档并分割成块。块以文档的形式返回。

不要重写此方法。应将其视为已弃用!

参数

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

返回

文档列表。

返回类型

列表[Document]

SharePointLoader 的示例使用