endoc 0.1.0__tar.gz

endoc-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Endoc
+
+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.

endoc-0.1.0/PKG-INFO

@@ -0,0 +1,51 @@
+Metadata-Version: 2.1
+Name: endoc
+Version: 0.1.0
+Summary: Endoc SDK: A note-taking app SDK powered by LLMs
+Home-page: https://github.com/science-editor/endoc-python-sdk
+Author: Grigor Dochev
+Author-email: Grigor Dochev <gdochev@ethz.ch>, Andreas Giannoutsos <agiannoutsos@ethz.ch>
+License: MIT
+Project-URL: Homepage, https://github.com/science-editor/endoc-python-sdk
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+
+# Endoc SDK
+
+The Endoc software development kit (SDK) is for developers, researchers and other academic groups who want to programmatically access the NLP features developed for the Endoc platform.
+
+It provides an interface agnostic approach allowing you to bypass the Endoc platform website and, directly integrate select NLP research-derived state of the art APIs into your own standalone applications.
+
+# Motivation
+
+LLMs are increasingly used as tools in academia, providing ways to access information, alternative views in reasoning, paraphraasing of content or summarisation of papers.
+
+The intent of the Endoc SDK is to act as a scientific guard, providing an interface to Endoc LLM technologies programmatically that layer ETH in-house curated filters for scientific language accuracy.
+
+## Get started
+
+1. Install the Endoc SDK using pip:
+
+```bash
+pip install endoc-sdk
+```
+
+2. Get a free API key from the Endoc platform, under your Swiss affiliated account page or request one from the developers (if outside of Switzerland).
+
+3. Initalize the Endoc SDK with your API key:
+
+```python
+# Import Endoc from endoc-sdk
+from endoc-sdk import Endoc
+
+# API Key available on the account page
+client = Endoc("your_api_key");
+```
+
+## Contributing
+
+We welcome contributions to the Endoc SDK. Please refer to the [CONTRIBUTING.md](CONTRIBUTING.md) file for more information.

endoc-0.1.0/README.md

@@ -0,0 +1,35 @@
+# Endoc SDK
+
+The Endoc software development kit (SDK) is for developers, researchers and other academic groups who want to programmatically access the NLP features developed for the Endoc platform.
+
+It provides an interface agnostic approach allowing you to bypass the Endoc platform website and, directly integrate select NLP research-derived state of the art APIs into your own standalone applications.
+
+# Motivation
+
+LLMs are increasingly used as tools in academia, providing ways to access information, alternative views in reasoning, paraphraasing of content or summarisation of papers.
+
+The intent of the Endoc SDK is to act as a scientific guard, providing an interface to Endoc LLM technologies programmatically that layer ETH in-house curated filters for scientific language accuracy.
+
+## Get started
+
+1. Install the Endoc SDK using pip:
+
+```bash
+pip install endoc-sdk
+```
+
+2. Get a free API key from the Endoc platform, under your Swiss affiliated account page or request one from the developers (if outside of Switzerland).
+
+3. Initalize the Endoc SDK with your API key:
+
+```python
+# Import Endoc from endoc-sdk
+from endoc-sdk import Endoc
+
+# API Key available on the account page
+client = Endoc("your_api_key");
+```
+
+## Contributing
+
+We welcome contributions to the Endoc SDK. Please refer to the [CONTRIBUTING.md](CONTRIBUTING.md) file for more information.

endoc-0.1.0/endoc/__init__.py

@@ -0,0 +1,15 @@
+from .document_search import DocumentSearchService
+from .paginated_search import PaginatedSearchService
+from .memsum_summary import SummarizationService
+
+def summarize(api_key, collection, id_field, id_type, id_value):
+    service = SummarizationService(api_key)
+    return service.summarize_paper(collection, id_field, id_type, id_value)
+
+def document_search(api_key, ranking_variable, **kwargs):
+    service = DocumentSearchService(api_key)
+    return service.search_documents(ranking_variable, **kwargs)
+
+def paginated_search(api_key, paper_list, keywords=None):
+    service = PaginatedSearchService(api_key)
+    return service.paginated_search(paper_list, keywords)

endoc-0.1.0/endoc/client.py

