Graphql

GraphQLReader

Bases: BaseReader

GraphQL reader.

Combines all GraphQL results into the Document used by LlamaIndex.

Parameters:

Name	Type	Description	Default
uri	str	GraphQL uri.	None
headers	Optional[Dict]	Optional http headers.	None

Source code in llama-index-integrations/readers/llama-index-readers-graphql/llama_index/readers/graphql/base.py

class GraphQLReader(BaseReader):
    """GraphQL reader.

    Combines all GraphQL results into the Document used by LlamaIndex.

    Args:
        uri (str): GraphQL uri.
        headers (Optional[Dict]): Optional http headers.

    """

    def __init__(
        self,
        uri: Optional[str] = None,
        headers: Optional[Dict] = None,
    ) -> None:
        """Initialize with parameters."""
        try:
            from gql import Client
            from gql.transport.requests import RequestsHTTPTransport

        except ImportError:
            raise ImportError("`gql` package not found, please run `pip install gql`")
        if uri:
            if uri is None:
                raise ValueError("`uri` must be provided.")
            if headers is None:
                headers = {}
            transport = RequestsHTTPTransport(url=uri, headers=headers)
            self.client = Client(transport=transport, fetch_schema_from_transport=True)

    def load_data(self, query: str, variables: Optional[Dict] = None) -> List[Document]:
        """Run query with optional variables and turn results into documents.

        Args:
            query (str): GraphQL query string.
            variables (Optional[Dict]): optional query parameters.

        Returns:
            List[Document]: A list of documents.

        """
        try:
            from gql import gql

        except ImportError:
            raise ImportError("`gql` package not found, please run `pip install gql`")
        if variables is None:
            variables = {}

        documents = []

        result = self.client.execute(gql(query), variable_values=variables)

        for key in result:
            entry = result[key]
            if isinstance(entry, list):
                documents.extend([Document(text=yaml.dump(v)) for v in entry])
            else:
                documents.append(Document(text=yaml.dump(entry)))

        return documents

load_data

load_data(query: str, variables: Optional[Dict] = None) -> List[Document]

Run query with optional variables and turn results into documents.

Parameters:

Name	Type	Description	Default
query	str	GraphQL query string.	required
variables	Optional[Dict]	optional query parameters.	None

Returns:

Type	Description
List[Document]	List[Document]: A list of documents.

Source code in llama-index-integrations/readers/llama-index-readers-graphql/llama_index/readers/graphql/base.py

def load_data(self, query: str, variables: Optional[Dict] = None) -> List[Document]:
    """Run query with optional variables and turn results into documents.

    Args:
        query (str): GraphQL query string.
        variables (Optional[Dict]): optional query parameters.

    Returns:
        List[Document]: A list of documents.

    """
    try:
        from gql import gql

    except ImportError:
        raise ImportError("`gql` package not found, please run `pip install gql`")
    if variables is None:
        variables = {}

    documents = []

    result = self.client.execute(gql(query), variable_values=variables)

    for key in result:
        entry = result[key]
        if isinstance(entry, list):
            documents.extend([Document(text=yaml.dump(v)) for v in entry])
        else:
            documents.append(Document(text=yaml.dump(entry)))

    return documents