Welcome
Welcome to the official documentation for Ragfish.
Ragfish is a TypeScript-first framework for building AI-powered applications using Retrieval-Augmented Generation (RAG). It provides a modular architecture that enables developers to connect Large Language Models (LLMs), vector databases, and enterprise knowledge sources through a consistent and easy-to-use API.
Whether you're building a document chatbot, an internal knowledge assistant, a customer support AI, or a custom enterprise application, Ragfish provides the core building blocks to simplify development while remaining flexible enough for production environments.
This documentation will guide you from installation to building complete AI assistants using the Ragfish framework.
What is Ragfish?
Ragfish is an extensible framework for building AI assistants that can understand and retrieve information from your organization's knowledge.
The framework provides modules for:
Each component is designed to work independently while integrating seamlessly with the rest of the framework.
AI model integration
Knowledge ingestion
Text chunking
Embedding generation
Vector database integration
Semantic retrieval
Conversational AI
Enterprise connectors
Each component is designed to work independently while integrating seamlessly with the rest of the framework.
Why Use Ragfish?
Building an AI application typically requires integrating several independent technologies, including language models, embedding providers, vector databases, and document processing libraries.
Ragfish brings these components together into a unified framework, allowing developers to focus on building applications instead of managing infrastructure.
Key benefits include:
TypeScript-first developer experience
Modular package architecture
Multiple AI provider support
Multiple vector database integrations
Extensible connector ecosystem
Enterprise-ready architecture
Consistent APIs across the framework
What Can You Build?
Using Ragfish, you can build applications such as:
Enterprise AI Assistants
Knowledge Base Chatbots
Product Documentation Assistants
Customer Support Assistants
HR Knowledge Portals
Compliance Assistants
AI-powered Search Applications
Spreadsheet Intelligence Assistants
The same framework can be used for small proof-of-concept projects as well as large enterprise deployments.
Framework Overview
A typical Ragfish application follows the knowledge pipeline shown below.
Knowledge Sources
│
▼
Ingestion
│
▼
Chunking
│
▼
Embeddings
│
▼
Vector Store
│
▼
Retrieval
│
▼
Chat
│
▼
AI Assistant
Each stage is modular, allowing you to customize or replace components based on your application's requirements.
Before You Begin
To get started with Ragfish, you should have:
Node.js 20 or later
TypeScript 5.x
npm or pnpm
A basic understanding of JavaScript or TypeScript
An API key for a supported AI provider (such as OpenAI) for the introductory examples
Next Steps
Now that you have an overview of Ragfish, continue to understand the framework's design principles, architecture, and how it simplifies the development of AI-powered applications