Metadata-Version: 2.1
Name: llama-index-readers-weaviate
Version: 0.2.0
Summary: llama-index readers weaviate integration
License: MIT
Author: Your Name
Author-email: you@example.com
Maintainer: jerryjliu
Requires-Python: >=3.8.1,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: llama-index-core (>=0.11.0,<0.12.0)
Requires-Dist: weaviate-client (>=3.26.2,<4.0.0)
Description-Content-Type: text/markdown

# LlamaIndex Readers Integration: Weaviate

## Overview

The Weaviate Reader retrieves documents from Weaviate through vector lookup. It allows you to specify a class name and properties to retrieve from documents, or to provide a custom GraphQL query. You can choose to receive separate Document objects per document or concatenate retrieved documents into one Document.

### Installation

You can install the Weaviate Reader via pip:

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

### Usage

```python
from llama_index.readers.weaviate import WeaviateReader

# Initialize WeaviateReader with host and optional authentication
reader = WeaviateReader(
    host="<Weaviate Host>", auth_client_secret="<Authentication Client Secret>"
)

# Load data from Weaviate
documents = reader.load_data(
    class_name="<Class Name>", properties=["property 1", "property 2"]
)
```

You can follow this tutorial to learn more on how to use [Weaviate Reader](https://docs.llamaindex.ai/en/stable/examples/data_connectors/WeaviateDemo/)

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.

