llama-index

1
from typing import Optional, Type
2

3
from llama_index.legacy.download.module import (
4
    LLAMA_HUB_URL,
5
    MODULE_TYPE,
6
    download_llama_module,
7
    track_download,
8
)
9
from llama_index.legacy.llama_pack.base import BaseLlamaPack
10

11

12
def download_llama_pack(
13
    llama_pack_class: str,
14
    download_dir: str,
15
    llama_hub_url: str = LLAMA_HUB_URL,
16
    refresh_cache: bool = True,
17
    skip_load: bool = False,
18
) -> Optional[Type[BaseLlamaPack]]:
19
    """Download a single LlamaPack from Llama Hub.
20

21
    Args:
22
        llama_pack_class: The name of the LlamaPack class you want to download,
23
            such as `GmailOpenAIAgentPack`.
24
        refresh_cache: If true, the local cache will be skipped and the
25
            loader will be fetched directly from the remote repo.
26
        download_dir: Custom dirpath to download the pack into.
27

28
    Returns:
29
        A Loader.
30
    """
31
    pack_cls = download_llama_module(
32
        llama_pack_class,
33
        llama_hub_url=llama_hub_url,
34
        refresh_cache=refresh_cache,
35
        custom_path=download_dir,
36
        library_path="llama_packs/library.json",
37
        disable_library_cache=True,
38
        override_path=True,
39
        skip_load=skip_load,
40
    )
41
    track_download(llama_pack_class, MODULE_TYPE.LLAMAPACK)
42
    if pack_cls is None:
43
        return None
44

45
    if not issubclass(pack_cls, BaseLlamaPack):
46
        raise ValueError(f"Tool class {pack_cls} must be a subclass of BaseToolSpec.")
47
    return pack_cls
48