Initial commit.

kirk-marple · kirk-marple · commit c3dc8771a31c · 2024-09-17T16:46:42.000-07:00
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,139 @@
+#########################################
+# Editor temporary/working/backup files #
+.#*
+*\#*\#
+[#]*#
+*~
+*$
+*.bak
+*flymake*
+*.iml
+*.kdev4
+*.log
+*.swp
+*.pdb
+*.zip
+.project
+.pydevproject
+.settings
+.idea
+.vagrant
+.noseids
+.ipynb_checkpoints
+.tags
+.cache/
+.vscode/
+
+# Compiled source #
+###################
+*.a
+*.com
+*.class
+*.dll
+*.exe
+*.pxi
+*.o
+*.py[ocd]
+*.so
+.build_cache_dir
+.mesonpy-native-file.ini
+MANIFEST
+compile_commands.json
+debug
+.debug
+
+# Python files #
+################
+# setup.py working directory
+build
+# sphinx build directory
+doc/_build
+# setup.py dist directory
+dist
+# Egg metadata
+*.egg-info
+.eggs
+.pypirc
+# type checkers
+pandas/py.typed
+
+# pyenv
+.python-version
+
+# tox testing tool
+.tox
+# rope
+.ropeproject
+# wheel files
+*.whl
+**/wheelhouse/*
+pip-wheel-metadata
+# coverage
+.coverage
+coverage.xml
+coverage_html_report
+.mypy_cache
+*.pytest_cache
+.ruff_cache
+# hypothesis test database
+.hypothesis/
+__pycache__
+# pytest-monkeytype
+monkeytype.sqlite3
+# meson editable install folder
+.mesonpy
+
+
+# OS generated files #
+######################
+.directory
+.gdb_history
+.DS_Store
+ehthumbs.db
+Icon?
+Thumbs.db
+
+# Data files #
+##############
+*.dta
+*.xpt
+*.h5
+pandas/io/*.dat
+pandas/io/*.json
+scikits
+
+# Generated Sources #
+#####################
+!skts.c
+*.c
+*.cpp
+!pandas/_libs/src/**/*.c
+!pandas/_libs/src/**/*.h
+!pandas/_libs/include/**/*.h
+
+# Unit / Performance Testing #
+##############################
+asv_bench/env/
+asv_bench/html/
+asv_bench/results/
+asv_bench/pandas/
+test-data.xml
+
+# Documentation generated files #
+#################################
+doc/source/generated
+doc/source/user_guide/styled.xlsx
+doc/source/reference/api
+doc/source/_static/*.html
+doc/source/vbench
+doc/source/vbench.rst
+doc/source/index.rst
+doc/build/html/index.html
+# Windows specific leftover:
+doc/tmp.sv
+env/
+doc/source/savefig/
+
+# Interactive terminal generated files #
+########################################
+.jupyterlite.doit.db
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Unstruk Data Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/README.md b/README.md
@@ -0,0 +1,68 @@
+# Agent Tools for Graphlit Platform
+
+## Overview
+
+TODO
+
+## Prerequisites
+
+Before you begin, ensure you have the following:
+
+- Python 3.x installed on your system.
+- An active account on the [Graphlit Platform](https://portal.graphlit.dev) with access to the API settings dashboard.
+
+## Installation
+
+To install the Graphlit Agent Tools, use pip:
+
+```bash
+pip install graphlit-tools
+```
+
+## Configuration
+
+The Graphlit Client supports environment variables to be set for authentication and configuration:
+
+- `GRAPHLIT_ENVIRONMENT_ID`: Your environment ID.
+- `GRAPHLIT_ORGANIZATION_ID`: Your organization ID.
+- `GRAPHLIT_JWT_SECRET`: Your JWT secret for signing the JWT token.
+
+Alternately, you can pass these values with the constructor of the Graphlit client.
+
+You can find these values in the API settings dashboard on the [Graphlit Platform](https://portal.graphlit.dev).
+
+### Setting Environment Variables
+
+To set these environment variables on your system, use the following commands, replacing `your_value` with the actual values from your account.
+
+For Unix/Linux/macOS:
+
+```bash
+export GRAPHLIT_ENVIRONMENT_ID=your_environment_id_value
+export GRAPHLIT_ORGANIZATION_ID=your_organization_id_value
+export GRAPHLIT_JWT_SECRET=your_secret_key_value
+```
+
+For Windows Command Prompt (CMD):
+
+```cmd
+set GRAPHLIT_ENVIRONMENT_ID=your_environment_id_value
+set GRAPHLIT_ORGANIZATION_ID=your_organization_id_value
+set GRAPHLIT_JWT_SECRET=your_secret_key_value
+```
+
+For Windows PowerShell:
+
+```powershell
+$env:GRAPHLIT_ENVIRONMENT_ID="your_environment_id_value"
+$env:GRAPHLIT_ORGANIZATION_ID="your_organization_id_value"
+$env:GRAPHLIT_JWT_SECRET="your_secret_key_value"
+```
+
+## Support
+
+Please refer to the [Graphlit API Documentation](https://docs.graphlit.dev/).
+
+For support with the Graphlit Agent Tools, please submit a [GitHub Issue](https://github.com/graphlit/graphlit-tools/issues).  
+
+For further support with the Graphlit Platform, please join our [Discord](https://discord.gg/ygFmfjy3Qx) community.
diff --git a/__init__.py b/__init__.py
@@ -0,0 +1,3 @@
+from .tools import (
+    RetrievalTool
+)
diff --git a/azure-pipelines.yml b/azure-pipelines.yml
@@ -0,0 +1,30 @@
+trigger:
+  branches:
+    include:
+      - main
+
+name: $(Date:yyyyMMdd)$(Rev:rrr)
+
+pool:
+  vmImage: "ubuntu-latest"
+
+steps:
+  - task: UsePythonVersion@0
+    inputs:
+      versionSpec: "3.x"
+      addToPath: true
+
+  - script: |
+      echo "##vso[task.setvariable variable=PACKAGE_VERSION]1.0.$(Build.BuildNumber)"
+    displayName: "Set package version"
+
+  - script: |
+      python -m pip install --upgrade pip
+      pip install setuptools wheel twine
+      python setup.py sdist bdist_wheel
+    displayName: "Install dependencies and build"
+
+  - script: |
+      twine upload dist/* -u __token__ -p $(PYPI_TOKEN) --skip-existing
+    displayName: "Upload to PyPI"
+    condition: and(succeeded(), eq(variables['Build.SourceBranch'], 'refs/heads/main'))
diff --git a/pyproject.toml b/pyproject.toml
diff --git a/setup.py b/setup.py
@@ -0,0 +1,25 @@
+import os
+from setuptools import setup, find_packages
+
+# Read the content of your README file
+with open("README.md", "r", encoding="utf-8") as fh:
+    long_description = fh.read()
+
+version = os.getenv('PACKAGE_VERSION', '1.0.0')
+
+setup(
+    name='graphlit-tools',
+    version=version,
+    packages=find_packages(),
+    install_requires=[
+        'graphlit-client',
+        'langchain-core'
+    ],
+    python_requires='>=3.6',
+    author='Unstruk Data Inc.',
+    author_email='questions@graphlit.com',
+    description='Graphlit Agent Tools',
+    url='https://github.com/graphlit/graphlit-tools/',
+    long_description=long_description,
+    long_description_content_type="text/markdown",
+)
diff --git a/tools/__init__.py b/tools/__init__.py
@@ -0,0 +1 @@
+from .retrieval.retrieval_tool import RetrievalTool
diff --git a/tools/retrieval/__init__.py b/tools/retrieval/__init__.py
diff --git a/tools/retrieval/retrieval_tool.py b/tools/retrieval/retrieval_tool.py
@@ -0,0 +1,44 @@
+import asyncio
+import logging
+from typing import Type, List, Optional
+from graphlit import Graphlit
+from graphlit_api import exceptions, ContentFilter, QueryContentsContentsResults
+from langchain_core.pydantic_v1 import Field
+from langchain_core.tools import BaseTool, ToolException
+
+logger = logging.getLogger(__name__)
+
+class RetrievalTool(BaseTool):
+    name = "retrieval"
+    description = """Retrieves content based on a ContentFilter.
+    Can search through web pages, PDFs, and other unstructured data.
+    Filters can include query, date ranges, content types, and other criteria."""
+    args_schema: Type[ContentFilter] = ContentFilter
+
+    graphlit: Graphlit = Field(exclude=True)
+
+    def __init__(self, graphlit: Optional[Graphlit] = None):
+        super().__init__()
+        self.graphlit = graphlit or Graphlit()
+
+    async def _arun(self, content_filter: ContentFilter) -> Optional[List[QueryContentsContentsResults]]:
+        try:
+            response = await self.graphlit.client.query_contents(
+                filter=content_filter
+            )
+
+            return response.contents.results if response.contents is not None else None
+        except exceptions.GraphQLClientError as e:
+            logger.error(str(e))
+            raise ToolException(str(e)) from e
+
+    def _run(self, content_filter: ContentFilter) -> Optional[List[QueryContentsContentsResults]]:
+        try:
+            loop = asyncio.get_event_loop()
+            if loop.is_running():
+                future = asyncio.ensure_future(self._arun(content_filter))
+                return loop.run_until_complete(future)
+            else:
+                return loop.run_until_complete(self._arun(content_filter))
+        except RuntimeError:
+            return asyncio.run(self._arun(content_filter))

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+from .tools import (`
	`2`	`+ RetrievalTool`
	`3`	`+)`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+from .retrieval.retrieval_tool import RetrievalTool`