sst 3.0.1-12 → 3.0.1-13
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/vector-client.d.ts +36 -7
- package/package.json +1 -1
package/dist/vector-client.d.ts
CHANGED
|
@@ -66,9 +66,9 @@ export type RetrieveEvent = {
|
|
|
66
66
|
* @example
|
|
67
67
|
* ```js
|
|
68
68
|
* {
|
|
69
|
-
*
|
|
69
|
+
* include: {
|
|
70
70
|
* type: "movie",
|
|
71
|
-
*
|
|
71
|
+
* release: "2001",
|
|
72
72
|
* }
|
|
73
73
|
* }
|
|
74
74
|
* ```
|
|
@@ -83,10 +83,39 @@ export type RetrieveEvent = {
|
|
|
83
83
|
* {
|
|
84
84
|
* type: "book",
|
|
85
85
|
* name: "Spiderman",
|
|
86
|
-
* release: "
|
|
86
|
+
* release: "2001",
|
|
87
87
|
* }
|
|
88
88
|
*/
|
|
89
|
-
|
|
89
|
+
include: any;
|
|
90
|
+
/**
|
|
91
|
+
* Exclude embeddings with metadata that match the provided fields.
|
|
92
|
+
* @example
|
|
93
|
+
* ```js
|
|
94
|
+
* {
|
|
95
|
+
* include: {
|
|
96
|
+
* type: "movie",
|
|
97
|
+
* release: "2001",
|
|
98
|
+
* },
|
|
99
|
+
* exclude: {
|
|
100
|
+
* name: "Spiderman",
|
|
101
|
+
* }
|
|
102
|
+
* }
|
|
103
|
+
* ```
|
|
104
|
+
* This will match the embedding with metadata:
|
|
105
|
+
* {
|
|
106
|
+
* type: "movie",
|
|
107
|
+
* name: "A Beautiful Mind",
|
|
108
|
+
* release: "2001",
|
|
109
|
+
* }
|
|
110
|
+
*
|
|
111
|
+
* But not the embedding with metadata:
|
|
112
|
+
* {
|
|
113
|
+
* type: "book",
|
|
114
|
+
* name: "Spiderman",
|
|
115
|
+
* release: "2001",
|
|
116
|
+
* }
|
|
117
|
+
*/
|
|
118
|
+
exclude?: any;
|
|
90
119
|
/**
|
|
91
120
|
* The threshold of similarity between the prompt and the retrieved embeddings.
|
|
92
121
|
* Only embeddings with a similarity score higher than the threshold will be returned.
|
|
@@ -122,19 +151,19 @@ export type RemoveEvent = {
|
|
|
122
151
|
* To remove embeddings for movie with id "movie-123":
|
|
123
152
|
* ```js
|
|
124
153
|
* {
|
|
125
|
-
*
|
|
154
|
+
* include: {
|
|
126
155
|
* id: "movie-123",
|
|
127
156
|
* }
|
|
128
157
|
* }
|
|
129
158
|
* ```
|
|
130
159
|
* To remove embeddings for all movies:
|
|
131
160
|
* {
|
|
132
|
-
*
|
|
161
|
+
* include: {
|
|
133
162
|
* type: "movie",
|
|
134
163
|
* }
|
|
135
164
|
* }
|
|
136
165
|
*/
|
|
137
|
-
|
|
166
|
+
include: any;
|
|
138
167
|
};
|
|
139
168
|
export declare const VectorClient: (name: string) => {
|
|
140
169
|
ingest: (event: IngestEvent) => Promise<any>;
|