Toggle Menu
Prev Up Next

# `langchain_community.document_loaders.figma`.FigmaFileLoader

class langchain_community.document_loaders.figma.FigmaFileLoader(access_token: str, ids: str, key: str)

  Load Figma file.

  Initialize with access token, ids, and key.

  Parameters

    - access_token (str) – The access token for the Figma REST API.

    - ids (str) – The ids of the Figma file.

    - key (str) – The key for the Figma file

  Methods

  `__init__`(access_token, ids, key) | Initialize with access token, ids, and key.
  `alazy_load`() | A lazy loader for Documents.
  `aload`() | Load data into Document objects.
  `lazy_load`() | A lazy loader for Documents.
  `load`() | Load file
  `load_and_split`([text_splitter]) | Load Documents and split into chunks.

  __init__(access_token: str, ids: str, key: str)

    Initialize with access token, ids, and key.

    Parameters

      - access_token (str) – The access token for the Figma REST API.

      - ids (str) – The ids of the Figma file.

      - key (str) – The key for the Figma file

  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]

  lazy_load() → Iterator[Document]

    A lazy loader for Documents.

    Return type

      Iterator[Document]

  load() → List[Document]

    Load file

    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]

# Examples using FigmaFileLoader

- Figma

- see https://python.langchain.com/en/latest/modules/data_connection/getting_started.html for more details