67 lines
2.5 KiB
TypeScript
67 lines
2.5 KiB
TypeScript
import { BaseRetriever, type BaseRetrieverInput } from "@langchain/core/retrievers";
|
|
import { Document } from "@langchain/core/documents";
|
|
import type { DriaParams, SearchOptions as DriaSearchOptions } from "dria";
|
|
import { Dria } from "dria";
|
|
/**
|
|
* Configurations for Dria retriever.
|
|
*
|
|
* - `contractId`: a Dria knowledge's contract ID.
|
|
* - `apiKey`: a Dria API key; if omitted, the retriever will check for `DRIA_API_KEY` environment variable.
|
|
*
|
|
* The retrieval can be configured with the following options:
|
|
*
|
|
* - `topK`: number of results to return, max 20. (default: 10)
|
|
* - `rerank`: re-rank the results from most to least semantically relevant to the given search query. (default: true)
|
|
* - `level`: level of detail for the search, must be an integer from 0 to 5 (inclusive). (default: 1)
|
|
* - `field`: CSV field name, only relevant for the CSV files.
|
|
*/
|
|
export interface DriaRetrieverArgs extends DriaParams, BaseRetrieverInput, DriaSearchOptions {
|
|
}
|
|
/**
|
|
* Class for retrieving documents from knowledge uploaded to Dria.
|
|
*
|
|
* @example
|
|
* ```typescript
|
|
* // contract of TypeScript Handbook v4.9 uploaded to Dria
|
|
* const contractId = "-B64DjhUtCwBdXSpsRytlRQCu-bie-vSTvTIT8Ap3g0";
|
|
* const retriever = new DriaRetriever({ contractId });
|
|
*
|
|
* const docs = await retriever.getRelevantDocuments("What is a union type?");
|
|
* console.log(docs);
|
|
* ```
|
|
*/
|
|
export declare class DriaRetriever extends BaseRetriever {
|
|
static lc_name(): string;
|
|
lc_namespace: string[];
|
|
get lc_secrets(): {
|
|
apiKey: string;
|
|
};
|
|
get lc_aliases(): {
|
|
apiKey: string;
|
|
};
|
|
apiKey: string;
|
|
driaClient: Dria;
|
|
private searchOptions;
|
|
constructor(fields: DriaRetrieverArgs);
|
|
/**
|
|
* Currently connected knowledge on Dria.
|
|
*
|
|
* Retriever will use this contract ID while retrieving documents,
|
|
* and will throw an error if `undefined`.
|
|
*
|
|
* In the case that this is `undefined`, the user is expected to
|
|
* set contract ID manually, such as after creating a new knowledge & inserting
|
|
* data there with the Dria client.
|
|
*/
|
|
get contractId(): string | undefined;
|
|
set contractId(value: string);
|
|
/**
|
|
* Retrieves documents from Dria with respect to the configured contract ID, based on
|
|
* the given query string.
|
|
*
|
|
* @param query The query string
|
|
* @returns A promise that resolves to an array of documents, with page content as text,
|
|
* along with `id` and the relevance `score` within the metadata.
|
|
*/
|
|
_getRelevantDocuments(query: string): Promise<Document[]>;
|
|
}
|