langchain-nimble 0.1.0__tar.gz

langchain_nimble-0.1.0/LICENSE

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

langchain_nimble-0.1.0/PKG-INFO

@@ -0,0 +1,48 @@
+Metadata-Version: 2.3
+Name: langchain-nimble
+Version: 0.1.0
+Summary: An integration package connecting Nimble and LangChain
+Home-page: https://github.com/langchain-ai/langchain
+License: MIT
+Requires-Python: >=3.9,<4.0
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Dist: langchain-core (>=0.3.15,<0.4.0)
+Project-URL: Repository, https://github.com/langchain-ai/langchain
+Project-URL: Release Notes, https://github.com/langchain-ai/langchain/releases?q=tag%3A%22nimble%3D%3D0%22&expanded=true
+Project-URL: Source Code, https://github.com/langchain-ai/langchain/tree/master/libs/partners/nimble
+Description-Content-Type: text/markdown
+
+# langchain-nimble
+
+This package contains the LangChain integration with Nimble
+
+## Installation
+
+```bash
+pip install -U langchain-nimble
+```
+
+And you should configure credentials by setting the following environment variables:
+
+```bash
+export NIMBLE_API_KEY=<PLACEHOLDER_FOR_YOUR_NIMBLE_API_KEY>
+```
+You can get your API key from [Nimble's website](https://nimbleway.com/)
+Just, go to the log-in page and sign up for a new account. After that, you can get your API key from the dashboard.
+
+## Retrievers
+`NimbleSearchRetriever` class exposes LLMs from Nimble.
+
+```python
+from langchain_nimble import NimbleSearchRetriever
+
+retriever = NimbleSearchRetriever()
+retriever.invoke("Nimbleway")
+```
+

langchain_nimble-0.1.0/README.md

@@ -0,0 +1,27 @@
+# langchain-nimble
+
+This package contains the LangChain integration with Nimble
+
+## Installation
+
+```bash
+pip install -U langchain-nimble
+```
+
+And you should configure credentials by setting the following environment variables:
+
+```bash
+export NIMBLE_API_KEY=<PLACEHOLDER_FOR_YOUR_NIMBLE_API_KEY>
+```
+You can get your API key from [Nimble's website](https://nimbleway.com/)
+Just, go to the log-in page and sign up for a new account. After that, you can get your API key from the dashboard.
+
+## Retrievers
+`NimbleSearchRetriever` class exposes LLMs from Nimble.
+
+```python
+from langchain_nimble import NimbleSearchRetriever
+
+retriever = NimbleSearchRetriever()
+retriever.invoke("Nimbleway")
+```

langchain_nimble-0.1.0/langchain_nimble/__init__.py

@@ -0,0 +1,15 @@
+from importlib import metadata
+
+from langchain_nimble.retrievers import NimbleSearchRetriever
+
+try:
+    __version__ = metadata.version(__package__)
+except metadata.PackageNotFoundError:
+    # Case where package metadata is not available.
+    __version__ = ""
+del metadata  # optional, avoids polluting the results of dir(__package__)
+
+__all__ = [
+    "NimbleSearchRetriever",
+    "__version__",
+]

langchain_nimble-0.1.0/langchain_nimble/retrievers.py

@@ -0,0 +1,97 @@
+import os
+from enum import Enum
+from typing import List, Any
+
+import requests
+from langchain_core.callbacks.manager import CallbackManagerForRetrieverRun
+from langchain_core.documents.base import Document
+from langchain_core.retrievers import BaseRetriever
+
+
+class SearchEngine(str, Enum):
+    """
+    Enum representing the search engines supported by Nimble
+    """
+
+    GOOGLE = "google_search"
+    GOOGLE_SGE = "google_sge"
+    BING = "bing_search"
+    YANDEX = "yandex_search"
+
+
+class ParsingType(str, Enum):
+    """
+    Enum representing the parsing types supported by Nimble
+    """
+
+    PLAIN_TEXT = "plain_text"
+    MARKDOWN = "markdown"
+    SIMPLIFIED_HTML = "simplified_html"
+
+
+class NimbleSearchRetriever(BaseRetriever):
+    """Nimbleway Search API retriever.
+    Allows you to retrieve search results from Google, Bing, and Yandex.
+    Visit https://www.nimbleway.com/ and sign up to receive
+     an API key and to see more info.
+
+    Args:
+        api_key: The API key for Nimbleway.
+        search_engine: The search engine to use. Default is Google.
+        render: Whether to render the results web sites. Default is True.
+        locale: The locale to use. Default is "en".
+        country: The country to use. Default is "US".
+        parsing_type: The parsing type to use. Default is "plain_text".
+        links: The list of links to search for. Default is None. (if enabled will
+        ignore the query)
+    """
+
+    api_key: str = None
+    k: int = 3
+    search_engine: SearchEngine = SearchEngine.GOOGLE
+    render: bool = True
+    locale: str = "en"
+    country: str = "US"
+    parsing_type: ParsingType = ParsingType.PLAIN_TEXT
+    links: List[str] = None
+
+    def _get_relevant_documents(
+            self, query: str, *, run_manager: CallbackManagerForRetrieverRun,
+            **kwargs: Any
+    ) -> List[Document]:
+        request_body = {
+            "query": query,
+            "num_results": kwargs.get("k", self.k),
+            "search_engine": kwargs.get("search_engine", self.search_engine),
+            "parse": kwargs.get("parse", self.parse),
+            "render": kwargs.get("render", self.render),
+            "locale": kwargs.get("locale", self.locale),
+            "country": kwargs.get("country", self.country),
+            "parsing_type": kwargs.get("parsing_type", self.parsing_type),
+            "links": kwargs.get("links", self.links)
+        }
+        route = "extract" if self.links else "search"
+        response = requests.post(
+            f"https://searchit-server.crawlit.live/{route}",
+            json=request_body,
+            headers={
+                "Authorization": f"Basic {self.api_key or os.getenv('NIMBLE_API_KEY')}",
+                "Content-Type": "application/json",
+            },
+        )
+        response.raise_for_status()
+        raw_json_content = response.json()
+        docs = [
+            Document(
+                page_content=doc.get("page_content", ""),
+                metadata={
+                    "title": doc.get("metadata", {}).get("title", ""),
+                    "snippet": doc.get("metadata", {}).get("snippet", ""),
+                    "url": doc.get("metadata", {}).get("url", ""),
+                    "position": doc.get("metadata", {}).get("position", -1),
+                    "entity_type": doc.get("metadata", {}).get("entity_type", ""),
+                },
+            )
+            for doc in raw_json_content.get("body", [])
+        ]
+        return docs

langchain_nimble-0.1.0/pyproject.toml

@@ -0,0 +1,71 @@
+[build-system]
+requires = ["poetry-core>=1.0.0"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.poetry]
+name = "langchain-nimble"
+version = "0.1.0"
+description = "An integration package connecting Nimble and LangChain"
+authors = []
+readme = "README.md"
+repository = "https://github.com/langchain-ai/langchain"
+license = "MIT"
+
+[tool.mypy]
+disallow_untyped_defs = "True"
+
+[tool.poetry.urls]
+"Source Code" = "https://github.com/langchain-ai/langchain/tree/master/libs/partners/nimble"
+"Release Notes" = "https://github.com/langchain-ai/langchain/releases?q=tag%3A%22nimble%3D%3D0%22&expanded=true"
+
+[tool.poetry.dependencies]
+python = ">=3.9,<4.0"
+langchain-core = "^0.3.15"
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "T201"]
+
+[tool.coverage.run]
+omit = ["tests/*"]
+
+[tool.pytest.ini_options]
+addopts = "--strict-markers --strict-config --durations=5"
+markers = [
+    "compile: mark placeholder test used to compile integration tests without running them",
+]
+asyncio_mode = "auto"
+
+[tool.poetry.group.test]
+optional = true
+
+[tool.poetry.group.codespell]
+optional = true
+
+[tool.poetry.group.test_integration]
+optional = true
+
+[tool.poetry.group.lint]
+optional = true
+
+[tool.poetry.group.dev]
+optional = true
+
+[tool.poetry.group.dev.dependencies]
+
+[tool.poetry.group.test.dependencies]
+pytest = "^7.4.3"
+pytest-asyncio = "^0.23.2"
+pytest-socket = "^0.7.0"
+pytest-watcher = "^0.3.4"
+langchain-tests = "0.3.10"
+
+[tool.poetry.group.codespell.dependencies]
+codespell = "^2.2.6"
+
+[tool.poetry.group.test_integration.dependencies]
+
+[tool.poetry.group.lint.dependencies]
+ruff = "^0.5"
+
+[tool.poetry.group.typing.dependencies]
+mypy = "^1.10"