mirror of
https://github.com/hwchase17/langchain
synced 2024-11-11 19:11:02 +00:00
987099cfcd
Added missed docstrings. Formatted docstrings to the consistent form. --------- Co-authored-by: ccurme <chester.curme@gmail.com>
43 lines
1.2 KiB
Python
43 lines
1.2 KiB
Python
"""Toolkit for interacting with Spark SQL."""
|
|
|
|
from typing import List
|
|
|
|
from langchain_core.language_models import BaseLanguageModel
|
|
from langchain_core.pydantic_v1 import Field
|
|
from langchain_core.tools import BaseToolkit
|
|
|
|
from langchain_community.tools import BaseTool
|
|
from langchain_community.tools.spark_sql.tool import (
|
|
InfoSparkSQLTool,
|
|
ListSparkSQLTool,
|
|
QueryCheckerTool,
|
|
QuerySparkSQLTool,
|
|
)
|
|
from langchain_community.utilities.spark_sql import SparkSQL
|
|
|
|
|
|
class SparkSQLToolkit(BaseToolkit):
|
|
"""Toolkit for interacting with Spark SQL.
|
|
|
|
Parameters:
|
|
db: SparkSQL. The Spark SQL database.
|
|
llm: BaseLanguageModel. The language model.
|
|
"""
|
|
|
|
db: SparkSQL = Field(exclude=True)
|
|
llm: BaseLanguageModel = Field(exclude=True)
|
|
|
|
class Config:
|
|
"""Configuration for this pydantic object."""
|
|
|
|
arbitrary_types_allowed = True
|
|
|
|
def get_tools(self) -> List[BaseTool]:
|
|
"""Get the tools in the toolkit."""
|
|
return [
|
|
QuerySparkSQLTool(db=self.db),
|
|
InfoSparkSQLTool(db=self.db),
|
|
ListSparkSQLTool(db=self.db),
|
|
QueryCheckerTool(db=self.db, llm=self.llm),
|
|
]
|