github/langchain
1
0
Fork 0
mirror of https://github.com/hwchase17/langchain.git synced 2025-07-17 10:13:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

More missing type annotations (#9406)

Browse Source 
This PR fills in more missing type annotations on pydantic models. 

It's OK if it missed some annotations, we just don't want it to get
annotations wrong at this stage.

I'll do a few more passes over the same files!
This commit is contained in:
Eugene Yurtsev 2023-08-17 12:19:50 -04:00 committed by GitHub
parent 7e63270e04
commit 77b359edf5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
42 changed files with 116 additions and 116 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
libs/langchain/langchain/agents/agent_toolkits/openapi/planner.py
View File

@ -66,7 +66,7 @@ def _get_default_llm_chain_factory(
class RequestsGetToolWithParsing(BaseRequestsTool, BaseTool): class RequestsGetToolWithParsing(BaseRequestsTool, BaseTool):
"""Requests GET tool with LLM-instructed extraction of truncated responses.""" """Requests GET tool with LLM-instructed extraction of truncated responses."""
name = "requests_get" name: str = "requests_get"
"""Tool name.""" """Tool name."""
description = REQUESTS_GET_TOOL_DESCRIPTION description = REQUESTS_GET_TOOL_DESCRIPTION
"""Tool description.""" """Tool description."""
@ -96,7 +96,7 @@ class RequestsGetToolWithParsing(BaseRequestsTool, BaseTool):
class RequestsPostToolWithParsing(BaseRequestsTool, BaseTool): class RequestsPostToolWithParsing(BaseRequestsTool, BaseTool):
"""Requests POST tool with LLM-instructed extraction of truncated responses.""" """Requests POST tool with LLM-instructed extraction of truncated responses."""
name = "requests_post" name: str = "requests_post"
"""Tool name.""" """Tool name."""
description = REQUESTS_POST_TOOL_DESCRIPTION description = REQUESTS_POST_TOOL_DESCRIPTION
"""Tool description.""" """Tool description."""
@ -125,7 +125,7 @@ class RequestsPostToolWithParsing(BaseRequestsTool, BaseTool):
class RequestsPatchToolWithParsing(BaseRequestsTool, BaseTool): class RequestsPatchToolWithParsing(BaseRequestsTool, BaseTool):
"""Requests PATCH tool with LLM-instructed extraction of truncated responses.""" """Requests PATCH tool with LLM-instructed extraction of truncated responses."""
name = "requests_patch" name: str = "requests_patch"
"""Tool name.""" """Tool name."""
description = REQUESTS_PATCH_TOOL_DESCRIPTION description = REQUESTS_PATCH_TOOL_DESCRIPTION
"""Tool description.""" """Tool description."""
@ -154,7 +154,7 @@ class RequestsPatchToolWithParsing(BaseRequestsTool, BaseTool):
class RequestsDeleteToolWithParsing(BaseRequestsTool, BaseTool): class RequestsDeleteToolWithParsing(BaseRequestsTool, BaseTool):
"""A tool that sends a DELETE request and parses the response.""" """A tool that sends a DELETE request and parses the response."""
name = "requests_delete" name: str = "requests_delete"
"""The name of the tool.""" """The name of the tool."""
description = REQUESTS_DELETE_TOOL_DESCRIPTION description = REQUESTS_DELETE_TOOL_DESCRIPTION
"""The description of the tool.""" """The description of the tool."""

4
libs/langchain/langchain/agents/openai_functions_agent/agent_token_buffer_memory.py
View File

@ -18,8 +18,8 @@ class AgentTokenBufferMemory(BaseChatMemory):
"""The max number of tokens to keep in the buffer. """The max number of tokens to keep in the buffer.
Once the buffer exceeds this many tokens, the oldest messages will be pruned.""" Once the buffer exceeds this many tokens, the oldest messages will be pruned."""
return_messages: bool = True return_messages: bool = True
output_key = "output" output_key: str = "output"
intermediate_steps_key = "intermediate_steps" intermediate_steps_key: str = "intermediate_steps"
@property @property
def buffer(self) -> List[BaseMessage]: def buffer(self) -> List[BaseMessage]:

4
libs/langchain/langchain/agents/tools.py
View File

@ -11,8 +11,8 @@ from langchain.tools.base import BaseTool, Tool, tool
class InvalidTool(BaseTool): class InvalidTool(BaseTool):
"""Tool that is run when invalid tool name is encountered by agent.""" """Tool that is run when invalid tool name is encountered by agent."""
name = "invalid_tool" name: str = "invalid_tool"
description = "Called when tool name is invalid. Suggests valid tool names." description: str = "Called when tool name is invalid. Suggests valid tool names."
def _run( def _run(
self, self,

8
libs/langchain/langchain/callbacks/argilla_callback.py
View File

@ -52,11 +52,11 @@ class ArgillaCallbackHandler(BaseCallbackHandler):
"Argilla, no doubt about it." "Argilla, no doubt about it."
""" """
REPO_URL = "https://github.com/argilla-io/argilla" REPO_URL: str = "https://github.com/argilla-io/argilla"
ISSUES_URL = f"{REPO_URL}/issues" ISSUES_URL: str = f"{REPO_URL}/issues"
BLOG_URL = "https://docs.argilla.io/en/latest/guides/llms/practical_guides/use_argilla_callback_in_langchain.html" # noqa: E501 BLOG_URL: str = "https://docs.argilla.io/en/latest/guides/llms/practical_guides/use_argilla_callback_in_langchain.html" # noqa: E501
DEFAULT_API_URL = "http://localhost:6900" DEFAULT_API_URL: str = "http://localhost:6900"
def __init__( def __init__(
self, self,

2
libs/langchain/langchain/callbacks/labelstudio_callback.py
View File

@ -97,7 +97,7 @@ class LabelStudioCallbackHandler(BaseCallbackHandler):
>>> llm.predict('Tell me a story about a dog.') >>> llm.predict('Tell me a story about a dog.')
""" """
DEFAULT_PROJECT_NAME = "LangChain-%Y-%m-%d" DEFAULT_PROJECT_NAME: str = "LangChain-%Y-%m-%d"
def __init__( def __init__(
self, self,

2
libs/langchain/langchain/callbacks/tracers/evaluation.py
View File

@ -62,7 +62,7 @@ class EvaluatorCallbackHandler(BaseTracer):
The LangSmith project name to be organize eval chain runs under. The LangSmith project name to be organize eval chain runs under.
""" """
name = "evaluator_callback_handler" name: str = "evaluator_callback_handler"
def __init__( def __init__(
self, self,

2
libs/langchain/langchain/callbacks/tracers/run_collector.py
View File

@ -19,7 +19,7 @@ class RunCollectorCallbackHandler(BaseTracer):
The ID of the example being traced. It can be either a UUID or a string. The ID of the example being traced. It can be either a UUID or a string.
""" """
name = "run-collector_callback_handler" name: str = "run-collector_callback_handler"
def __init__( def __init__(
self, example_id: Optional[Union[UUID, str]] = None, **kwargs: Any self, example_id: Optional[Union[UUID, str]] = None, **kwargs: Any

4
libs/langchain/langchain/callbacks/tracers/stdout.py
View File

@ -44,7 +44,7 @@ def elapsed(run: Any) -> str:
class FunctionCallbackHandler(BaseTracer): class FunctionCallbackHandler(BaseTracer):
"""Tracer that calls a function with a single str parameter.""" """Tracer that calls a function with a single str parameter."""
name = "function_callback_handler" name: str = "function_callback_handler"
def __init__(self, function: Callable[[str], None], **kwargs: Any) -> None: def __init__(self, function: Callable[[str], None], **kwargs: Any) -> None:
super().__init__(**kwargs) super().__init__(**kwargs)
@ -172,7 +172,7 @@ class FunctionCallbackHandler(BaseTracer):
class ConsoleCallbackHandler(FunctionCallbackHandler): class ConsoleCallbackHandler(FunctionCallbackHandler):
"""Tracer that prints to the console.""" """Tracer that prints to the console."""
name = "console_callback_handler" name: str = "console_callback_handler"
def __init__(self, **kwargs: Any) -> None: def __init__(self, **kwargs: Any) -> None:
super().__init__(function=print, **kwargs) super().__init__(function=print, **kwargs)

6
libs/langchain/langchain/chains/graph_qa/arangodb.py
View File

@ -29,10 +29,10 @@ class ArangoGraphQAChain(Chain):
output_key: str = "result" #: :meta private: output_key: str = "result" #: :meta private:
# Specifies the maximum number of AQL Query Results to return # Specifies the maximum number of AQL Query Results to return
top_k = 10 top_k: int = 10
# Specifies the set of AQL Query Examples that promote few-shot-learning # Specifies the set of AQL Query Examples that promote few-shot-learning
aql_examples = "" aql_examples: str = ""
# Specify whether to return the AQL Query in the output dictionary # Specify whether to return the AQL Query in the output dictionary
return_aql_query: bool = False return_aql_query: bool = False
@ -41,7 +41,7 @@ class ArangoGraphQAChain(Chain):
return_aql_result: bool = False return_aql_result: bool = False
# Specify the maximum amount of AQL Generation attempts that should be made # Specify the maximum amount of AQL Generation attempts that should be made
max_aql_generation_attempts = 3 max_aql_generation_attempts: int = 3
@property @property
def input_keys(self) -> List[str]: def input_keys(self) -> List[str]:

2
libs/langchain/langchain/chat_models/azureml_endpoint.py
View File

@ -18,7 +18,7 @@ from langchain.utils import get_from_dict_or_env
class LlamaContentFormatter(ContentFormatterBase): class LlamaContentFormatter(ContentFormatterBase):
"""Content formatter for `LLaMA`.""" """Content formatter for `LLaMA`."""
SUPPORTED_ROLES = ["user", "assistant", "system"] SUPPORTED_ROLES: List[str] = ["user", "assistant", "system"]
@staticmethod @staticmethod
def _convert_message_to_dict(message: BaseMessage) -> Dict: def _convert_message_to_dict(message: BaseMessage) -> Dict:

2
libs/langchain/langchain/llms/edenai.py
View File

@ -30,7 +30,7 @@ class EdenAI(LLM):
for api reference check edenai documentation: http://docs.edenai.co. for api reference check edenai documentation: http://docs.edenai.co.
""" """
base_url = "https://api.edenai.run/v2" base_url: str = "https://api.edenai.run/v2"
edenai_api_key: Optional[str] = None edenai_api_key: Optional[str] = None

2
libs/langchain/langchain/llms/ollama.py
View File

@ -23,7 +23,7 @@ def _stream_response_to_generation_chunk(
class _OllamaCommon(BaseLanguageModel): class _OllamaCommon(BaseLanguageModel):
base_url = "http://localhost:11434" base_url: str = "http://localhost:11434"
"""Base url the model is hosted under.""" """Base url the model is hosted under."""
model: str = "llama2" model: str = "llama2"

2
libs/langchain/langchain/text_splitter.py
View File

@ -592,7 +592,7 @@ class SentenceTransformersTokenTextSplitter(TextSplitter):
def count_tokens(self, *, text: str) -> int: def count_tokens(self, *, text: str) -> int:
return len(self._encode(text)) return len(self._encode(text))
_max_length_equal_32_bit_integer = 2**32 _max_length_equal_32_bit_integer: int = 2**32
def _encode(self, text: str) -> List[int]: def _encode(self, text: str) -> List[int]:
token_ids_with_start_and_end_token_ids = self.tokenizer.encode( token_ids_with_start_and_end_token_ids = self.tokenizer.encode(

4
libs/langchain/langchain/tools/arxiv/tool.py
View File

@ -11,8 +11,8 @@ from langchain.utilities.arxiv import ArxivAPIWrapper
class ArxivQueryRun(BaseTool): class ArxivQueryRun(BaseTool):
"""Tool that searches the Arxiv API.""" """Tool that searches the Arxiv API."""
name = "arxiv" name: str = "arxiv"
description = ( description: str = (
"A wrapper around Arxiv.org " "A wrapper around Arxiv.org "
"Useful for when you need to answer questions about Physics, Mathematics, " "Useful for when you need to answer questions about Physics, Mathematics, "
"Computer Science, Quantitative Biology, Quantitative Finance, Statistics, " "Computer Science, Quantitative Biology, Quantitative Finance, Statistics, "

4
libs/langchain/langchain/tools/azure_cognitive_services/form_recognizer.py
View File

@ -23,8 +23,8 @@ class AzureCogsFormRecognizerTool(BaseTool):
azure_cogs_endpoint: str = "" #: :meta private: azure_cogs_endpoint: str = "" #: :meta private:
doc_analysis_client: Any #: :meta private: doc_analysis_client: Any #: :meta private:
name = "azure_cognitive_services_form_recognizer" name: str = "azure_cognitive_services_form_recognizer"
description = ( description: str = (
"A wrapper around Azure Cognitive Services Form Recognizer. " "A wrapper around Azure Cognitive Services Form Recognizer. "
"Useful for when you need to " "Useful for when you need to "
"extract text, tables, and key-value pairs from documents. " "extract text, tables, and key-value pairs from documents. "

4
libs/langchain/langchain/tools/azure_cognitive_services/image_analysis.py
View File

@ -24,8 +24,8 @@ class AzureCogsImageAnalysisTool(BaseTool):
vision_service: Any #: :meta private: vision_service: Any #: :meta private:
analysis_options: Any #: :meta private: analysis_options: Any #: :meta private:
name = "azure_cognitive_services_image_analysis" name: str = "azure_cognitive_services_image_analysis"
description = ( description: str = (
"A wrapper around Azure Cognitive Services Image Analysis. " "A wrapper around Azure Cognitive Services Image Analysis. "
"Useful for when you need to analyze images. " "Useful for when you need to analyze images. "
"Input should be a url to an image." "Input should be a url to an image."

4
libs/langchain/langchain/tools/azure_cognitive_services/speech2text.py
View File

@ -28,8 +28,8 @@ class AzureCogsSpeech2TextTool(BaseTool):
speech_language: str = "en-US" #: :meta private: speech_language: str = "en-US" #: :meta private:
speech_config: Any #: :meta private: speech_config: Any #: :meta private:
name = "azure_cognitive_services_speech2text" name: str = "azure_cognitive_services_speech2text"
description = ( description: str = (
"A wrapper around Azure Cognitive Services Speech2Text. " "A wrapper around Azure Cognitive Services Speech2Text. "
"Useful for when you need to transcribe audio to text. " "Useful for when you need to transcribe audio to text. "
"Input should be a url to an audio file." "Input should be a url to an audio file."

4
libs/langchain/langchain/tools/azure_cognitive_services/text2speech.py
View File

@ -24,8 +24,8 @@ class AzureCogsText2SpeechTool(BaseTool):
speech_language: str = "en-US" #: :meta private: speech_language: str = "en-US" #: :meta private:
speech_config: Any #: :meta private: speech_config: Any #: :meta private:
name = "azure_cognitive_services_text2speech" name: str = "azure_cognitive_services_text2speech"
description = ( description: str = (
"A wrapper around Azure Cognitive Services Text2Speech. " "A wrapper around Azure Cognitive Services Text2Speech. "
"Useful for when you need to convert text to speech. " "Useful for when you need to convert text to speech. "
) )

4
libs/langchain/langchain/tools/base.py
View File

@ -55,8 +55,8 @@ def _get_filtered_args(
class _SchemaConfig: class _SchemaConfig:
"""Configuration for the pydantic model.""" """Configuration for the pydantic model."""
extra = Extra.forbid extra: Any = Extra.forbid
arbitrary_types_allowed = True arbitrary_types_allowed: bool = True
def create_schema_from_function( def create_schema_from_function(

8
libs/langchain/langchain/tools/bing_search/tool.py
View File

@ -10,8 +10,8 @@ from langchain.utilities.bing_search import BingSearchAPIWrapper
class BingSearchRun(BaseTool): class BingSearchRun(BaseTool):
"""Tool that queries the Bing search API.""" """Tool that queries the Bing search API."""
name = "bing_search" name: str = "bing_search"
description = ( description: str = (
"A wrapper around Bing Search. " "A wrapper around Bing Search. "
"Useful for when you need to answer questions about current events. " "Useful for when you need to answer questions about current events. "
"Input should be a search query." "Input should be a search query."
@ -30,8 +30,8 @@ class BingSearchRun(BaseTool):
class BingSearchResults(BaseTool): class BingSearchResults(BaseTool):
"""Tool that queries the Bing Search API and gets back json.""" """Tool that queries the Bing Search API and gets back json."""
name = "Bing Search Results JSON" name: str = "Bing Search Results JSON"
description = ( description: str = (
"A wrapper around Bing Search. " "A wrapper around Bing Search. "
"Useful for when you need to answer questions about current events. " "Useful for when you need to answer questions about current events. "
"Input should be a search query. Output is a JSON array of the query results" "Input should be a search query. Output is a JSON array of the query results"

4
libs/langchain/langchain/tools/brave_search/tool.py
View File

@ -10,8 +10,8 @@ from langchain.utilities.brave_search import BraveSearchWrapper
class BraveSearch(BaseTool): class BraveSearch(BaseTool):
"""Tool that queries the BraveSearch.""" """Tool that queries the BraveSearch."""
name = "brave_search" name: str = "brave_search"
description = ( description: str = (
"a search engine. " "a search engine. "
"useful for when you need to answer questions about current events." "useful for when you need to answer questions about current events."
" input should be a search query." " input should be a search query."

8
libs/langchain/langchain/tools/dataforseo_api_search/tool.py
View File

@ -14,8 +14,8 @@ from langchain.utilities.dataforseo_api_search import DataForSeoAPIWrapper
class DataForSeoAPISearchRun(BaseTool): class DataForSeoAPISearchRun(BaseTool):
"""Tool that queries the DataForSeo Google search API.""" """Tool that queries the DataForSeo Google search API."""
name = "dataforseo_api_search" name: str = "dataforseo_api_search"
description = ( description: str = (
"A robust Google Search API provided by DataForSeo." "A robust Google Search API provided by DataForSeo."
"This tool is handy when you need information about trending topics " "This tool is handy when you need information about trending topics "
"or current events." "or current events."
@ -43,8 +43,8 @@ class DataForSeoAPISearchResults(BaseTool):
"""Tool that queries the DataForSeo Google Search API """Tool that queries the DataForSeo Google Search API
and get back json.""" and get back json."""
name = "DataForSeo Results JSON" name: str = "DataForSeo Results JSON"
description = ( description: str = (
"A comprehensive Google Search API provided by DataForSeo." "A comprehensive Google Search API provided by DataForSeo."
"This tool is useful for obtaining real-time data on current events " "This tool is useful for obtaining real-time data on current events "
"or popular searches." "or popular searches."

8
libs/langchain/langchain/tools/ddg_search/tool.py
View File

@ -12,8 +12,8 @@ from langchain.utilities.duckduckgo_search import DuckDuckGoSearchAPIWrapper
class DuckDuckGoSearchRun(BaseTool): class DuckDuckGoSearchRun(BaseTool):
"""Tool that queries the DuckDuckGo search API.""" """Tool that queries the DuckDuckGo search API."""
name = "duckduckgo_search" name: str = "duckduckgo_search"
description = ( description: str = (
"A wrapper around DuckDuckGo Search. " "A wrapper around DuckDuckGo Search. "
"Useful for when you need to answer questions about current events. " "Useful for when you need to answer questions about current events. "
"Input should be a search query." "Input should be a search query."
@ -34,8 +34,8 @@ class DuckDuckGoSearchRun(BaseTool):
class DuckDuckGoSearchResults(BaseTool): class DuckDuckGoSearchResults(BaseTool):
"""Tool that queries the DuckDuckGo search API and gets back json.""" """Tool that queries the DuckDuckGo search API and gets back json."""
name = "DuckDuckGo Results JSON" name: str = "DuckDuckGo Results JSON"
description = ( description: str = (
"A wrapper around Duck Duck Go Search. " "A wrapper around Duck Duck Go Search. "
"Useful for when you need to answer questions about current events. " "Useful for when you need to answer questions about current events. "
"Input should be a search query. Output is a JSON array of the query results" "Input should be a search query. Output is a JSON array of the query results"

4
libs/langchain/langchain/tools/github/tool.py
View File

@ -20,8 +20,8 @@ class GitHubAction(BaseTool):
api_wrapper: GitHubAPIWrapper = Field(default_factory=GitHubAPIWrapper) api_wrapper: GitHubAPIWrapper = Field(default_factory=GitHubAPIWrapper)
mode: str mode: str
name = "" name: str = ""
description = "" description: str = ""
def _run( def _run(
self, self,

4
libs/langchain/langchain/tools/golden_query/tool.py
View File

@ -10,8 +10,8 @@ from langchain.utilities.golden_query import GoldenQueryAPIWrapper
class GoldenQueryRun(BaseTool): class GoldenQueryRun(BaseTool):
"""Tool that adds the capability to query using the Golden API and get back JSON.""" """Tool that adds the capability to query using the Golden API and get back JSON."""
name = "Golden Query" name: str = "Golden Query"
description = ( description: str = (
"A wrapper around Golden Query API." "A wrapper around Golden Query API."
" Useful for getting entities that match" " Useful for getting entities that match"
" a natural language query from Golden's Knowledge Base." " a natural language query from Golden's Knowledge Base."

8
libs/langchain/langchain/tools/google_search/tool.py
View File

@ -10,8 +10,8 @@ from langchain.utilities.google_search import GoogleSearchAPIWrapper
class GoogleSearchRun(BaseTool): class GoogleSearchRun(BaseTool):
"""Tool that queries the Google search API.""" """Tool that queries the Google search API."""
name = "google_search" name: str = "google_search"
description = ( description: str = (
"A wrapper around Google Search. " "A wrapper around Google Search. "
"Useful for when you need to answer questions about current events. " "Useful for when you need to answer questions about current events. "
"Input should be a search query." "Input should be a search query."
@ -30,8 +30,8 @@ class GoogleSearchRun(BaseTool):
class GoogleSearchResults(BaseTool): class GoogleSearchResults(BaseTool):
"""Tool that queries the Google Search API and gets back json.""" """Tool that queries the Google Search API and gets back json."""
name = "Google Search Results JSON" name: str = "Google Search Results JSON"
description = ( description: str = (
"A wrapper around Google Search. " "A wrapper around Google Search. "
"Useful for when you need to answer questions about current events. " "Useful for when you need to answer questions about current events. "
"Input should be a search query. Output is a JSON array of the query results" "Input should be a search query. Output is a JSON array of the query results"

8
libs/langchain/langchain/tools/google_serper/tool.py
View File

@ -14,8 +14,8 @@ from langchain.utilities.google_serper import GoogleSerperAPIWrapper
class GoogleSerperRun(BaseTool): class GoogleSerperRun(BaseTool):
"""Tool that queries the Serper.dev Google search API.""" """Tool that queries the Serper.dev Google search API."""
name = "google_serper" name: str = "google_serper"
description = ( description: str = (
"A low-cost Google Search API." "A low-cost Google Search API."
"Useful for when you need to answer questions about current events." "Useful for when you need to answer questions about current events."
"Input should be a search query." "Input should be a search query."
@ -43,8 +43,8 @@ class GoogleSerperResults(BaseTool):
"""Tool that queries the Serper.dev Google Search API """Tool that queries the Serper.dev Google Search API
and get back json.""" and get back json."""
name = "google_serrper_results_json" name: str = "google_serrper_results_json"
description = ( description: str = (
"A low-cost Google Search API." "A low-cost Google Search API."
"Useful for when you need to answer questions about current events." "Useful for when you need to answer questions about current events."
"Input should be a search query. Output is a JSON object of the query results" "Input should be a search query. Output is a JSON object of the query results"

4
libs/langchain/langchain/tools/graphql/tool.py
View File

@ -11,8 +11,8 @@ class BaseGraphQLTool(BaseTool):
graphql_wrapper: GraphQLAPIWrapper graphql_wrapper: GraphQLAPIWrapper
name = "query_graphql" name: str = "query_graphql"
description = """\ description: str = """\
Input to this tool is a detailed and correct GraphQL query, output is a result from the API. Input to this tool is a detailed and correct GraphQL query, output is a result from the API.
If the query is not correct, an error message will be returned. If the query is not correct, an error message will be returned.
If an error is returned with 'Bad request' in it, rewrite the query and try again. If an error is returned with 'Bad request' in it, rewrite the query and try again.

4
libs/langchain/langchain/tools/human/tool.py
View File

@ -15,8 +15,8 @@ def _print_func(text: str) -> None:
class HumanInputRun(BaseTool): class HumanInputRun(BaseTool):
"""Tool that asks user for input.""" """Tool that asks user for input."""
name = "human" name: str = "human"
description = ( description: str = (
"You can ask a human for guidance when you think you " "You can ask a human for guidance when you think you "
"got stuck or you are not sure what to do next. " "got stuck or you are not sure what to do next. "
"The input should be a question for the human." "The input should be a question for the human."

4
libs/langchain/langchain/tools/jira/tool.py
View File

@ -41,8 +41,8 @@ class JiraAction(BaseTool):
api_wrapper: JiraAPIWrapper = Field(default_factory=JiraAPIWrapper) api_wrapper: JiraAPIWrapper = Field(default_factory=JiraAPIWrapper)
mode: str mode: str
name = "" name: str = ""
description = "" description: str = ""
def _run( def _run(
self, self,

4
libs/langchain/langchain/tools/metaphor_search/tool.py
View File

@ -13,8 +13,8 @@ from langchain.utilities.metaphor_search import MetaphorSearchAPIWrapper
class MetaphorSearchResults(BaseTool): class MetaphorSearchResults(BaseTool):
"""Tool that queries the Metaphor Search API and gets back json.""" """Tool that queries the Metaphor Search API and gets back json."""
name = "metaphor_search_results_json" name: str = "metaphor_search_results_json"
description = ( description: str = (
"A wrapper around Metaphor Search. " "A wrapper around Metaphor Search. "
"Input should be a Metaphor-optimized query. " "Input should be a Metaphor-optimized query. "
"Output is a JSON array of the query results" "Output is a JSON array of the query results"

4
libs/langchain/langchain/tools/openweathermap/tool.py
View File

@ -15,8 +15,8 @@ class OpenWeatherMapQueryRun(BaseTool):
default_factory=OpenWeatherMapAPIWrapper default_factory=OpenWeatherMapAPIWrapper
) )
name = "OpenWeatherMap" name: str = "OpenWeatherMap"
description = ( description: str = (
"A wrapper around OpenWeatherMap API. " "A wrapper around OpenWeatherMap API. "
"Useful for fetching current weather information for a specified location. " "Useful for fetching current weather information for a specified location. "
"Input should be a location string (e.g. London,GB)." "Input should be a location string (e.g. London,GB)."

12
libs/langchain/langchain/tools/powerbi/tool.py
View File

@ -24,8 +24,8 @@ logger = logging.getLogger(__name__)
class QueryPowerBITool(BaseTool): class QueryPowerBITool(BaseTool):
"""Tool for querying a Power BI Dataset.""" """Tool for querying a Power BI Dataset."""
name = "query_powerbi" name: str = "query_powerbi"
description = """ description: str = """
Input to this tool is a detailed question about the dataset, output is a result from the dataset. It will try to answer the question using the dataset, and if it cannot, it will ask for clarification. Input to this tool is a detailed question about the dataset, output is a result from the dataset. It will try to answer the question using the dataset, and if it cannot, it will ask for clarification.
Example Input: "How many rows are in table1?" Example Input: "How many rows are in table1?"
@ -217,8 +217,8 @@ class QueryPowerBITool(BaseTool):
class InfoPowerBITool(BaseTool): class InfoPowerBITool(BaseTool):
"""Tool for getting metadata about a PowerBI Dataset.""" """Tool for getting metadata about a PowerBI Dataset."""
name = "schema_powerbi" name: str = "schema_powerbi"
description = """ description: str = """
Input to this tool is a comma-separated list of tables, output is the schema and sample rows for those tables. Input to this tool is a comma-separated list of tables, output is the schema and sample rows for those tables.
Be sure that the tables actually exist by calling list_tables_powerbi first! Be sure that the tables actually exist by calling list_tables_powerbi first!
@ -250,8 +250,8 @@ class InfoPowerBITool(BaseTool):
class ListPowerBITool(BaseTool): class ListPowerBITool(BaseTool):
"""Tool for getting tables names.""" """Tool for getting tables names."""
name = "list_tables_powerbi" name: str = "list_tables_powerbi"
description = "Input is an empty string, output is a comma separated list of tables in the database." # noqa: E501 # pylint: disable=C0301 description: str = "Input is an empty string, output is a comma separated list of tables in the database." # noqa: E501 # pylint: disable=C0301
powerbi: PowerBIDataset = Field(exclude=True) powerbi: PowerBIDataset = Field(exclude=True)
class Config: class Config:

4
libs/langchain/langchain/tools/pubmed/tool.py
View File

@ -9,8 +9,8 @@ from langchain.utilities.pubmed import PubMedAPIWrapper
class PubmedQueryRun(BaseTool): class PubmedQueryRun(BaseTool):
"""Tool that searches the PubMed API.""" """Tool that searches the PubMed API."""
name = "PubMed" name: str = "PubMed"
description = ( description: str = (
"A wrapper around PubMed. " "A wrapper around PubMed. "
"Useful for when you need to answer questions about medicine, health, " "Useful for when you need to answer questions about medicine, health, "
"and biomedical topics " "and biomedical topics "

8
libs/langchain/langchain/tools/python/tool.py
View File

@ -42,8 +42,8 @@ def sanitize_input(query: str) -> str:
class PythonREPLTool(BaseTool): class PythonREPLTool(BaseTool):
"""A tool for running python code in a REPL.""" """A tool for running python code in a REPL."""
name = "Python_REPL" name: str = "Python_REPL"
description = ( description: str = (
"A Python shell. Use this to execute python commands. " "A Python shell. Use this to execute python commands. "
"Input should be a valid python command. " "Input should be a valid python command. "
"If you want to see the output of a value, you should print it out " "If you want to see the output of a value, you should print it out "
@ -80,8 +80,8 @@ class PythonREPLTool(BaseTool):
class PythonAstREPLTool(BaseTool): class PythonAstREPLTool(BaseTool):
"""A tool for running python code in a REPL.""" """A tool for running python code in a REPL."""
name = "python_repl_ast" name: str = "python_repl_ast"
description = ( description: str = (
"A Python shell. Use this to execute python commands. " "A Python shell. Use this to execute python commands. "
"Input should be a valid python command. " "Input should be a valid python command. "
"When using this tool, sometimes output is abbreviated - " "When using this tool, sometimes output is abbreviated - "

8
libs/langchain/langchain/tools/searx_search/tool.py
View File

@ -13,8 +13,8 @@ from langchain.utilities.searx_search import SearxSearchWrapper
class SearxSearchRun(BaseTool): class SearxSearchRun(BaseTool):
"""Tool that queries a Searx instance.""" """Tool that queries a Searx instance."""
name = "searx_search" name: str = "searx_search"
description = ( description: str = (
"A meta search engine." "A meta search engine."
"Useful for when you need to answer questions about current events." "Useful for when you need to answer questions about current events."
"Input should be a search query." "Input should be a search query."
@ -42,8 +42,8 @@ class SearxSearchRun(BaseTool):
class SearxSearchResults(BaseTool): class SearxSearchResults(BaseTool):
"""Tool that queries a Searx instance and gets back json.""" """Tool that queries a Searx instance and gets back json."""
name = "Searx Search Results" name: str = "Searx Search Results"
description = ( description: str = (
"A meta search engine." "A meta search engine."
"Useful for when you need to answer questions about current events." "Useful for when you need to answer questions about current events."
"Input should be a search query. Output is a JSON array of the query results" "Input should be a search query. Output is a JSON array of the query results"

4
libs/langchain/langchain/tools/steamship_image_generation/tool.py
View File

@ -48,8 +48,8 @@ class SteamshipImageGenerationTool(BaseTool):
steamship: Steamship steamship: Steamship
return_urls: Optional[bool] = False return_urls: Optional[bool] = False
name = "GenerateImage" name: str = "GenerateImage"
description = ( description: str = (
"Useful for when you need to generate an image." "Useful for when you need to generate an image."
"Input: A detailed text-2-image prompt describing an image" "Input: A detailed text-2-image prompt describing an image"
"Output: the UUID of a generated image" "Output: the UUID of a generated image"

4
libs/langchain/langchain/tools/wikipedia/tool.py
View File

@ -10,8 +10,8 @@ from langchain.utilities.wikipedia import WikipediaAPIWrapper
class WikipediaQueryRun(BaseTool): class WikipediaQueryRun(BaseTool):
"""Tool that searches the Wikipedia API.""" """Tool that searches the Wikipedia API."""
name = "Wikipedia" name: str = "Wikipedia"
description = ( description: str = (
"A wrapper around Wikipedia. " "A wrapper around Wikipedia. "
"Useful for when you need to answer general questions about " "Useful for when you need to answer general questions about "
"people, places, companies, facts, historical events, or other subjects. " "people, places, companies, facts, historical events, or other subjects. "

4
libs/langchain/langchain/tools/wolfram_alpha/tool.py
View File

@ -10,8 +10,8 @@ from langchain.utilities.wolfram_alpha import WolframAlphaAPIWrapper
class WolframAlphaQueryRun(BaseTool): class WolframAlphaQueryRun(BaseTool):
"""Tool that queries using the Wolfram Alpha SDK.""" """Tool that queries using the Wolfram Alpha SDK."""
name = "wolfram_alpha" name: str = "wolfram_alpha"
description = ( description: str = (
"A wrapper around Wolfram Alpha. " "A wrapper around Wolfram Alpha. "
"Useful for when you need to answer questions about Math, " "Useful for when you need to answer questions about Math, "
"Science, Technology, Culture, Society and Everyday Life. " "Science, Technology, Culture, Society and Everyday Life. "

4
libs/langchain/langchain/tools/youtube/search.py
View File

@ -18,8 +18,8 @@ from langchain.tools import BaseTool
class YouTubeSearchTool(BaseTool): class YouTubeSearchTool(BaseTool):
"""Tool that queries YouTube.""" """Tool that queries YouTube."""
name = "youtube_search" name: str = "youtube_search"
description = ( description: str = (
"search for youtube videos associated with a person. " "search for youtube videos associated with a person. "
"the input to this tool should be a comma separated list, " "the input to this tool should be a comma separated list, "
"the first part contains a person name and the second a " "the first part contains a person name and the second a "

8
libs/langchain/langchain/tools/zapier/tool.py
View File

@ -108,8 +108,8 @@ class ZapierNLARunAction(BaseTool):
base_prompt: str = BASE_ZAPIER_TOOL_PROMPT base_prompt: str = BASE_ZAPIER_TOOL_PROMPT
zapier_description: str zapier_description: str
params_schema: Dict[str, str] = Field(default_factory=dict) params_schema: Dict[str, str] = Field(default_factory=dict)
name = "" name: str = ""
description = "" description: str = ""
@root_validator @root_validator
def set_name_description(cls, values: Dict[str, Any]) -> Dict[str, Any]: def set_name_description(cls, values: Dict[str, Any]) -> Dict[str, Any]:
@ -167,8 +167,8 @@ class ZapierNLAListActions(BaseTool):
""" """
name = "ZapierNLA_list_actions" name: str = "ZapierNLA_list_actions"
description = BASE_ZAPIER_TOOL_PROMPT + ( description: str = BASE_ZAPIER_TOOL_PROMPT + (
"This tool returns a list of the user's exposed actions." "This tool returns a list of the user's exposed actions."
) )
api_wrapper: ZapierNLAWrapper = Field(default_factory=ZapierNLAWrapper) api_wrapper: ZapierNLAWrapper = Field(default_factory=ZapierNLAWrapper)

32
libs/langchain/tests/unit_tests/tools/test_base.py
View File

@ -43,9 +43,9 @@ class _MockSchema(BaseModel):
class _MockStructuredTool(BaseTool): class _MockStructuredTool(BaseTool):
name = "structured_api" name: str = "structured_api"
args_schema: Type[BaseModel] = _MockSchema args_schema: Type[BaseModel] = _MockSchema
description = "A Structured Tool" description: str = "A Structured Tool"
def _run(self, arg1: int, arg2: bool, arg3: Optional[dict] = None) -> str: def _run(self, arg1: int, arg2: bool, arg3: Optional[dict] = None) -> str:
return f"{arg1} {arg2} {arg3}" return f"{arg1} {arg2} {arg3}"
@ -69,10 +69,10 @@ def test_misannotated_base_tool_raises_error() -> None:
with pytest.raises(SchemaAnnotationError): with pytest.raises(SchemaAnnotationError):
class _MisAnnotatedTool(BaseTool): class _MisAnnotatedTool(BaseTool):
name = "structured_api" name: str = "structured_api"
# This would silently be ignored without the custom metaclass # This would silently be ignored without the custom metaclass
args_schema: BaseModel = _MockSchema # type: ignore args_schema: BaseModel = _MockSchema # type: ignore
description = "A Structured Tool" description: str = "A Structured Tool"
def _run(self, arg1: int, arg2: bool, arg3: Optional[dict] = None) -> str: def _run(self, arg1: int, arg2: bool, arg3: Optional[dict] = None) -> str:
return f"{arg1} {arg2} {arg3}" return f"{arg1} {arg2} {arg3}"
@ -87,9 +87,9 @@ def test_forward_ref_annotated_base_tool_accepted() -> None:
"""Test that a using forward ref annotation syntax is accepted.""" "" """Test that a using forward ref annotation syntax is accepted.""" ""
class _ForwardRefAnnotatedTool(BaseTool): class _ForwardRefAnnotatedTool(BaseTool):
name = "structured_api" name: str = "structured_api"
args_schema: "Type[BaseModel]" = _MockSchema args_schema: "Type[BaseModel]" = _MockSchema
description = "A Structured Tool" description: str = "A Structured Tool"
def _run(self, arg1: int, arg2: bool, arg3: Optional[dict] = None) -> str: def _run(self, arg1: int, arg2: bool, arg3: Optional[dict] = None) -> str:
return f"{arg1} {arg2} {arg3}" return f"{arg1} {arg2} {arg3}"
@ -104,9 +104,9 @@ def test_subclass_annotated_base_tool_accepted() -> None:
"""Test BaseTool child w/ custom schema isn't overwritten.""" """Test BaseTool child w/ custom schema isn't overwritten."""
class _ForwardRefAnnotatedTool(BaseTool): class _ForwardRefAnnotatedTool(BaseTool):
name = "structured_api" name: str = "structured_api"
args_schema: Type[_MockSchema] = _MockSchema args_schema: Type[_MockSchema] = _MockSchema
description = "A Structured Tool" description: str = "A Structured Tool"
def _run(self, arg1: int, arg2: bool, arg3: Optional[dict] = None) -> str: def _run(self, arg1: int, arg2: bool, arg3: Optional[dict] = None) -> str:
return f"{arg1} {arg2} {arg3}" return f"{arg1} {arg2} {arg3}"
@ -154,8 +154,8 @@ def test_decorated_function_schema_equivalent() -> None:
def test_args_kwargs_filtered() -> None: def test_args_kwargs_filtered() -> None:
class _SingleArgToolWithKwargs(BaseTool): class _SingleArgToolWithKwargs(BaseTool):
name = "single_arg_tool" name: str = "single_arg_tool"
description = "A single arged tool with kwargs" description: str = "A single arged tool with kwargs"
def _run( def _run(
self, self,
@ -177,8 +177,8 @@ def test_args_kwargs_filtered() -> None:
assert tool.is_single_input assert tool.is_single_input
class _VarArgToolWithKwargs(BaseTool): class _VarArgToolWithKwargs(BaseTool):
name = "single_arg_tool" name: str = "single_arg_tool"
description = "A single arged tool with kwargs" description: str = "A single arged tool with kwargs"
def _run( def _run(
self, self,
@ -269,8 +269,8 @@ def test_base_tool_inheritance_base_schema() -> None:
"""Test schema is correctly inferred when inheriting from BaseTool.""" """Test schema is correctly inferred when inheriting from BaseTool."""
class _MockSimpleTool(BaseTool): class _MockSimpleTool(BaseTool):
name = "simple_tool" name: str = "simple_tool"
description = "A Simple Tool" description: str = "A Simple Tool"
def _run(self, tool_input: str) -> str: def _run(self, tool_input: str) -> str:
return f"{tool_input}" return f"{tool_input}"
@ -593,8 +593,8 @@ async def test_create_async_tool() -> None:
class _FakeExceptionTool(BaseTool): class _FakeExceptionTool(BaseTool):
name = "exception" name: str = "exception"
description = "an exception-throwing tool" description: str = "an exception-throwing tool"
exception: Exception = ToolException() exception: Exception = ToolException()
def _run(self) -> str: def _run(self) -> str: