mirror of
https://github.com/hwchase17/langchain.git
synced 2026-04-03 19:04:23 +00:00
Use docusaurus versioning with a callout, merged master as well @hwchase17 @baskaryan --------- Signed-off-by: Weichen Xu <weichen.xu@databricks.com> Signed-off-by: Rahul Tripathi <rauhl.psit.ec@gmail.com> Co-authored-by: Leonid Ganeline <leo.gan.57@gmail.com> Co-authored-by: Leonid Kuligin <lkuligin@yandex.ru> Co-authored-by: Averi Kitsch <akitsch@google.com> Co-authored-by: Erick Friis <erick@langchain.dev> Co-authored-by: Nuno Campos <nuno@langchain.dev> Co-authored-by: Nuno Campos <nuno@boringbits.io> Co-authored-by: Bagatur <22008038+baskaryan@users.noreply.github.com> Co-authored-by: Eugene Yurtsev <eyurtsev@gmail.com> Co-authored-by: Martín Gotelli Ferenaz <martingotelliferenaz@gmail.com> Co-authored-by: Fayfox <admin@fayfox.com> Co-authored-by: Eugene Yurtsev <eugene@langchain.dev> Co-authored-by: Dawson Bauer <105886620+djbauer2@users.noreply.github.com> Co-authored-by: Ravindu Somawansa <ravindu.somawansa@gmail.com> Co-authored-by: Dhruv Chawla <43818888+Dominastorm@users.noreply.github.com> Co-authored-by: ccurme <chester.curme@gmail.com> Co-authored-by: Bagatur <baskaryan@gmail.com> Co-authored-by: WeichenXu <weichen.xu@databricks.com> Co-authored-by: Benito Geordie <89472452+benitoThree@users.noreply.github.com> Co-authored-by: kartikTAI <129414343+kartikTAI@users.noreply.github.com> Co-authored-by: Kartik Sarangmath <kartik@thirdai.com> Co-authored-by: Sevin F. Varoglu <sfvaroglu@octoml.ai> Co-authored-by: MacanPN <martin.triska@gmail.com> Co-authored-by: Prashanth Rao <35005448+prrao87@users.noreply.github.com> Co-authored-by: Hyeongchan Kim <kozistr@gmail.com> Co-authored-by: sdan <git@sdan.io> Co-authored-by: Guangdong Liu <liugddx@gmail.com> Co-authored-by: Rahul Triptahi <rahul.psit.ec@gmail.com> Co-authored-by: Rahul Tripathi <rauhl.psit.ec@gmail.com> Co-authored-by: pjb157 <84070455+pjb157@users.noreply.github.com> Co-authored-by: Eun Hye Kim <ehkim1440@gmail.com> Co-authored-by: kaijietti <43436010+kaijietti@users.noreply.github.com> Co-authored-by: Pengcheng Liu <pcliu.fd@gmail.com> Co-authored-by: Tomer Cagan <tomer@tomercagan.com> Co-authored-by: Christophe Bornet <cbornet@hotmail.com>
65 lines
2.0 KiB
Plaintext
65 lines
2.0 KiB
Plaintext
# Dataherald
|
|
|
|
>[Dataherald](https://www.dataherald.com) is a natural language-to-SQL.
|
|
|
|
This page covers how to use the `Dataherald API` within LangChain.
|
|
|
|
## Installation and Setup
|
|
- Install requirements with
|
|
```bash
|
|
pip install dataherald
|
|
```
|
|
- Go to dataherald and sign up [here](https://www.dataherald.com)
|
|
- Create an app and get your `API KEY`
|
|
- Set your `API KEY` as an environment variable `DATAHERALD_API_KEY`
|
|
|
|
|
|
## Wrappers
|
|
|
|
### Utility
|
|
|
|
There exists a DataheraldAPIWrapper utility which wraps this API. To import this utility:
|
|
|
|
```python
|
|
from langchain_community.utilities.dataherald import DataheraldAPIWrapper
|
|
```
|
|
|
|
For a more detailed walkthrough of this wrapper, see [this notebook](/docs/integrations/tools/dataherald).
|
|
|
|
### Tool
|
|
|
|
You can use the tool in an agent like this:
|
|
```python
|
|
from langchain_community.utilities.dataherald import DataheraldAPIWrapper
|
|
from langchain_community.tools.dataherald.tool import DataheraldTextToSQL
|
|
from langchain_openai import ChatOpenAI
|
|
from langchain import hub
|
|
from langchain.agents import AgentExecutor, create_react_agent, load_tools
|
|
|
|
api_wrapper = DataheraldAPIWrapper(db_connection_id="<db_connection_id>")
|
|
tool = DataheraldTextToSQL(api_wrapper=api_wrapper)
|
|
llm = ChatOpenAI(model="gpt-3.5-turbo", temperature=0)
|
|
prompt = hub.pull("hwchase17/react")
|
|
agent = create_react_agent(llm, tools, prompt)
|
|
agent_executor = AgentExecutor(agent=agent, tools=tools, verbose=True)
|
|
agent_executor.invoke({"input":"Return the sql for this question: How many employees are in the company?"})
|
|
```
|
|
|
|
Output
|
|
```shell
|
|
> Entering new AgentExecutor chain...
|
|
I need to use a tool that can convert this question into SQL.
|
|
Action: dataherald
|
|
Action Input: How many employees are in the company?Answer: SELECT
|
|
COUNT(*) FROM employeesI now know the final answer
|
|
Final Answer: SELECT
|
|
COUNT(*)
|
|
FROM
|
|
employees
|
|
|
|
> Finished chain.
|
|
{'input': 'Return the sql for this question: How many employees are in the company?', 'output': "SELECT \n COUNT(*)\nFROM \n employees"}
|
|
```
|
|
|
|
For more information on tools, see [this page](/docs/modules/tools/).
|