Toggle Menu
Prev Up Next

# `langchain_community.document_loaders.quip`.QuipLoader

class langchain_community.document_loaders.quip.QuipLoader(api_url: str, access_token: str, request_timeout: Optional[int] = 60)

  Load Quip pages.

  Port of https://github.com/quip/quip-api/tree/master/samples/baqup

  Parameters

    - api_url (str) – https://platform.quip.com

    - access_token (str) – token of access quip API. Please refer:

    - https – //quip.com/dev/automation/documentation/current#section/Authentication/Get-Access-to-Quip’s-APIs

    - request_timeout (Optional[int]) – timeout of request, default 60s.

  Methods

  `__init__`(api_url, access_token[, ...]) | param api_url https://platform.quip.com
  `alazy_load`() | A lazy loader for Documents.
  `aload`() | Load data into Document objects.
  `get_thread_ids_by_folder_id`(folder_id, ...) | Get thread ids by folder id and update in thread_ids
  `lazy_load`() | A lazy loader for Documents.
  `load`([folder_ids, thread_ids, max_docs, ...]) | :param : param folder_ids: List of specific folder IDs to load, defaults to None :param : param thread_ids: List of specific thread IDs to load, defaults to None :param : param max_docs: Maximum number of docs to retrieve in total, defaults 1000 :param : param include_all_folders: Include all folders that your access_token can access, but doesn't include your private folder :param : param include_comments: Include comments, defaults to False :param : param include_images: Include images, defaults to False
  `load_and_split`([text_splitter]) | Load Documents and split into chunks.
  `process_thread`(thread_id, include_images, ...) |
  `process_thread_images`(tree) |
  `process_thread_messages`(thread_id) |
  `process_threads`(thread_ids, include_images, ...) | Process a list of thread into a list of documents.

  __init__(api_url: str, access_token: str, request_timeout: Optional[int] = 60)
    Parameters

      - api_url (str) – https://platform.quip.com

      - access_token (str) – token of access quip API. Please refer:

      - https – //quip.com/dev/automation/documentation/current#section/Authentication/Get-Access-to-Quip’s-APIs

      - request_timeout (Optional[int]) – timeout of request, default 60s.

  async alazy_load() → AsyncIterator[Document]

    A lazy loader for Documents.

    Return type

      AsyncIterator[Document]

  async aload() → List[Document]

    Load data into Document objects.

    Return type

      List[Document]

  get_thread_ids_by_folder_id(folder_id: str, depth: int, thread_ids: List[str]) → None

    Get thread ids by folder id and update in thread_ids

    Parameters

      - folder_id (str) –

      - depth (int) –

      - thread_ids (List[str]) –

    Return type

      None

  lazy_load() → Iterator[Document]

    A lazy loader for Documents.

    Return type

      Iterator[Document]

  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]

    :param : param folder_ids: List of specific folder IDs to load, defaults to None :param : param thread_ids: List of specific thread IDs to load, defaults to None :param : param max_docs: Maximum number of docs to retrieve in total, defaults 1000 :param : param include_all_folders: Include all folders that your access_token

    > can access, but doesn’t include your private folder

    :param : param include_comments: Include comments, defaults to False :param : param include_images: Include images, defaults to 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]

    Load Documents and split into chunks. Chunks are returned as Documents.

    Do not override this method. It should be considered to be deprecated!

    Parameters

      text_splitter (Optional[TextSplitter]) – TextSplitter instance to use for splitting documents. Defaults to RecursiveCharacterTextSplitter.

    Returns

      List of Documents.

    Return type

      List[Document]

  process_thread(thread_id: str, include_images: bool, include_messages: bool) → Optional[Document]
    Parameters

      - thread_id (str) –

      - include_images (bool) –

      - include_messages (bool) –

    Return type

      Optional[Document]

  process_thread_images(tree: ElementTree) → str
    Parameters

      tree (ElementTree) –

    Return type

      str

  process_thread_messages(thread_id: str) → str
    Parameters

      thread_id (str) –

    Return type

      str

  process_threads(thread_ids: Sequence[str], include_images: bool, include_messages: bool) → List[Document]

    Process a list of thread into a list of documents.

    Parameters

      - thread_ids (Sequence[str]) –

      - include_images (bool) –

      - include_messages (bool) –

    Return type

      List[Document]

# Examples using QuipLoader

- quip.md