From 5107622753df98f7cede6b4913e5f2a4b4f60d45 Mon Sep 17 00:00:00 2001 From: Zachary BENSALEM Date: Wed, 14 Aug 2024 23:48:59 +0200 Subject: [PATCH 1/3] Update README.md Signed-off-by: Zachary BENSALEM --- README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/README.md b/README.md index 95dce2ad1..8b3a146f0 100644 --- a/README.md +++ b/README.md @@ -10,8 +10,7 @@ GraphFleet uses knowledge graphs to provide substantial improvements in question <<<<<<< HEAD ## Roadmap -======= ->>>>>>> origin/main + - [ ] Provide a FleetUI Design Kit and a quicker way of starting GraphFleet locally. - [ ] Provide a Toddle interface ready to use for GraphFleet From fde5fa96e528ac824c186ed6d401d7d7124c18bc Mon Sep 17 00:00:00 2001 From: Zachary BENSALEM Date: Wed, 14 Aug 2024 23:52:56 +0200 Subject: [PATCH 2/3] Update README.md Signed-off-by: Zachary BENSALEM --- README.md | 27 ++++++++++----------------- 1 file changed, 10 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 8b3a146f0..72f475f00 100644 --- a/README.md +++ b/README.md @@ -32,7 +32,7 @@ GraphFleet uses knowledge graphs to provide substantial improvements in question - Leave us a star ♥ - Fork and contribute to the project -- [![Join the discord](https://api.star-history.com/svg?repos=Qredence/GraphFleet&type=Date)](https://star-history.com/#Qredence/GraphFleet&Date) +- [![Join the discord](https://discord.gg/BD8MPgzEJc) ## Getting Started @@ -50,21 +50,19 @@ GraphFleet uses knowledge graphs to provide substantial improvements in question ### Installation 1. Clone the repository: -<<<<<<< HEAD -======= ``` bash git clone https://github.com/Qredence/GraphFleet.git cd GraphFleet ``` ->>>>>>> origin/main + ``` bash git clone https://github.com/Qredence/GraphFleet.git cd GraphFleet ``` -<<<<<<< HEAD + 2. Simply run these in your terminal: ``` bash @@ -72,7 +70,7 @@ GraphFleet uses knowledge graphs to provide substantial improvements in question poetry install ``` -======= + 2. Create a virtual environment and activate it: ``` bash @@ -85,13 +83,13 @@ source gfleetenv/bin/activate ``` pip install -r requirements.txt ``` ->>>>>>> origin/main + ### Usage 1. Configuration: Environment Variables: Set up your environment variables in a .env file (refer to the .env.example file for available options). Key variables include: -<<<<<<< HEAD + ```sh export GRAPHRAG_API_KEY="" @@ -124,7 +122,7 @@ streamlit run app.py Access the interface in your web browser at the provided URL (usually ). -======= + ``` GRAPHRAG_API_KEY @@ -153,7 +151,7 @@ streamlit run app.py ``` Access the interface in your web browser at the provided URL (usually http://localhost:8080). ->>>>>>> origin/main + ``` bash python -m graphrag.query --root ./graphfleet --method local "What are the key features of GraphRAG ??" ``` @@ -163,10 +161,8 @@ For Global query mode : ``` bash python -m graphrag.query --root ./graphfleet --method global "What are the top main features of GraphRAG" ``` -<<<<<<< HEAD -======= ->>>>>>> origin/main + ### Running the API only To run the API, save the code in a file named api.py and execute the following command in your terminal: @@ -185,8 +181,5 @@ uvicorn api:app --reload --port 8001 ## Star History -<<<<<<< HEAD -[![Star History Chart](https://api.star-history.com/svg?repos=Qredence/GraphFleet&type=Date)](https://star-history.com/#Qredence/GraphFleet&Date) -======= [![Star History Chart](https://api.star-history.com/svg?repos=Qredence/GraphFleet&type=Date)](https://star-history.com/#Qredence/GraphFleet&Date) ->>>>>>> origin/main + From 81f6ac380c24edb97834fa8c43e884b79b28eecc Mon Sep 17 00:00:00 2001 From: Zachary BENSALEM Date: Wed, 14 Aug 2024 22:23:16 +0000 Subject: [PATCH 3/3] add stainless --- .github/workflows/python-publish.yml | 34 +----- graphfleet/api/openapi.stainless.yml | 61 +++++++++++ graphfleet/api/openapi.yml | 155 +++++++++++++++++++++++++++ 3 files changed, 217 insertions(+), 33 deletions(-) create mode 100644 graphfleet/api/openapi.stainless.yml create mode 100644 graphfleet/api/openapi.yml diff --git a/.github/workflows/python-publish.yml b/.github/workflows/python-publish.yml index eb87c3435..4ec4c189c 100644 --- a/.github/workflows/python-publish.yml +++ b/.github/workflows/python-publish.yml @@ -5,40 +5,8 @@ # They are provided by a third-party and are governed by # separate terms of service, privacy policy, and support # documentation. + -name: Upload Python Package - -on: - release: - types: [published] - -permissions: - contents: read - -jobs: - deploy: - - runs-on: ubuntu-latest - - steps: - - uses: actions/checkout@v4 - - name: Set up Python - uses: actions/setup-python@v5 - with: - python-version: '3.x' - - name: Install dependencies - run: | - python -m pip install --upgrade pip - pip install build - - name: Build package - run: python -m build - - name: Publish package - uses: pypa/gh-action-pypi-publish@ec4db0b4ddc65acdf4bff5fa45ac92d78b56bdf0 - with: - user: __token__ - password: ${{ secrets.PYPI_API_TOKEN }} - - name: Python Publish on: release: diff --git a/graphfleet/api/openapi.stainless.yml b/graphfleet/api/openapi.stainless.yml new file mode 100644 index 000000000..76c07386c --- /dev/null +++ b/graphfleet/api/openapi.stainless.yml @@ -0,0 +1,61 @@ +# yaml-language-server: $schema=https://app.stainlessapi.com/config.schema.json + +organization: + name: graphfleet + docs: https://docs.qredence.ai + contact: zachary@qredence.ai + github_org: Qredence +resources: + root: + methods: + retrieve: get / + $client: + methods: + process_local_query: post /process_local_query/ + process_global_query: post /process_global_query/ + add_message: post /add_message/ + chat_history: + methods: + list: get /get_chat_history/ + delete: delete /clear_chat_history/ +targets: + node: + package_name: graphfleet + production_repo: null + publish: + npm: false + python: + package_name: graphfleet + production_repo: null + publish: + pypi: false +settings: + license: Apache-2.0 +client_settings: + opts: {} + omit_platform_headers: false + default_headers: {} + default_timeout: PT60S + default_retries: + max_retries: 2 + initial_delay_seconds: 0.5 + max_delay_seconds: 8 +environments: + production: https://localhost:8080/test-api +query_settings: + nested_format: brackets + array_format: comma +readme: + example_requests: + default: + type: request + endpoint: post /add_message/ + params: &ref_0 {} + headline: + type: request + endpoint: post /add_message/ + params: *ref_0 + pagination: + type: request + endpoint: get /get_chat_history/ + params: {} \ No newline at end of file diff --git a/graphfleet/api/openapi.yml b/graphfleet/api/openapi.yml new file mode 100644 index 000000000..705410381 --- /dev/null +++ b/graphfleet/api/openapi.yml @@ -0,0 +1,155 @@ +openapi: '3.1.0' +info: + title: 'GraphFleet' + version: '0.4.0' +paths: + '/': + get: + summary: 'Read Root' + operationId: 'read_root__get' + responses: + '200': + description: 'Successful Response' + content: + application/json: + schema: {} + '/process_local_query/': + post: + summary: 'Process Local Query Endpoint' + operationId: 'process_local_query_endpoint_process_local_query__post' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/QueryRequest' + required: true + responses: + '200': + description: 'Successful Response' + content: + application/json: + schema: {} + '422': + description: 'Validation Error' + content: + application/json: + schema: + $ref: '#/components/schemas/HTTPValidationError' + '/process_global_query/': + post: + summary: 'Process Global Query Endpoint' + operationId: 'process_global_query_endpoint_process_global_query__post' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/QueryRequest' + required: true + responses: + '200': + description: 'Successful Response' + content: + application/json: + schema: {} + '422': + description: 'Validation Error' + content: + application/json: + schema: + $ref: '#/components/schemas/HTTPValidationError' + '/add_message/': + post: + summary: 'Add Message' + operationId: 'add_message_add_message__post' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChatMessage' + required: true + responses: + '200': + description: 'Successful Response' + content: + application/json: + schema: {} + '422': + description: 'Validation Error' + content: + application/json: + schema: + $ref: '#/components/schemas/HTTPValidationError' + '/get_chat_history/': + get: + summary: 'Get Chat History' + operationId: 'get_chat_history_get_chat_history__get' + responses: + '200': + description: 'Successful Response' + content: + application/json: + schema: {} + '/clear_chat_history/': + delete: + summary: 'Clear Chat History' + operationId: 'clear_chat_history_clear_chat_history__delete' + responses: + '200': + description: 'Successful Response' + content: + application/json: + schema: {} +components: + schemas: + ChatMessage: + type: 'object' + title: 'ChatMessage' + required: + - role + - content + properties: + role: + type: 'string' + title: 'Role' + content: + type: 'string' + title: 'Content' + HTTPValidationError: + type: 'object' + title: 'HTTPValidationError' + properties: + detail: + type: 'array' + title: 'Detail' + items: + $ref: '#/components/schemas/ValidationError' + QueryRequest: + type: 'object' + title: 'QueryRequest' + required: + - query + properties: + query: + type: 'string' + title: 'Query' + ValidationError: + type: 'object' + title: 'ValidationError' + required: + - loc + - msg + - type + properties: + loc: + type: 'array' + title: 'Location' + items: + anyOf: + - type: 'string' + - type: 'integer' + msg: + type: 'string' + title: 'Message' + type: + type: 'string' + title: 'Error Type'