mirror of
https://github.com/run-llama/llama-hub.git
synced 2025-08-14 11:41:56 +00:00
36 lines
1.2 KiB
Markdown
36 lines
1.2 KiB
Markdown
|
# GraphQL Loader
|
||
|
|
|
||
|
|
This loader loads documents via GraphQL queries from a GraphQL endpoint.
|
||
|
|
The user specifies a GraphQL endpoint URL with optional credentials to initialize the reader.
|
||
|
|
By declaring the GraphQL query and optional variables (parameters) the loader can fetch the nested result docs.
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
Here's an example usage of the GraphQLReader.
|
||
|
|
You can test out queries directly [on the site](https://countries.trevorblades.com/)
|
||
|
|
|
||
|
|
```python
|
||
|
|
from llama_index import download_loader
|
||
|
|
import os
|
||
|
|
|
||
|
|
GraphQLReader = download_loader('GraphQLReader')
|
||
|
|
|
||
|
|
uri = "https://countries.trevorblades.com/"
|
||
|
|
headers = {}
|
||
|
|
query = """
|
||
|
|
query getContinents {
|
||
|
|
continents {
|
||
|
|
code
|
||
|
|
name
|
||
|
|
}
|
||
|
|
}
|
||
|
|
"""
|
||
|
|
reader = GraphQLReader(uri, headers)
|
||
|
|
documents = reader.query(query, variables = {})
|
||
|
|
```
|
||
|
|
|
||
|
|
This loader is designed to be used as a way to load data into [LlamaIndex](https://github.com/jerryjliu/gpt_index/tree/main/gpt_index)
|
||
|
|
and/or subsequently used as a Tool in a [LangChain](https://github.com/hwchase17/langchain) Agent.
|
||
|
|
See [here](https://github.com/emptycrown/llama-hub/tree/main) for examples.
|
||
|
|
|
||
|
|
It uses the [gql GraphQL library](https://pypi.org/project/gql/) for the GraphQL queries.
|