{"id":19307401,"url":"https://github.com/artefactory/redisventures-hackunamadata","last_synced_at":"2026-05-16T15:31:50.453Z","repository":{"id":103035276,"uuid":"557476913","full_name":"artefactory/redisventures-hackunamadata","owner":"artefactory","description":"https://hackathon.redisventures.com/","archived":false,"fork":false,"pushed_at":"2022-11-07T21:49:44.000Z","size":148,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-06T01:11:18.187Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/artefactory.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-10-25T19:01:13.000Z","updated_at":"2022-12-19T08:43:19.000Z","dependencies_parsed_at":"2023-03-13T15:09:46.542Z","dependency_job_id":null,"html_url":"https://github.com/artefactory/redisventures-hackunamadata","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/artefactory%2Fredisventures-hackunamadata","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/artefactory%2Fredisventures-hackunamadata/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/artefactory%2Fredisventures-hackunamadata/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/artefactory%2Fredisventures-hackunamadata/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/artefactory","download_url":"https://codeload.github.com/artefactory/redisventures-hackunamadata/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240409263,"owners_count":19796789,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-10T00:10:48.050Z","updated_at":"2026-05-16T15:31:45.432Z","avatar_url":"https://github.com/artefactory.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n\u003cimg src=\"https://dwglogo.com/wp-content/uploads/2017/12/1100px_Redis_Logo_01.png\" height=\"200\" align=\"middle\"/\u003e\n\u003c/div\u003e\n\n# ArXiv Copilot \u003c/br\u003e Redisventures - Hackunamadata team\n\n## :bookmark_tabs: Menu\n\n* [Overview](#overview)\n* [How to install ArXiv Copilot](#how-to-install-arxiv-copilot)\n* [Sequence Diagram](#sequence-diagram)\n* [Developer Guide](#developer-guide)\n  * [Redis - Data structure](#redis---data-structure)\n  * [Vector Service](#vector-service)\n  * [Recommendation Service](#recommendation-service)\n  * [ArXiv Copilot](#arxiv-copilot)\n* [License](#license)\n* [Authors](#authors)\n\n## Overview\n\nArXiv Copilot is a Chrome extension that is giving you live suggestions of scientific papers that could interest you when you're writing an article, course notes, ...\n\u003c/br\u003eIt is a system created using the Vector Search technology on the [arXiv scholarly papers dataset](https://arxiv.org/).\nThis was developed during the [Vector Search Engineering Lab (Hackathon)](https://hackathon.redisventures.com/), in collaboration with Saturn Cloud and Redis, by three data engineers and one data scientist from Artefact Paris.\n\u003c/br\u003eIf you want to understand more how the tool was thought and made, you can read our article [here](https://drive.google.com/file/d/1klVaP_Km_gUvhhT5RBO7g8p_TW9XH8k4/view) and see our pitch deck (with a demo) [here](https://drive.google.com/file/d/1v4Tdtj7JWdkKiXzjG7QPzIXn6Lkc4bNO/view).\n\n## How to install ArXiv Copilot\n\nSee [here](./browser_extension/README.md) to know how to install the browser extension and enjoy the use of ArXiv Copilot.\n\n## Sequence Diagram\n```mermaid\nsequenceDiagram\n    title \"High level flow - synchronous\"\n\n        opt team wants to upload articles\n        Team -\u003e\u003e Vector Service: Send all papers in arXiv dataset\n        Note over Team, Vector Service: POST vector_service/v1/arxiv/papers/\n        Vector Service -\u003e\u003e Redis: Send papers in a queue and add papers as hashes with prefix /arxiv/papers/\n\n        opt jupyter server and dask cluster are running:\n            Redis --\u003e\u003e Jupyter Server: Consume messages in queue\n            Note over Redis, Jupyter Server: user redis client to consume messages from queue\n            Jupyter Server -\u003e\u003e Dask Cluster: Compute embeding for message\n            Note over Jupyter Server, Dask Cluster: use dask client to push jobs to cluster\n            Dask Cluster --\u003e\u003e Jupyter Server: Get message's embedding\n            Jupyter Server -\u003e\u003e Redis: Store embeddings in papers hashes\n        end\n    end\n\n    opt User wants custom exention setting\n        User -\u003e\u003e ArXiv Copilot: Setup the exention's options\n    end\n\n    loop while user is writing\n        User -\u003e\u003e ArXiv Copilot: Write text casually\n        opt ArXiv Copilot has registered `text_trigger_depth` words\n            ArXiv Copilot -\u003e\u003e Recommendation Service: Send `text_send_depth` words.\n            activate Recommendation Service\n            Note over ArXiv Copilot, Recommendation Service: POST /api/v1/recommendations/\n            Recommendation Service -\u003e\u003e Vector Service: Send text\n            Vector Service -\u003e\u003e Vector Service : Compute vector for given text input\n            Vector Service -\u003e\u003e Redis : Find nearest papers in index\n            Redis --\u003e\u003e Vector Service: Return nearest papers\n            Vector Service --\u003e\u003e Recommendation Service: return nearest papers\n            Recommendation Service --\u003e\u003e ArXiv Copilot: Return recommendations\n            deactivate Recommendation Service\n            ArXiv Copilot --\u003e\u003e User: Return recommendations as chrome notifications\n            opt user clicks on notificaiton\n                ArXiv Copilot -\u003e\u003e User: Open article in new tab\n            end\n        end\n    end\n```\n\n# Developer Guide\n## Redis - Data structure\n```json\n{\n    \"id\": \"1801.00001\",\n    \"title\": \"Title of the paper\",\n    \"abstract\": \"Abstract of the paper\",\n    \"categories\": \"cs.AI cs.CL cs.LG\",\n    \"authors\": \"Author 1, Author 2, Author 3\",\n    \"journal-ref\": \"Phys. Rev. B 76, 174425 (2007)\"\n}\n```\n\n## Vector Service\n### Endpoints\n\n| Endpoint | Method | Description | Request Body | Response Body |\n| --- | --- | --- | --- | --- |\n| /vector_service/v1/arxiv/papers | POST | Add the papers metadata in Redis hashes and put id in a Redis queue for future processing | `{\"papers\": [{\"id\": \"123\", \"title\": \"title\", \"abstract\": \"abstract\", ...}]}` | `{\"status\": \"ok\"}` |\n| /vector_service/v1/arxiv/papers/{id} | GET | Get the metadata stored in Redis ahsh for the given arxiv paper id | - | `{\"id\": \"123\", \"title\": \"title\", \"abstract\": \"abstract\", ...}` |\n| /vector_service/v1/text/nearest| POST | Get the nearest papers for the given text | `{\"text\": \"string\", \"categories\": [\"cond-mat.dis-nn\"], \"years\": [\"2007\", \"2010\"], \"number_of_results\": 5,\"search_type\": \"KNN\"}` | `{\"papers\": [{\"id\": \"123\", \"title\": \"title\", \"abstract\": \"abstract\"}, ...]}` |\n\nFor more details, see [here](./vector_service).\n\n## Recommendation Service\n### Endpoints\n| Endpoint                | Method | Description | Request Body | Response Body                                                                                                                                                                    |\n|-------------------------| --- | --- | --- |----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| /api/v1/recommendations | POST | Get the recommendations for the given text and optional parameters | `{\"text\": \"string\", \"categories\": [\"cond-mat.dis-nn\"], \"years\": [\"2007\", \"2010\"], \"number_of_results\": 5}` | `{\"papers\": [{\"id\": \"123\", \"title\": \"title\", \"authors\": \"authors\", \"abstract\": \"abstract\", \"categories\": \"categories\", \"journal_ref\": \"journal_ref\", \"similarity_score\": 0.5}]}` |\n\nFor more details, see [here](./recommendation_service).\n\n## ArXiv Copilot\n\n### Extension configuration\n| Field | Description | Example | Default |\n| --- | --- | --- | --- |\n| text_trigger_depth | Number of words to wait before asking for recommandations again | `10` | `10` |\n| text_send_depth | Number of words to send to the recommendation service | `3000` | `3000` |\n| recommendation_service_url | URL of the recommendation service | `https://recommendationservice.community.saturnenterprise.io/api/v1/recommendations/` | `https://recommendationservice.community.saturnenterprise.io/api/v1/recommendations/` |\n| recommendation_service_token | Token for the recommendation service | `678GSA576SQ` | `undefined` |\n| years | Years to filter the recommendations | `2007, 2010` | `\"\"` |\n| categories | Categories to filter the recommendations | `cond-mat.dis-nn, cs.AI` | `\"\"` |\n| text_collection_mode | Mode to collect text from the page (`keyboard`, `textContent`)| `keyboard` | `keyboard` |\n\nFor more details, see [here](./browser_extension).\n\n## License\n\nThe [MIT License](./LICENSE.md) (MIT)\n\n## Authors\n- [@dauresh](https://github.com/dauresh)\n- [@ali-artefact](https://github.com/ali-artefact)\n- [@benoitbazouin](https://github.com/benoitbazouin)\n- [@pol-defont-reaulx](https://github.com/pol-defont-reaulx)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fartefactory%2Fredisventures-hackunamadata","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fartefactory%2Fredisventures-hackunamadata","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fartefactory%2Fredisventures-hackunamadata/lists"}