llama-index-readers-opensearch

Name	llama-index-readers-opensearch JSON
Version	0.2.0 JSON
	download
home_page	None
Summary	llama-index readers opensearch integration
upload_time	2024-08-22 06:45:34
maintainer	chnsagitchen
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.

            # Opensearch Loader

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

The Opensearch Loader returns a set of texts corresponding to documents retrieved from an Opensearch index.
The user initializes the loader with an Opensearch index. They then pass in a field, and optionally a JSON query DSL object to fetch the fields they want.

## Usage

Here's an example usage of the OpensearchReader to load 100 documents.

```python
from llama_index.readers.opensearch import OpensearchReader

reader = OpensearchReader(
    host="localhost",
    port=9200,
    index="<index_name>",
    basic_auth=("<user_name>", "<password>"),
)

query = {"size": 100, "query": {"match_all": {}}}
documents = reader.load_data(
    "<field_name>", query=query, embedding_field="field_name"
)
```

This loader is designed to be used as a way to load data into [LlamaIndex](https://github.com/run-llama/llama_index/).

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "llama-index-readers-opensearch",
    "maintainer": "chnsagitchen",
    "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/02/dc/b693eba997ce55d9ca2178a60114afd0ca3a108c5b029d996fba1664dd67/llama_index_readers_opensearch-0.2.0.tar.gz",
    "platform": null,
    "description": "# Opensearch Loader\n\n```bash\npip install llama-index-readers-opensearch\n```\n\nThe Opensearch Loader returns a set of texts corresponding to documents retrieved from an Opensearch index.\nThe user initializes the loader with an Opensearch index. They then pass in a field, and optionally a JSON query DSL object to fetch the fields they want.\n\n## Usage\n\nHere's an example usage of the OpensearchReader to load 100 documents.\n\n```python\nfrom llama_index.readers.opensearch import OpensearchReader\n\nreader = OpensearchReader(\n    host=\"localhost\",\n    port=9200,\n    index=\"<index_name>\",\n    basic_auth=(\"<user_name>\", \"<password>\"),\n)\n\nquery = {\"size\": 100, \"query\": {\"match_all\": {}}}\ndocuments = reader.load_data(\n    \"<field_name>\", query=query, embedding_field=\"field_name\"\n)\n```\n\nThis loader is designed to be used as a way to load data into [LlamaIndex](https://github.com/run-llama/llama_index/).\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "llama-index readers opensearch integration",
    "version": "0.2.0",
    "project_urls": null,
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "6d179ba8daab8fbdc5ad42db092e599d5ca261c71883ac20e6ba2fd19a11b3e9",
                "md5": "ba9ecf0d7698bc5bc79a8d14b402cd7e",
                "sha256": "bdf2220c6ea242dff4ee64aa5b2a7b4af346a3f599e90d773ddeac8c5e2fd78d"
            },
            "downloads": -1,
            "filename": "llama_index_readers_opensearch-0.2.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "ba9ecf0d7698bc5bc79a8d14b402cd7e",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.8.1",
            "size": 3041,
            "upload_time": "2024-08-22T06:45:33",
            "upload_time_iso_8601": "2024-08-22T06:45:33.926209Z",
            "url": "https://files.pythonhosted.org/packages/6d/17/9ba8daab8fbdc5ad42db092e599d5ca261c71883ac20e6ba2fd19a11b3e9/llama_index_readers_opensearch-0.2.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "02dcb693eba997ce55d9ca2178a60114afd0ca3a108c5b029d996fba1664dd67",
                "md5": "b8fd4965f5c46cf3997ad97c1cefa155",
                "sha256": "ee0e4fbb0073017861ee4794dee7de062f0bb501c70108c3b20420fce0b3cd3c"
            },
            "downloads": -1,
            "filename": "llama_index_readers_opensearch-0.2.0.tar.gz",
            "has_sig": false,
            "md5_digest": "b8fd4965f5c46cf3997ad97c1cefa155",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.8.1",
            "size": 2762,
            "upload_time": "2024-08-22T06:45:34",
            "upload_time_iso_8601": "2024-08-22T06:45:34.868508Z",
            "url": "https://files.pythonhosted.org/packages/02/dc/b693eba997ce55d9ca2178a60114afd0ca3a108c5b029d996fba1664dd67/llama_index_readers_opensearch-0.2.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-08-22 06:45:34",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "llama-index-readers-opensearch"
}