llama-index-readers-openapi


Namellama-index-readers-openapi JSON
Version 0.2.0 PyPI version JSON
download
home_pageNone
Summaryllama-index readers openapi integration
upload_time2024-08-22 06:43:59
maintainerNone
docs_urlNone
authorYour Name
requires_python<4.0,>=3.8.1
licenseMIT
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # LlamaIndex Readers Integration: Open API Specification

This module provides a reader for Open API Specification (OAS) JSON files. The reader is able to parse OAS files and split them at into atomic elements, such as paths, operations, parameters, etc.

It also provides some basic customizations to the reader such as changing the depth of the split, and the ability to exclude certain elements.

## Usage

```python
from llama_index.readers.openapi import OpenAPIReader

openapi_reader = OpenAPIReader(discard=["info", "servers"])
openapi_reader.load_data("path/to/openapi.json")
```

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "llama-index-readers-openapi",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<4.0,>=3.8.1",
    "maintainer_email": null,
    "keywords": null,
    "author": "Your Name",
    "author_email": "you@example.com",
    "download_url": "https://files.pythonhosted.org/packages/c6/2d/f059df29945e873ee759697987b635b8312e5441864f685b9f4ad0af3be6/llama_index_readers_openapi-0.2.0.tar.gz",
    "platform": null,
    "description": "# LlamaIndex Readers Integration: Open API Specification\n\nThis module provides a reader for Open API Specification (OAS) JSON files. The reader is able to parse OAS files and split them at into atomic elements, such as paths, operations, parameters, etc.\n\nIt also provides some basic customizations to the reader such as changing the depth of the split, and the ability to exclude certain elements.\n\n## Usage\n\n```python\nfrom llama_index.readers.openapi import OpenAPIReader\n\nopenapi_reader = OpenAPIReader(discard=[\"info\", \"servers\"])\nopenapi_reader.load_data(\"path/to/openapi.json\")\n```\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "llama-index readers openapi integration",
    "version": "0.2.0",
    "project_urls": null,
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "0bcf848293fbff2d3236d7271e8d0fe3b73603e08be7f61b3ef501e626f6e90a",
                "md5": "40902aeeb18c0008aa036d6b374c7ff1",
                "sha256": "2381bc974a535c945888e4ad3fe0e8500dabf7f67d35ecec42b4068e0a9157fa"
            },
            "downloads": -1,
            "filename": "llama_index_readers_openapi-0.2.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "40902aeeb18c0008aa036d6b374c7ff1",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.8.1",
            "size": 3074,
            "upload_time": "2024-08-22T06:43:58",
            "upload_time_iso_8601": "2024-08-22T06:43:58.245215Z",
            "url": "https://files.pythonhosted.org/packages/0b/cf/848293fbff2d3236d7271e8d0fe3b73603e08be7f61b3ef501e626f6e90a/llama_index_readers_openapi-0.2.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "c62df059df29945e873ee759697987b635b8312e5441864f685b9f4ad0af3be6",
                "md5": "df53112877cc4e10a7fd3196fb0af042",
                "sha256": "0ec786642a8ef3c3eed5192c07bfbdea0eccfdda71b1a1deb9955d99377a1021"
            },
            "downloads": -1,
            "filename": "llama_index_readers_openapi-0.2.0.tar.gz",
            "has_sig": false,
            "md5_digest": "df53112877cc4e10a7fd3196fb0af042",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.8.1",
            "size": 2671,
            "upload_time": "2024-08-22T06:43:59",
            "upload_time_iso_8601": "2024-08-22T06:43:59.635023Z",
            "url": "https://files.pythonhosted.org/packages/c6/2d/f059df29945e873ee759697987b635b8312e5441864f685b9f4ad0af3be6/llama_index_readers_openapi-0.2.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-08-22 06:43:59",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "llama-index-readers-openapi"
}
        
Elapsed time: 0.31125s