langchain_community.document_loaders.quip
.QuipLoader¶
- class langchain_community.document_loaders.quip.QuipLoader(api_url: str, access_token: str, request_timeout: Optional[int] = 60)[source]¶
加载`Quip`页面。
https://github.com/quip/quip-api/tree/master/samples/baqup 的端口。
参数: api_url: https://platform.quip.com access_token: 访问Quip API的令牌。请参考: https://quip.com/dev/automation/documentation/current#section/Authentication/Get-Access-to-Quip’s-APIs request_timeout: 请求超时时间,默认为60秒。
Methods
__init__
(api_url, access_token[, ...])参数: api_url: https://platform.quip.com access_token: 访问Quip API的令牌。请参考: https://quip.com/dev/automation/documentation/current#section/Authentication/Get-Access-to-Quip's-APIs request_timeout: 请求超时时间,默认为60秒。
一个用于文档的惰性加载器。
aload
()将数据加载到文档对象中。
get_thread_ids_by_folder_id
(folder_id, ...)通过文件夹ID获取线程ID,并更新到thread_ids中。
一个用于文档的惰性加载器。
load
([folder_ids, thread_ids, max_docs, ...])参数: :param folder_ids: 要加载的特定文件夹ID列表,默认为None :param thread_ids: 要加载的特定主题ID列表,默认为None :param max_docs: 要在总共检索的文档中检索的最大数量,默认为1000 :param include_all_folders: 包括您的访问令牌可以访问的所有文件夹,但不包括您的私人文件夹 :param include_comments: 包括评论,默认为False :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, ...)将一组线程处理成一组文档。
- Parameters
api_url (str) –
access_token (str) –
request_timeout (Optional[int]) –
- __init__(api_url: str, access_token: str, request_timeout: Optional[int] = 60)[source]¶
参数: api_url: https://platform.quip.com access_token: 访问Quip API的令牌。请参考: https://quip.com/dev/automation/documentation/current#section/Authentication/Get-Access-to-Quip’s-APIs request_timeout: 请求超时时间,默认为60秒。
- Parameters
api_url (str) –
access_token (str) –
request_timeout (Optional[int]) –
- 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) –
depth (int) –
thread_ids (List[str]) –
- Return type
None
- load(folder_ids: Optional[List[str]] = None, thread_ids: Optional[List[str]] = None, max_docs: Optional[int] = 1000, include_all_folders: bool = False, include_comments: bool = False, include_images: bool = False) List[Document] [source]¶
参数: :param folder_ids: 要加载的特定文件夹ID列表,默认为None :param thread_ids: 要加载的特定主题ID列表,默认为None :param max_docs: 要在总共检索的文档中检索的最大数量,默认为1000 :param include_all_folders: 包括您的访问令牌可以访问的所有文件夹,但不包括您的私人文件夹 :param include_comments: 包括评论,默认为False :param include_images: 包括图片,默认为False
- Parameters
folder_ids (Optional[List[str]]) –
thread_ids (Optional[List[str]]) –
max_docs (Optional[int]) –
include_all_folders (bool) –
include_comments (bool) –
include_images (bool) –
- Return type
List[Document]
- load_and_split(text_splitter: Optional[TextSplitter] = None) List[Document] ¶
加载文档并分割成块。块作为文档返回。
不要覆盖此方法。应该被视为已弃用!
- 参数:
- text_splitter: 用于分割文档的TextSplitter实例。
默认为RecursiveCharacterTextSplitter。
- 返回:
文档列表。
- Parameters
text_splitter (Optional[TextSplitter]) –
- Return type
List[Document]
- process_thread(thread_id: str, include_images: bool, include_messages: bool) Optional[Document] [source]¶
- Parameters
thread_id (str) –
include_images (bool) –
include_messages (bool) –
- Return type
Optional[Document]