langchain-rag-chat 0.1.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Yzby
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,9 @@
+# langchain-rag-chat
+
+一个基于 LangChain 的 TypeScript RAG 聊天库，支持文档加载、向量检索、问题扩展、分类检索和答案生成。
+
+## 安装
+
+```bash
+npm install langchain-rag-chat
+```

package/dist/core/RAGChat.d.ts

@@ -0,0 +1,104 @@
+import { createChatModel, EmbeddingModelOptions } from '../models';
+import { Document } from '@langchain/core/documents';
+import { VectorStore, VectorStoreRetrieverInput } from '@langchain/core/vectorstores';
+import { Embeddings } from '@langchain/core/embeddings';
+import { LoadOptions, CustomLoder } from '../loaders';
+import { ChatOpenAIFields } from '@langchain/openai';
+import { RunnableConfig, RunnableLike } from '@langchain/core/runnables';
+export type VectorStoreFactory = (embeddings: Embeddings) => VectorStore;
+export type RAGStep = "init" | "classification" | "loader" | "embedding" | "vectorStore" | "retrieve" | "compress" | "answer";
+export interface RAGOptions<Q extends string> {
+    chatModel: ChatOpenAIFields;
+    /**
+     * Customized storage solution
+     * @default MemoryVectorStore
+     */
+    vectorStore?: VectorStoreFactory;
+    embeddings?: Embeddings;
+    embeddingModelOptions?: EmbeddingModelOptions;
+    /**
+     * Enhance Prompt
+     * @default 3
+     * @example
+     * input: What is a computed property
+     * result:
+     * Explain the concept of a computed property in software development.
+     * What is the difference between a computed property and a regular method or getter?
+     * How do derived properties calculate and cache their values in reactive programming frameworks?
+     */
+    enhancePrompt?: number;
+    /**
+     * question Category array
+     */
+    category?: Q[];
+    enableClassification?: boolean;
+    /**
+     * Question Categorization ['biology', 'All animals and plants on Earth']
+     */
+    questionCategory?: [Q, string][];
+    onStep?: (step: RAGStep, payload?: any) => void;
+    /**
+     * Retrieve Pre Processing
+     */
+    preRetrieve?: RunnableLike;
+    /**
+     * Retrieve Post Processing
+     */
+    postRetrieve?: RunnableLike;
+    loder?: CustomLoder;
+}
+export interface InputQuestion {
+    question: string;
+    k?: number;
+}
+export declare class RAGChat<Q extends string> {
+    vectorStore: VectorStore;
+    chatModel: ReturnType<typeof createChatModel>;
+    embeddings: Embeddings;
+    enhancePrompt: number;
+    category: Q[];
+    questionCategory: [Q, string][];
+    private onStep;
+    private chain;
+    private retrievalChain;
+    private loder;
+    preRetrieve: RunnableLike | null;
+    postRetrieve: RunnableLike | null;
+    enableClassification: boolean;
+    constructor(options: RAGOptions<Q>);
+    load(loadResource: {
+        type: Q;
+        loadOptions: LoadOptions;
+    }[]): Promise<void>;
+    /**
+     * Search Document
+     */
+    retrieveDocuments(question: string[], kOrFields?: number | Partial<VectorStoreRetrieverInput<typeof this.vectorStore>>): Promise<Document<Record<string, any>>[]>;
+    private createRetrieveProcess;
+    private createProcess;
+    /**
+     * Question Classification
+     * @param question
+     * @param category
+     * @param questionCategory
+     * @returns
+     */
+    classification(question: string, category?: string[], questionCategory?: [Q, string][]): Promise<Q | "other">;
+    /**
+     * Question Expand
+     * @param question
+     * @param queryCount
+     * @returns
+     */
+    expandQuestion(question: string, queryCount?: number): Promise<string[]>;
+    private answer;
+    private streamAnswer;
+    /**
+     * Compression and Deduplication
+     * @param docs
+     * @returns
+     */
+    deduplicateAndCompress(docs: Document[]): Document[];
+    invoke(input: string | InputQuestion, options?: RunnableConfig): Promise<any>;
+    stream(input: string | InputQuestion, options?: RunnableConfig): AsyncGenerator<string, void, unknown>;
+}

package/dist/core/index.d.ts

@@ -0,0 +1,2 @@
+export { RAGChat } from './RAGChat';
+export type { VectorStoreFactory, RAGStep, RAGOptions } from './RAGChat';

package/dist/index.d.ts

@@ -0,0 +1,6 @@
+export { RAGChat } from './core';
+export { loadResources, loadPDF, loadWebPage } from './loaders';
+export { createChatModel, createEmbeddingModel } from './models';
+export type { RAGOptions, RAGStep } from './core';
+export type { Resource, LoadOptions, PDFLoader, WebURL, CustomLoder, } from './loaders';
+export type { EmbeddingModelOptions } from './models';