llama-index-readers-jaguar

Name	llama-index-readers-jaguar JSON
Version	0.2.0 JSON
	download
home_page	None
Summary	llama-index readers jaguar integration
upload_time	2024-08-22 06:23:07
maintainer	None
docs_url	None
author	Your Name
requires_python	<4.0,>=3.8.1
license	MIT
keywords
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # LlamaIndex Readers Integration: Jaguar

## Overview

Jaguar Reader retrieves documents from an existing persisted Jaguar store. These documents can then be used in a downstream LlamaIndex data structure.

### Installation

You can install Jaguar Reader via pip:

```bash
pip install llama-index-readers-jaguar
```

To use Jaguar Reader, you must have an API key. Here are the [installation instructions](http://www.jaguardb.com/docsetup.html)

## Usage

```python
from llama_index.readers.jaguar import JaguarReader

# Initialize JaguarReader
reader = JaguarReader(
    pod="<Pod Name>",
    store="<Store Name>",
    vector_index="<Vector Index Name>",
    vector_type="<Vector Type>",
    vector_dimension="<Vector Dimension>",
    url="<Endpoint URL>",
)

# Login to Jaguar server
reader.login(jaguar_api_key="<Jaguar API Key>")

# Load data from Jaguar
documents = reader.load_data(
    embedding="<Embedding Vector>",
    k=10,
    metadata_fields=["<Metadata Field 1>", "<Metadata Field 2>"],
    where="<Query Condition>",
)

# Logout from Jaguar server
reader.logout()
```

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).

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "llama-index-readers-jaguar",
    "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/03/c2/11dbb9fdc3429e955a0d4102dfb0a8e4a59d46f5ab07b858afcd05c091d1/llama_index_readers_jaguar-0.2.0.tar.gz",
    "platform": null,
    "description": "# LlamaIndex Readers Integration: Jaguar\n\n## Overview\n\nJaguar Reader retrieves documents from an existing persisted Jaguar store. These documents can then be used in a downstream LlamaIndex data structure.\n\n### Installation\n\nYou can install Jaguar Reader via pip:\n\n```bash\npip install llama-index-readers-jaguar\n```\n\nTo use Jaguar Reader, you must have an API key. Here are the [installation instructions](http://www.jaguardb.com/docsetup.html)\n\n## Usage\n\n```python\nfrom llama_index.readers.jaguar import JaguarReader\n\n# Initialize JaguarReader\nreader = JaguarReader(\n    pod=\"<Pod Name>\",\n    store=\"<Store Name>\",\n    vector_index=\"<Vector Index Name>\",\n    vector_type=\"<Vector Type>\",\n    vector_dimension=\"<Vector Dimension>\",\n    url=\"<Endpoint URL>\",\n)\n\n# Login to Jaguar server\nreader.login(jaguar_api_key=\"<Jaguar API Key>\")\n\n# Load data from Jaguar\ndocuments = reader.load_data(\n    embedding=\"<Embedding Vector>\",\n    k=10,\n    metadata_fields=[\"<Metadata Field 1>\", \"<Metadata Field 2>\"],\n    where=\"<Query Condition>\",\n)\n\n# Logout from Jaguar server\nreader.logout()\n```\n\nThis loader is designed to be used as a way to load data into\n[LlamaIndex](https://github.com/run-llama/llama_index/tree/main/llama_index).\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "llama-index readers jaguar integration",
    "version": "0.2.0",
    "project_urls": null,
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "e6f501865c42c4c7c8d1d7751d08e6538372c34146da45951a367e6a862f55f6",
                "md5": "acc993a85fa5052e360ec03d51f46eed",
                "sha256": "882baca2f1b75fa1233dccd4ed3d6b241fce3a1bb39a69218417f40455735d71"
            },
            "downloads": -1,
            "filename": "llama_index_readers_jaguar-0.2.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "acc993a85fa5052e360ec03d51f46eed",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.8.1",
            "size": 4052,
            "upload_time": "2024-08-22T06:23:05",
            "upload_time_iso_8601": "2024-08-22T06:23:05.236742Z",
            "url": "https://files.pythonhosted.org/packages/e6/f5/01865c42c4c7c8d1d7751d08e6538372c34146da45951a367e6a862f55f6/llama_index_readers_jaguar-0.2.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "03c211dbb9fdc3429e955a0d4102dfb0a8e4a59d46f5ab07b858afcd05c091d1",
                "md5": "73e3ac9ee9ce492019dc8c8ce72482ed",
                "sha256": "fe126f0b540e9d3c64b7e113d3dba09ebb1a42a7dbeb9edc5921bc3c210edb52"
            },
            "downloads": -1,
            "filename": "llama_index_readers_jaguar-0.2.0.tar.gz",
            "has_sig": false,
            "md5_digest": "73e3ac9ee9ce492019dc8c8ce72482ed",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.8.1",
            "size": 3782,
            "upload_time": "2024-08-22T06:23:07",
            "upload_time_iso_8601": "2024-08-22T06:23:07.478571Z",
            "url": "https://files.pythonhosted.org/packages/03/c2/11dbb9fdc3429e955a0d4102dfb0a8e4a59d46f5ab07b858afcd05c091d1/llama_index_readers_jaguar-0.2.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-08-22 06:23:07",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "llama-index-readers-jaguar"
}