Freight Companion Search

Watch the tutorial here for a detailed guide on setting up and running this project.

This repository contains the code and instructions needed to build a sophisticated search engine that leverages the capabilities of Groq, Mistral AI's Mixtral, Langchain.JS, Brave Search, Serper API, and OpenAI. Designed to efficiently return sources, answers, images, videos, and follow-up questions based on user queries, this project is an ideal starting point for developers interested in natural language processing and search technologies.

Technologies Used

• Next.js: A React framework for building server-side rendered and static web applications.
• Tailwind CSS: A utility-first CSS framework for rapidly building custom user interfaces.
• Vercel AI SDK: The Vercel AI SDK is a library for building AI-powered streaming text and chat UIs.
• Groq & Mixtral: Technologies for processing and understanding user queries.
• Langchain.JS: A JavaScript library focused on text operations, such as text splitting and embeddings.
• Brave Search: A privacy-focused search engine used for sourcing relevant content and images.
• Serper API: Used for fetching relevant video and image results based on the user's query.
• OpenAI Embeddings: Used for creating vector representations of text chunks.
• Cheerio: Utilized for HTML parsing, allowing the extraction of content from web pages.
• Ollama (Optional): Used for streaming inference and embeddings.

Getting Started

Prerequisites

• Ensure Node.js and npm are installed on your machine.
• Obtain API keys from OpenAI, Groq, Brave Search, and Serper.

Obtaining API Keys

• OpenAI API Key: Generate your OpenAI API key here.
• Groq API Key: Get your Groq API key here.
• Brave Search API Key: Obtain your Brave Search API key here.
• Serper API Key: Get your Serper API key here.

Installation

1. Clone the repository:

   git clone https://github.com/freightcompaniondave/freight-companion-search.git
   

2. Install the required dependencies:

   npm install
   

   or

   bun install
   

3. Create a .env file in the root of your project and add your API keys:

   OPENAI_API_KEY=your_openai_api_key
   GROQ_API_KEY=your_groq_api_key
   BRAVE_SEARCH_API_KEY=your_brave_search_api_key
   SERPER_API=your_serper_api_key
   

Running the Server

To start the server, execute: