tavily-chat - GitLite

KO | EN

gitlite — search

#react #llm #go #machine-learning #rust #docker #nodejs #java #windows #kubernetes #vue #awesome-list #security #mcp

tavily-chat

(★ 77)

Conversational agent that fuses chat data with live web results through Tavily search, extract, and crawl.

File Explorer

Download Latest Version (.zip)

- __init__.py
- agent.py
- prompts.py
- utils.py
- banner.png
- chatbot.gif
- chatbot.png
- logo_circle.png
- web-agent.svg
- test.ipynb
- - favicon.ico
  - tavilylogo.png
- - App.tsx
  - env.d.ts
  - index.css
  - main.tsx
  - vite-env.d.ts
- .env.sample
- .gitignore
- .prettierrc
- eslint.config.js
- index.html
- LICENSE
- package.json
- postcss.config.js
- README.md
- tailwind.config.js
- tsconfig.app.json
- tsconfig.json
- tsconfig.node.json
- vite.config.ts
.dockerignore
.env.sample
.gitignore
app.py
Dockerfile
LICENSE
README.md
requirements.txt

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Tavily Agent Example

<div align="center">
  <img src="images/chatbot.gif" alt="Tavily Agent Demo" width="800"/>
</div>

## 👋 Welcome to the Tavily Chat Web Agent Repository!

This repository provides a simple yet powerful example of building a conversational agent with real-time web access, leveraging Tavily's search, extract, and crawl capabilities.

Designed for ease of customization, you can extend this core implementation to:
- Integrate proprietary data
- Modify the chatbot architecture
- Modify LLMs

## Features

- 🔍 Intelligent question routing between base knowledge and tavily search, extract, and crawl.
- 🧠 Conversational memory with LangGraph
- 🚀 FastAPI backend with async support
- 🔄 Streaming of Agentic Substeps
- 💬 Markdown support in chat responses
- 🔗 Citations for web results
- 👁️ Observability with Weave

## Architecture Diagram
![Chatbot Demo](https://raw.githubusercontent.com/tavily-ai/tavily-chat/main/images/web-agent.svg)

## 📂 Repository Structure

This repository includes everything required to create a functional chatbot with web access:

### 📡 Backend ([`backend/`](./backend))
The core backend logic, powered by Tavily and LangGraph:
- [`agent.py`](./backend/agent.py) – Defines the ReAct agent architecture, state management, and processing nodes.
- [`prompts.py`](./backend/prompts.py) – Contains customizable prompt templates.

### 🌐 Frontend ([`ui/`](./ui))
Interactive React frontend for dynamic user interactions and chatbot responses.

### Server
- [`app.py`](./app.py) – FastAPI server that handles API endpoints and streaming responses.

---

## Setup Instructions

#### Set up environment variables:

a. Create a `.env` file in the root directory with:
   ```bash
   TAVILY_API_KEY="your-tavily-api-key"
   OPENAI_API_KEY="your-openai-api-key"
   GROQ_API_KEY="your-groq-api-key"
   VITE_APP_URL=http://localhost:5173
   ```

b. Create a `.env` file in the `ui` directory with:
   ```bash
   VITE_BACKEND_URL=http://localhost:8080
   ```

### Backend Setup
#### Python Virtual Environment
1. Create a virtual environment and activate it:
```bash
python3.11 -m venv venv
source venv/bin/activate  # On Windows: .\venv\Scripts\activate
```

2. Install dependencies:
```bash
python3.11 -m pip install -r requirements.txt
```

3. From the root of the project, run the backend server:
```bash
python app.py
```

### Frontend Setup

1. In a new terminal, navigate to the frontend directory:
```bash
cd ui
```

2. Install dependencies:
```bash
npm install
```

3. Start the development server:
```bash
npm run dev
```
Open the app in your browser at the locally hosted url (e.g. http://localhost:5173/)

## API Endpoints

- `POST /stream_agent`: Chat endpoint that handles streamed LangGraph execution

---

## Contributing

Feel free to submit issues and enhancement requests!

## 📞 Contact Us

Have questions, feedback, or looking to build something custom? We'd love to hear from you!

- Email our team directly:
  - [Dean Sacoransky](mailto:deansa@tavily.com)
  - [Michael Griff](mailto:michaelgriff@tavily.com)

---

<div align="center">
  <img src="images/logo_circle.png" alt="Tavily Logo" width="80"/>
  <p>Powered by <a href="https://tavily.com">Tavily</a> - The web API Built for AI Agents</p>
</div>