@@ -0,0 +1,16 @@
+from gql import Client
+from gql.transport.requests import RequestsHTTPTransport
+
+class APIClient:
+    def __init__(self, api_key):
+        url = "https://endoc.ethz.ch/graphql"
+        self.client = Client(
+            transport = RequestsHTTPTransport(
+                url=url,
+                headers={'x-api-key': api_key}
+            ),
+            fetch_schema_from_transport=True,
+        )
+
+    def execute_query(self, query, variable_values=None):
+        return self.client.execute(query, variable_values or {})

endoc-0.1.0/endoc/document_search.py

@@ -0,0 +1,18 @@
+from .client import APIClient
+from .queries import DOCUMENT_SEARCH_QUERY
+
+class DocumentSearchService:
+    def __init__(self, api_key):
+        self.client = APIClient(api_key)
+
+    def search_documents(
+            self,
+            ranking_variable,
+            keywords=None
+    ):
+        variable_values = {
+            "ranking_variable": ranking_variable,
+            "keywords": keywords or []
+        }
+        result = self.client.execute_query(DOCUMENT_SEARCH_QUERY, variable_values)
+        return result

endoc-0.1.0/endoc/memsum_summary.py

@@ -0,0 +1,24 @@
+from .client import APIClient
+from .queries import MEMSUM_SUMMARY_QUERY
+
+class SummarizationService:
+    def __init__(self, api_key):
+        self.client = APIClient(api_key)
+
+    def summarize_paper(
+            self,
+            collection,
+            id_field,
+            id_type,
+            id_value
+    ):
+        variable_values = {
+            "paper_id" : {
+                "collection": collection,
+                "id_field": id_field,
+                "id_type": id_type,
+                "id_value": id_value,
+            }
+        }
+        result = self.client.execute_query(MEMSUM_SUMMARY_QUERY, variable_values)
+        return result

endoc-0.1.0/endoc/paginated_search.py

@@ -0,0 +1,14 @@
+from .client import APIClient
+from .queries import PAGINATED_SEARCH_QUERY
+
+class PaginatedSearchService:
+    def __init__(self, api_key):
+        self.client = APIClient(api_key)
+
+    def paginated_search(self, paper_list, keywords=None):
+        variable_values = {
+            "paper_list": paper_list,
+            "keywords": keywords or [],
+        }
+        result = self.client.execute_query(PAGINATED_SEARCH_QUERY, variable_values)
+        return result

endoc-0.1.0/endoc/queries.py

@@ -0,0 +1,104 @@
+from gql import gql
+
+DOCUMENT_SEARCH_QUERY = gql("""
+query documentSearch(
+    $ranking_variable: String
+    $keywords: [String]
+    $paper_list: [MetadataInput]
+    $ranking_collection: String
+    $ranking_id_field: String
+    $ranking_id_value: String
+    $ranking_id_type: String
+) {
+    documentSearch(
+    ranking_variable: $ranking_variable
+    keywords: $keywords
+    paper_list: $paper_list
+    ranking_collection: $ranking_collection
+    ranking_id_field: $ranking_id_field
+    ranking_id_value: $ranking_id_value
+    ranking_id_type: $ranking_id_type
+    ) {
+    status
+    message
+    response {
+        search_stats {
+        DurationTotalSearch
+        nMatchingDocuments
+        }
+        paper_list {
+        collection
+        id_field
+        id_type
+        id_value
+        }
+        reranking_scores
+        prefetching_scores
+    }
+    }
+}
+""")
+
+PAGINATED_SEARCH_QUERY = gql("""
+query paginatedSearch($paper_list: [MetadataInput]!, $keywords: [String]) {
+    paginatedSearch(paper_list: $paper_list, keywords: $keywords) {
+        status
+        message
+        response {
+            _id
+            DOI
+            Title
+            Content {
+                Abstract
+                Abstract_Parsed {
+                    section_id
+                    section_title
+                    section_text {
+                        paragraph_id
+                        paragraph_text {
+                            sentence_id
+                            sentence_text
+                            sentence_similarity
+                            cite_spans {
+                                start
+                                end
+                                text
+                                ref_id
+                            }
+                        }
+                    }
+                }
+            }
+            Author {
+                FamilyName
+                GivenName
+            }
+            Venue
+            PublicationDate {
+                Year
+                Month
+                Day
+                Name
+            }
+            id_int
+            relevant_sentences
+        }
+    }
+}
+""")
+
+MEMSUM_SUMMARY_QUERY = gql("""
+query summarizePaper($paper_id: MetadataInput!) {
+    summarizePaper(paper_id: $paper_id) {
+        status
+        message
+        response {
+        paragraph_id
+        section_id
+        sentence_id
+        sentence_text
+        tag
+        }
+    }
+}
+""")

