langchain/libs/community/langchain_community/tools/polygon/last_quote.py
Virat Singh c2a614eddc
community: Add PolygonLastQuote Tool and Toolkit (#15990)
**Description:** 
In this PR, I am adding a `PolygonLastQuote` Tool, which can be used to
get the latest price quote for a given ticker / stock.

Additionally, I've added a Polygon Toolkit, which we can use to
encapsulate future tools that we build for Polygon.

**Twitter handle:** [@virattt](https://twitter.com/virattt)

---------

Co-authored-by: Harrison Chase <hw.chase.17@gmail.com>
2024-01-21 15:08:55 -08:00

35 lines
1023 B
Python

from typing import Optional, Type
from langchain_core.callbacks import CallbackManagerForToolRun
from langchain_core.pydantic_v1 import BaseModel
from langchain_core.tools import BaseTool
from langchain_community.utilities.polygon import PolygonAPIWrapper
class Inputs(BaseModel):
query: str
class PolygonLastQuote(BaseTool):
"""Tool that gets the last quote of a ticker from Polygon"""
mode: str = "get_last_quote"
name: str = "polygon_last_quote"
description: str = (
"A wrapper around Polygon's Last Quote API. "
"This tool is useful for fetching the latest price of a stock. "
"Input should be the ticker that you want to query the last price quote for."
)
args_schema: Type[BaseModel] = Inputs
api_wrapper: PolygonAPIWrapper
def _run(
self,
query: str,
run_manager: Optional[CallbackManagerForToolRun] = None,
) -> str:
"""Use the Polygon API tool."""
return self.api_wrapper.run(self.mode, ticker=query)