llama-index-readers-feishu-docs


Namellama-index-readers-feishu-docs JSON
Version 0.1.3 PyPI version JSON
download
home_page
Summaryllama-index readers feishu_docs integration
upload_time2024-02-21 19:50:35
maintainerma-chengcheng
docs_urlNone
authorYour Name
requires_python>=3.8.1,<4.0
licenseMIT
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Feishu Doc Loader

This loader takes in IDs of Feishu Docs and parses their text into `documents`. You can extract a Feishu Doc's ID directly from its URL. For example, the ID of `https://test-csl481dfkgqf.feishu.cn/docx/HIH2dHv21ox9kVxjRuwc1W0jnkf` is `HIH2dHv21ox9kVxjRuwc1W0jnkf`. As a prerequisite, you will need to register with Feishu and build an custom app. See [here](https://open.feishu.cn/document/home/introduction-to-custom-app-development/self-built-application-development-process) for instructions.

## Usage

To use this loader, you simply need to pass in an array of Feishu Doc IDs. The default API endpoints are for Feishu, in order to switch to Lark, we should use `set_lark_domain`.

```python
from llama_index import download_loader

app_id = "cli_slkdjalasdkjasd"
app_secret = "dskLLdkasdjlasdKK"
doc_ids = ["HIH2dHv21ox9kVxjRuwc1W0jnkf"]
FeishuDocsReader = download_loader("FeishuDocsReader")
loader = FeishuDocsReader(app_id, app_secret)
documents = loader.load_data(document_ids=doc_ids)
```

This loader is designed to be used as a way to load data into [LlamaIndex](https://github.com/run-llama/llama_index/tree/main/llama_index) and/or subsequently used as a Tool in a [LangChain](https://github.com/hwchase17/langchain) Agent. See [here](https://github.com/emptycrown/llama-hub/tree/main) for examples.

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "llama-index-readers-feishu-docs",
    "maintainer": "ma-chengcheng",
    "docs_url": null,
    "requires_python": ">=3.8.1,<4.0",
    "maintainer_email": "",
    "keywords": "",
    "author": "Your Name",
    "author_email": "you@example.com",
    "download_url": "https://files.pythonhosted.org/packages/c0/01/beb0a1c2d930e2bee8fffd8a24c29501047b7f6ebe80ce696337a37c203b/llama_index_readers_feishu_docs-0.1.3.tar.gz",
    "platform": null,
    "description": "# Feishu Doc Loader\n\nThis loader takes in IDs of Feishu Docs and parses their text into `documents`. You can extract a Feishu Doc's ID directly from its URL. For example, the ID of `https://test-csl481dfkgqf.feishu.cn/docx/HIH2dHv21ox9kVxjRuwc1W0jnkf` is `HIH2dHv21ox9kVxjRuwc1W0jnkf`. As a prerequisite, you will need to register with Feishu and build an custom app. See [here](https://open.feishu.cn/document/home/introduction-to-custom-app-development/self-built-application-development-process) for instructions.\n\n## Usage\n\nTo use this loader, you simply need to pass in an array of Feishu Doc IDs. The default API endpoints are for Feishu, in order to switch to Lark, we should use `set_lark_domain`.\n\n```python\nfrom llama_index import download_loader\n\napp_id = \"cli_slkdjalasdkjasd\"\napp_secret = \"dskLLdkasdjlasdKK\"\ndoc_ids = [\"HIH2dHv21ox9kVxjRuwc1W0jnkf\"]\nFeishuDocsReader = download_loader(\"FeishuDocsReader\")\nloader = FeishuDocsReader(app_id, app_secret)\ndocuments = loader.load_data(document_ids=doc_ids)\n```\n\nThis loader is designed to be used as a way to load data into [LlamaIndex](https://github.com/run-llama/llama_index/tree/main/llama_index) and/or subsequently used as a Tool in a [LangChain](https://github.com/hwchase17/langchain) Agent. See [here](https://github.com/emptycrown/llama-hub/tree/main) for examples.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "llama-index readers feishu_docs integration",
    "version": "0.1.3",
    "project_urls": null,
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "a1059a677195edd9ac422c7173dd73dac3da08cd7b30dade7237fa3a85f8a57a",
                "md5": "93362994fb9becccc5e2a639126cce0f",
                "sha256": "5416946912f77f6da8c361c3dc5823ed7dabab7a2c38e24a8967b27d6f3e5ef6"
            },
            "downloads": -1,
            "filename": "llama_index_readers_feishu_docs-0.1.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "93362994fb9becccc5e2a639126cce0f",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8.1,<4.0",
            "size": 3781,
            "upload_time": "2024-02-21T19:50:33",
            "upload_time_iso_8601": "2024-02-21T19:50:33.853508Z",
            "url": "https://files.pythonhosted.org/packages/a1/05/9a677195edd9ac422c7173dd73dac3da08cd7b30dade7237fa3a85f8a57a/llama_index_readers_feishu_docs-0.1.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "c001beb0a1c2d930e2bee8fffd8a24c29501047b7f6ebe80ce696337a37c203b",
                "md5": "4eccd6f0d4c4f1abf8af41527b8fc43d",
                "sha256": "768fb6322b3ade343c8eeffbb3fd827cfd19c38253446af2e57401fab21beb4f"
            },
            "downloads": -1,
            "filename": "llama_index_readers_feishu_docs-0.1.3.tar.gz",
            "has_sig": false,
            "md5_digest": "4eccd6f0d4c4f1abf8af41527b8fc43d",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8.1,<4.0",
            "size": 3389,
            "upload_time": "2024-02-21T19:50:35",
            "upload_time_iso_8601": "2024-02-21T19:50:35.584403Z",
            "url": "https://files.pythonhosted.org/packages/c0/01/beb0a1c2d930e2bee8fffd8a24c29501047b7f6ebe80ce696337a37c203b/llama_index_readers_feishu_docs-0.1.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-02-21 19:50:35",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "llama-index-readers-feishu-docs"
}
        
Elapsed time: 0.52060s