endoc-0.1.0/endoc.egg-info/PKG-INFO

@@ -0,0 +1,51 @@
+Metadata-Version: 2.1
+Name: endoc
+Version: 0.1.0
+Summary: Endoc SDK: A note-taking app SDK powered by LLMs
+Home-page: https://github.com/science-editor/endoc-python-sdk
+Author: Grigor Dochev
+Author-email: Grigor Dochev <gdochev@ethz.ch>, Andreas Giannoutsos <agiannoutsos@ethz.ch>
+License: MIT
+Project-URL: Homepage, https://github.com/science-editor/endoc-python-sdk
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+
+# Endoc SDK
+
+The Endoc software development kit (SDK) is for developers, researchers and other academic groups who want to programmatically access the NLP features developed for the Endoc platform.
+
+It provides an interface agnostic approach allowing you to bypass the Endoc platform website and, directly integrate select NLP research-derived state of the art APIs into your own standalone applications.
+
+# Motivation
+
+LLMs are increasingly used as tools in academia, providing ways to access information, alternative views in reasoning, paraphraasing of content or summarisation of papers.
+
+The intent of the Endoc SDK is to act as a scientific guard, providing an interface to Endoc LLM technologies programmatically that layer ETH in-house curated filters for scientific language accuracy.
+
+## Get started
+
+1. Install the Endoc SDK using pip:
+
+```bash
+pip install endoc-sdk
+```
+
+2. Get a free API key from the Endoc platform, under your Swiss affiliated account page or request one from the developers (if outside of Switzerland).
+
+3. Initalize the Endoc SDK with your API key:
+
+```python
+# Import Endoc from endoc-sdk
+from endoc-sdk import Endoc
+
+# API Key available on the account page
+client = Endoc("your_api_key");
+```
+
+## Contributing
+
+We welcome contributions to the Endoc SDK. Please refer to the [CONTRIBUTING.md](CONTRIBUTING.md) file for more information.

endoc-0.1.0/endoc.egg-info/SOURCES.txt

@@ -0,0 +1,15 @@
+LICENSE
+README.md
+pyproject.toml
+setup.py
+endoc/__init__.py
+endoc/client.py
+endoc/document_search.py
+endoc/memsum_summary.py
+endoc/paginated_search.py
+endoc/queries.py
+endoc.egg-info/PKG-INFO
+endoc.egg-info/SOURCES.txt
+endoc.egg-info/dependency_links.txt
+endoc.egg-info/requires.txt
+endoc.egg-info/top_level.txt

endoc-0.1.0/endoc.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

endoc-0.1.0/endoc.egg-info/requires.txt

@@ -0,0 +1 @@
+gql[requests]>=3.5.0

endoc-0.1.0/endoc.egg-info/top_level.txt

@@ -0,0 +1 @@
+endoc

endoc-0.1.0/pyproject.toml

@@ -0,0 +1,25 @@
+[build-system]
+requires = ["setuptools", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "endoc"
+version = "0.1.0"
+description = "Endoc SDK: A note-taking app SDK powered by LLMs"
+readme = "README.md"
+license = {text = "MIT"}
+authors = [
+    {name = "Grigor Dochev", email = "gdochev@ethz.ch"},
+    {name = "Andreas Giannoutsos", email = "agiannoutsos@ethz.ch"}
+]
+urls = {Homepage = "https://github.com/science-editor/endoc-python-sdk"}
+requires-python = ">=3.7"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent"
+]
+
+dependencies = [
+    "gql[requests]>=3.5.0"
+]

endoc-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

endoc-0.1.0/setup.py

@@ -0,0 +1,21 @@
+from setuptools import setup, find_packages
+
+setup(
+    name="endoc-sdk",
+    version="1.0.0",
+    packages=find_packages(),
+    install_requires=[
+        "gql[requests]==3.5.0",
+    ],
+    description="Endoc SDK: A note-taking app SDK powered by LLMs",
+    long_description=open("README.md").read(),
+    long_description_content_type="text/markdown",
+    author="Grigor Dochev",
+    url="https://github.com/science-editor/endoc-python-sdk",
+    classifiers=[
+        "Programming Language :: Python :: 3",
+        "License :: OSI Approved :: MIT License",
+        "Operating System :: OS Independent",
+    ],
+    python_requires='>=3.7',
+)