@langchain/community
Version:
Third-party integrations for LangChain.js
1 lines • 2.18 kB
Source Map (JSON)
{"version":3,"file":"tavily_search_api.d.cts","names":["Document","CallbackManagerForRetrieverRun","BaseRetriever","BaseRetrieverInput","TavilySearchAPIRetrieverFields","Record","TavilySearchAPIRetriever","Promise"],"sources":["../../src/retrievers/tavily_search_api.d.ts"],"sourcesContent":["import { Document } from \"@langchain/core/documents\";\nimport { CallbackManagerForRetrieverRun } from \"@langchain/core/callbacks/manager\";\nimport { BaseRetriever, type BaseRetrieverInput } from \"@langchain/core/retrievers\";\n/**\n * Options for the TavilySearchAPIRetriever class, which includes a BaseLanguageModel\n * instance, a VectorStore instance, and an optional promptTemplate which\n * can either be a BasePromptTemplate instance or a PromptKey.\n */\nexport type TavilySearchAPIRetrieverFields = BaseRetrieverInput & {\n k?: number;\n includeGeneratedAnswer?: boolean;\n includeRawContent?: boolean;\n includeImages?: boolean;\n searchDepth?: \"basic\" | \"advanced\";\n includeDomains?: string[];\n excludeDomains?: string[];\n kwargs?: Record<string, unknown>;\n apiKey?: string;\n};\n/**\n * A class for retrieving documents related to a given search term\n * using the Tavily Search API.\n */\nexport declare class TavilySearchAPIRetriever extends BaseRetriever {\n static lc_name(): string;\n get lc_namespace(): string[];\n k: number;\n includeGeneratedAnswer: boolean;\n includeRawContent: boolean;\n includeImages: boolean;\n searchDepth: string;\n includeDomains?: string[];\n excludeDomains?: string[];\n kwargs: Record<string, unknown>;\n apiKey?: string;\n constructor(fields?: TavilySearchAPIRetrieverFields);\n _getRelevantDocuments(query: string, _runManager?: CallbackManagerForRetrieverRun): Promise<Document[]>;\n}\n//# sourceMappingURL=tavily_search_api.d.ts.map"],"mappings":";;;;;;;;AAQA;AAeA;;AAYyBI,KA3BbA,8BAAAA,GAAiCD,kBA2BpBC,GAAAA;EAC8BH,CAAAA,CAAAA,EAAAA,MAAAA;EAAyCD,sBAAAA,CAAAA,EAAAA,OAAAA;EAARO,iBAAAA,CAAAA,EAAAA,OAAAA;EAblCL,aAAAA,CAAAA,EAAAA,OAAAA;EAAa,WAAA,CAAA,EAAA,OAAA,GAAA,UAAA;;;WAPtDG;;;;;;;cAOQC,wBAAAA,SAAiCJ,aAAAA;;;;;;;;;;UAU1CG;;uBAEaD;qDAC8BH,iCAAiCM,QAAQP"}