-
Notifications
You must be signed in to change notification settings - Fork 324
/
types.ts
91 lines (76 loc) · 2.05 KB
/
types.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
import type { BaseNode, ModalityType } from "../../Node.js";
import type { BaseEmbedding } from "../../embeddings/types.js";
import { getEmbeddedModel } from "../../internal/settings/EmbedModel.js";
export interface VectorStoreQueryResult {
nodes?: BaseNode[];
similarities: number[];
ids: string[];
}
export enum VectorStoreQueryMode {
DEFAULT = "default",
SPARSE = "sparse",
HYBRID = "hybrid",
// fit learners
SVM = "svm",
LOGISTIC_REGRESSION = "logistic_regression",
LINEAR_REGRESSION = "linear_regression",
// maximum marginal relevance
MMR = "mmr",
}
export interface ExactMatchFilter {
filterType: "ExactMatch";
key: string;
value: string | number;
}
export interface MetadataFilters {
filters: ExactMatchFilter[];
}
export interface VectorStoreQuerySpec {
query: string;
filters: ExactMatchFilter[];
topK?: number;
}
export interface MetadataInfo {
name: string;
type: string;
description: string;
}
export interface VectorStoreInfo {
metadataInfo: MetadataInfo[];
contentInfo: string;
}
export interface VectorStoreQuery {
queryEmbedding?: number[];
similarityTopK: number;
docIds?: string[];
queryStr?: string;
mode: VectorStoreQueryMode;
alpha?: number;
filters?: MetadataFilters;
mmrThreshold?: number;
}
export interface VectorStoreNoEmbedModel {
storesText: boolean;
isEmbeddingQuery?: boolean;
client(): any;
add(embeddingResults: BaseNode[]): Promise<string[]>;
delete(refDocId: string, deleteOptions?: any): Promise<void>;
query(
query: VectorStoreQuery,
options?: any,
): Promise<VectorStoreQueryResult>;
}
export interface IEmbedModel {
embedModel: BaseEmbedding;
}
export interface VectorStore extends VectorStoreNoEmbedModel, IEmbedModel {}
// Supported types of vector stores (for each modality)
export type VectorStoreByType = {
[P in ModalityType]?: VectorStore;
};
export abstract class VectorStoreBase implements IEmbedModel {
embedModel: BaseEmbedding;
protected constructor(embedModel?: BaseEmbedding) {
this.embedModel = embedModel ?? getEmbeddedModel();
}
}