agsamantha/node_modules/langchain/dist/tools/vectorstore.d.ts
2024-10-02 15:15:21 -05:00

35 lines
1.3 KiB
TypeScript

import type { BaseLanguageModelInterface } from "@langchain/core/language_models/base";
import type { VectorStoreInterface } from "@langchain/core/vectorstores";
import { Tool } from "@langchain/core/tools";
import { VectorDBQAChain } from "../chains/vector_db_qa.js";
/**
* Interface for tools that interact with a Vector Store.
*/
interface VectorStoreTool {
vectorStore: VectorStoreInterface;
llm: BaseLanguageModelInterface;
}
/**
* A tool for the VectorDBQA chain to interact with a Vector Store. It is
* used to answer questions about a specific topic. The input to this tool
* should be a fully formed question.
*/
export declare class VectorStoreQATool extends Tool implements VectorStoreTool {
static lc_name(): string;
vectorStore: VectorStoreInterface;
llm: BaseLanguageModelInterface;
name: string;
description: string;
chain: VectorDBQAChain;
constructor(name: string, description: string, fields: VectorStoreTool);
/**
* Returns a string that describes what the tool does.
* @param name The name of the tool.
* @param description A description of what the tool does.
* @returns A string that describes what the tool does.
*/
static getDescription(name: string, description: string): string;
/** @ignore */
_call(input: string): Promise<string>;
}
export {};