QuipLoader#
- class langchain_community.document_loaders.quip.QuipLoader(api_url: str, access_token: str, request_timeout: int | None = 60, *, allow_dangerous_xml_parsing: bool = False)[来源]#
加载 Quip 页面。
端口来自 quip/quip-api
- Parameters:
api_url (str) – https://platform.quip.com
access_token (str) – 访问quip API的token。请参考: https://quip.com/dev/automation/documentation/current#section/Authentication/Get-Access-to-Quip’s-APIs
request_timeout (int | None) – 请求超时时间,默认为60秒。
allow_dangerous_xml_parsing (bool) – 允许危险的XML解析,默认为False
方法
__init__
(api_url, access_token[, ...])一个用于文档的懒加载器。
aload
()将数据加载到Document对象中。
get_thread_ids_by_folder_id
(folder_id, ...)通过文件夹ID获取线程ID并更新thread_ids
一个用于文档的懒加载器。
load
([folder_ids, thread_ids, max_docs, ...]):param : param folder_ids: 要加载的特定文件夹ID列表,默认为None :param : param thread_ids: 要加载的特定线程ID列表,默认为None :param : param max_docs: 总共要检索的最大文档数,默认为1000 :param : param include_all_folders: 包括您的access_token可以访问的所有文件夹,但不包括您的私人文件夹 :param : param include_comments: 包括评论,默认为False :param : param include_images: 包括图片,默认为False
load_and_split
([text_splitter])加载文档并将其分割成块。
process_thread
(thread_id, include_images, ...)process_thread_images
(tree)process_thread_messages
(thread_id)process_threads
(thread_ids, include_images, ...)将一系列线程处理成一系列文档。
- __init__(api_url: str, access_token: str, request_timeout: int | None = 60, *, allow_dangerous_xml_parsing: bool = False)[source]#
- Parameters:
api_url (str) – https://platform.quip.com
access_token (str) – 访问quip API的token。请参考: https://quip.com/dev/automation/documentation/current#section/Authentication/Get-Access-to-Quip’s-APIs
request_timeout (int | None) – 请求超时时间,默认为60秒。
allow_dangerous_xml_parsing (bool) – 允许危险的XML解析,默认为False
- get_thread_ids_by_folder_id(folder_id: str, depth: int, thread_ids: List[str]) None [source]#
通过文件夹ID获取线程ID并更新到thread_ids中
- Parameters:
folder_id (str)
深度 (整数)
thread_ids (列表[字符串])
- Return type:
无
- load(folder_ids: List[str] | None = None, thread_ids: List[str] | None = None, max_docs: int | None = 1000, include_all_folders: bool = False, include_comments: bool = False, include_images: bool = False) List[Document] [来源]#
:param : param folder_ids: 要加载的特定文件夹ID列表,默认为None :param : param thread_ids: 要加载的特定线程ID列表,默认为None :param : param max_docs: 总共要检索的最大文档数,默认为1000 :param : param include_all_folders: 包括您的access_token有权访问的所有文件夹
可以访问,但不包括您的私人文件夹
:param : param include_comments: 包含评论,默认为 False :param : param include_images: 包含图片,默认为 False
- Parameters:
folder_ids (列表[字符串] | 无)
thread_ids (列表[字符串] | 无)
max_docs (int | None)
include_all_folders (bool)
include_comments (bool)
include_images (bool)
- Return type:
列表[文档]
- load_and_split(text_splitter: TextSplitter | None = None) list[Document] #
加载文档并将其分割成块。块以文档形式返回。
不要重写此方法。它应该被视为已弃用!
- Parameters:
text_splitter (可选[TextSplitter]) – 用于分割文档的TextSplitter实例。 默认为RecursiveCharacterTextSplitter。
- Returns:
文档列表。
- Return type:
列表[Document]
使用 QuipLoader 的示例