PyPI - kensho-kfinance - Versions diffs - 2.6.5__tar.gz → 2.7.0__tar.gz - Mend

@@ -1,6 +1,7 @@
 from concurrent.futures import ThreadPoolExecutor
 from contextlib import contextmanager
 import logging
+from queue import Queue
 from time import time
 from typing import Callable, Generator, Optional
 from uuid import uuid4
@@ -95,6 +96,7 @@ class KFinanceApiClient:
         self._batch_id: str | None = None
         self._batch_size: str | None = None
         self._user_permissions: set[Permission] | None = None
+        self._endpoint_tracker_queue: Queue[str] | None = None
     @contextmanager
     def batch_request_header(self, batch_size: int) -> Generator:
@@ -208,9 +210,28 @@ class KFinanceApiClient:
                     permission_str,
                 )
+    @contextmanager
+    def endpoint_tracker(self) -> Generator:
+        """Context manager to track and return endpoint URLs in our thread-safe queue during execution.
+        endpoint_tracker yields a queue into which all endpoint URLs are written until the context manager gets exited.
+        It is up to the callers to dequeue the queue before the context manager gets exited and the queue gets wiped.
+        This functionality is currently used by `run_with_grounding` to collect and forward endpoint URLs.
+        """
+        self._endpoint_tracker_queue = Queue[str]()
+        try:
+            yield self._endpoint_tracker_queue
+        finally:
+            self._endpoint_tracker_queue = None
     def fetch(self, url: str) -> dict:
         """Does the request and auth"""
+        # _endpoint_tracker_queue will only be initialized if inside the endpoint_tracker context manager
+        if self._endpoint_tracker_queue:
+            self._endpoint_tracker_queue.put(url)
         headers = {
             "Content-Type": "application/json",
             "Authorization": f"Bearer {self.access_token}",

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: kensho-kfinance
-Version: 2.6.5
+Version: 2.7.0
 Summary: Python CLI for kFinance
 Author-email: Luke Brown <luke.brown@kensho.com>, Michelle Keoy <michelle.keoy@kensho.com>, Keith Page <keith.page@kensho.com>, Matthew Rosen <matthew.rosen@kensho.com>, Nick Roshdieh <nick.roshdieh@kensho.com>
 Project-URL: source, https://github.com/kensho-technologies/kfinance

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: kensho-kfinance
-Version: 2.6.5
+Version: 2.7.0
 Summary: Python CLI for kFinance
 Author-email: Luke Brown <luke.brown@kensho.com>, Michelle Keoy <michelle.keoy@kensho.com>, Keith Page <keith.page@kensho.com>, Matthew Rosen <matthew.rosen@kensho.com>, Nick Roshdieh <nick.roshdieh@kensho.com>
 Project-URL: source, https://github.com/kensho-technologies/kfinance

@@ -1,5 +1,8 @@
 # Changelog
+## v2.7.0
+ - Expose a new list of LLM tools `grounding_tools` that return a list of all endpoint urls called
 ## v2.6.5
  - Add competitor company_name

@@ -1663,6 +1663,11 @@ class Client:
         """
         return {t.name: t.run_without_langchain for t in self.langchain_tools}
+    @property
+    def grounding_tools(self) -> dict[str, Callable]:
+        """Return a mapping of tool calling function names to the corresponding functions for the grounding agent."""
+        return {t.name: t.run_with_grounding for t in self.langchain_tools}
     @property
     def anthropic_tool_descriptions(self) -> list[dict[str, Any]]:
         """Return tool descriptions for anthropic"""

@@ -722,6 +722,34 @@ class TestGetCompetitorsFromIdentifier:
         assert response == expected_competitors_response
+class TestGetEndpointsFromToolCallsWithGrounding:
+    def test_get_info_from_identifier_with_grounding(
+        self, mock_client: Client, requests_mock: Mocker
+    ):
+        """
+        GIVEN a KfinanceTool tool
+        WHEN we run the tool with `run_with_grounding`
+        THEN we get back endpoint urls in addition to the usual tool response.
+        """
+        # truncated from the original
+        resp_data = "{'name': 'S&P Global Inc.', 'status': 'Operating'}"
+        resp_endpoint = [
+            "https://kfinance.kensho.com/api/v1/id/SPGI",
+            "https://kfinance.kensho.com/api/v1/info/21719",
+        ]
+        expected_resp = {"data": resp_data, "endpoint_urls": resp_endpoint}
+        requests_mock.get(
+            url=f"https://kfinance.kensho.com/api/v1/info/{SPGI_COMPANY_ID}",
+            json=resp_data,
+        )
+        tool = GetInfoFromIdentifier(kfinance_client=mock_client)
+        resp = tool.run_with_grounding(identifier="SPGI")
+        assert resp == expected_resp
 class TestValidQuarter:
     class QuarterModel(BaseModel):
         quarter: ValidQuarter | None

kensho-kfinance 2.6.5tar.gz → 2.7.0tar.gz

Potentially problematic release.

@@ -40,6 +40,25 @@ class KfinanceTool(BaseTool):
         args_dict = {k: v for k, v in args_dict.items() if k in kwargs}
         return self._run(**args_dict)
+    def run_with_grounding(self, *args: Any, **kwargs: Any) -> Any:
+        """Execute a Kfinance tool with grounding support.
+        This is a wrapper around the `run_without_langchain` method that adds grounding
+        support, for returning the endpoint urls along with the data as citation info for the LRA Data Agent.
+        """
+        with self.kfinance_client.kfinance_api_client.endpoint_tracker() as endpoint_tracker_queue:
+            data = self.run_without_langchain(*args, **kwargs)
+            # After completion of tool data fetching and within the endpoint_tracker context manager scope, dequeue the endpoint_tracker_queue
+            endpoint_urls = []
+            while not endpoint_tracker_queue.empty():
+                endpoint_urls.append(endpoint_tracker_queue.get())
+            return {
+                "data": data,
+                "endpoint_urls": endpoint_urls,
+            }
     def _run(self, *args: Any, **kwargs: Any) -> Any:
         """The code to execute the tool"""
         ...

@@ -17,5 +17,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
-__version__ = version = '2.6.5'
-__version_tuple__ = version_tuple = (2, 6, 5)
+__version__ = version = '2.7.0'
+__version_tuple__ = version_tuple = (2, 7, 0)

kensho-kfinance 2.6.5__tar.gz → 2.7.0__tar.gz

Potentially problematic release.

kensho-kfinance 2.6.5tar.gz → 2.7.0tar.gz