llama-index-readers-stripe-docs


Namellama-index-readers-stripe-docs JSON
Version 0.3.0 PyPI version JSON
download
home_pageNone
Summaryllama-index readers stripe_docs integration
upload_time2024-11-18 01:01:09
maintaineramorriscode
docs_urlNone
authorYour Name
requires_python<4.0,>=3.9
licenseMIT
keywords documentation stripe
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # StripeDocs Loader

```bash
pip install llama-index-readers-stripe-docs
```

This loader asynchronously loads data from the [Stripe documentation](https://stripe.com/docs). It iterates through the Stripe sitemap to get all `/docs` references.

It is based on the [Async Website Loader](https://llamahub.ai/l/web-async_web).

## Usage

```python
from llama_index.core import VectorStoreIndex
from llama_index.readers.stripe_docs import StripeDocsReader

loader = StripeDocsReader()
documents = loader.load_data()

index = VectorStoreIndex.from_documents(documents)

query_engine = index.as_query_engine()
query_engine.query("How do I accept payments on my website?")
```

The `StripeDocsReader` allows you to return plain text docs by setting `html_to_text=True`. You can also adjust the maximum concurrent requests by setting `limit=10`.

## Filtering

You can filter pages from the Stripe sitemap by adding the _filters_ argument to the load_data method. This allows you to control what pages from the Stripe website, including documentation, will be loaded.

The default filters are set to `["/docs"]` to scope everything to docs only.

```python
documents = loader.load_data(filters=["/terminal"])
```

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "llama-index-readers-stripe-docs",
    "maintainer": "amorriscode",
    "docs_url": null,
    "requires_python": "<4.0,>=3.9",
    "maintainer_email": null,
    "keywords": "documentation, stripe",
    "author": "Your Name",
    "author_email": "you@example.com",
    "download_url": "https://files.pythonhosted.org/packages/8b/ba/4e3aba9936e55c6087c2818428e20db058bbfcedab50c10ac3eb21e74b19/llama_index_readers_stripe_docs-0.3.0.tar.gz",
    "platform": null,
    "description": "# StripeDocs Loader\n\n```bash\npip install llama-index-readers-stripe-docs\n```\n\nThis loader asynchronously loads data from the [Stripe documentation](https://stripe.com/docs). It iterates through the Stripe sitemap to get all `/docs` references.\n\nIt is based on the [Async Website Loader](https://llamahub.ai/l/web-async_web).\n\n## Usage\n\n```python\nfrom llama_index.core import VectorStoreIndex\nfrom llama_index.readers.stripe_docs import StripeDocsReader\n\nloader = StripeDocsReader()\ndocuments = loader.load_data()\n\nindex = VectorStoreIndex.from_documents(documents)\n\nquery_engine = index.as_query_engine()\nquery_engine.query(\"How do I accept payments on my website?\")\n```\n\nThe `StripeDocsReader` allows you to return plain text docs by setting `html_to_text=True`. You can also adjust the maximum concurrent requests by setting `limit=10`.\n\n## Filtering\n\nYou can filter pages from the Stripe sitemap by adding the _filters_ argument to the load_data method. This allows you to control what pages from the Stripe website, including documentation, will be loaded.\n\nThe default filters are set to `[\"/docs\"]` to scope everything to docs only.\n\n```python\ndocuments = loader.load_data(filters=[\"/terminal\"])\n```\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "llama-index readers stripe_docs integration",
    "version": "0.3.0",
    "project_urls": null,
    "split_keywords": [
        "documentation",
        " stripe"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "83ed7b16a53b9998a6946e2a6f1946e3b10ebe329cc3486a9a68fc0a4cda448b",
                "md5": "e29a55a0fcf1c62e42c7a449a5ddcd06",
                "sha256": "fe25ea8d59941e9a6048451594a6d3b23ec2dffcbec69f4704e7b3f635771d31"
            },
            "downloads": -1,
            "filename": "llama_index_readers_stripe_docs-0.3.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "e29a55a0fcf1c62e42c7a449a5ddcd06",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.9",
            "size": 3072,
            "upload_time": "2024-11-18T01:01:08",
            "upload_time_iso_8601": "2024-11-18T01:01:08.064251Z",
            "url": "https://files.pythonhosted.org/packages/83/ed/7b16a53b9998a6946e2a6f1946e3b10ebe329cc3486a9a68fc0a4cda448b/llama_index_readers_stripe_docs-0.3.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "8bba4e3aba9936e55c6087c2818428e20db058bbfcedab50c10ac3eb21e74b19",
                "md5": "7596bccd0f6ca41dd1f77f5d019cd5a9",
                "sha256": "b310420c643bdbba92bd6cde898d7dfdf86cbf85a121aa3da8e8d335d0caae61"
            },
            "downloads": -1,
            "filename": "llama_index_readers_stripe_docs-0.3.0.tar.gz",
            "has_sig": false,
            "md5_digest": "7596bccd0f6ca41dd1f77f5d019cd5a9",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.9",
            "size": 2786,
            "upload_time": "2024-11-18T01:01:09",
            "upload_time_iso_8601": "2024-11-18T01:01:09.364677Z",
            "url": "https://files.pythonhosted.org/packages/8b/ba/4e3aba9936e55c6087c2818428e20db058bbfcedab50c10ac3eb21e74b19/llama_index_readers_stripe_docs-0.3.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-11-18 01:01:09",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "llama-index-readers-stripe-docs"
}
        
Elapsed time: 0.56420s