32 lines
1 KiB
TypeScript
32 lines
1 KiB
TypeScript
|
import { BaseRetriever, type BaseRetrieverInput } from "@langchain/core/retrievers";
|
||
|
|
import { Document } from "@langchain/core/documents";
|
||
|
|
import { AsyncCaller, type AsyncCallerParams } from "@langchain/core/utils/async_caller";
|
||
|
|
export interface ChaindeskRetrieverArgs extends AsyncCallerParams, BaseRetrieverInput {
|
||
|
|
datastoreId: string;
|
||
|
|
topK?: number;
|
||
|
|
filter?: Record<string, unknown>;
|
||
|
|
apiKey?: string;
|
||
|
|
}
|
||
|
|
/**
|
||
|
|
* @example
|
||
|
|
* ```typescript
|
||
|
|
* const retriever = new ChaindeskRetriever({
|
||
|
|
* datastoreId: "DATASTORE_ID",
|
||
|
|
* apiKey: "CHAINDESK_API_KEY",
|
||
|
|
* topK: 8,
|
||
|
|
* });
|
||
|
|
* const docs = await retriever.getRelevantDocuments("hello");
|
||
|
|
* ```
|
||
|
|
*/
|
||
|
|
export declare class ChaindeskRetriever extends BaseRetriever {
|
||
|
|
static lc_name(): string;
|
||
|
|
lc_namespace: string[];
|
||
|
|
caller: AsyncCaller;
|
||
|
|
datastoreId: string;
|
||
|
|
topK?: number;
|
||
|
|
filter?: Record<string, unknown>;
|
||
|
|
apiKey?: string;
|
||
|
|
constructor({ datastoreId, apiKey, topK, filter, ...rest }: ChaindeskRetrieverArgs);
|
||
|
|
getRelevantDocuments(query: string): Promise<Document[]>;
|
||
|
|
}
|