39 lines
1.4 KiB
TypeScript
39 lines
1.4 KiB
TypeScript
|
import { Document } from "@langchain/core/documents";
|
||
|
|
import { CallbackManagerForRetrieverRun } from "@langchain/core/callbacks/manager";
|
||
|
|
import { BaseRetriever, type BaseRetrieverInput } from "@langchain/core/retrievers";
|
||
|
|
/**
|
||
|
|
* Options for the TavilySearchAPIRetriever class, which includes a BaseLanguageModel
|
||
|
|
* instance, a VectorStore instance, and an optional promptTemplate which
|
||
|
|
* can either be a BasePromptTemplate instance or a PromptKey.
|
||
|
|
*/
|
||
|
|
export type TavilySearchAPIRetrieverFields = BaseRetrieverInput & {
|
||
|
|
k?: number;
|
||
|
|
includeGeneratedAnswer?: boolean;
|
||
|
|
includeRawContent?: boolean;
|
||
|
|
includeImages?: boolean;
|
||
|
|
searchDepth?: "basic" | "advanced";
|
||
|
|
includeDomains?: string[];
|
||
|
|
excludeDomains?: string[];
|
||
|
|
kwargs?: Record<string, unknown>;
|
||
|
|
apiKey?: string;
|
||
|
|
};
|
||
|
|
/**
|
||
|
|
* A class for retrieving documents related to a given search term
|
||
|
|
* using the Tavily Search API.
|
||
|
|
*/
|
||
|
|
export declare class TavilySearchAPIRetriever extends BaseRetriever {
|
||
|
|
static lc_name(): string;
|
||
|
|
get lc_namespace(): string[];
|
||
|
|
k: number;
|
||
|
|
includeGeneratedAnswer: boolean;
|
||
|
|
includeRawContent: boolean;
|
||
|
|
includeImages: boolean;
|
||
|
|
searchDepth: string;
|
||
|
|
includeDomains?: string[];
|
||
|
|
excludeDomains?: string[];
|
||
|
|
kwargs: Record<string, unknown>;
|
||
|
|
apiKey?: string;
|
||
|
|
constructor(fields?: TavilySearchAPIRetrieverFields);
|
||
|
|
_getRelevantDocuments(query: string, _runManager?: CallbackManagerForRetrieverRun): Promise<Document[]>;
|
||
|
|
}
|