cheshirecat-typescript-client 1.4.0 → 1.4.2
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.
|
@@ -29,6 +29,7 @@ export declare class RabbitHoleEndpoint extends AbstractEndpoint {
|
|
|
29
29
|
* - In Node.js: A string path to the file
|
|
30
30
|
* - In browser: A File object
|
|
31
31
|
* @param agentId ID of the agent to associate with this upload
|
|
32
|
+
* @param chatId Optional ID of the chat to associate with this upload
|
|
32
33
|
* @param fileName Optional custom name for the file. If not provided:
|
|
33
34
|
* - In Node.js: The basename of the file path is used
|
|
34
35
|
* - In browser: The name property of the File object is used
|
|
@@ -50,7 +51,7 @@ export declare class RabbitHoleEndpoint extends AbstractEndpoint {
|
|
|
50
51
|
* const response = await rabbitHoleEndpoint.postFile('/path/to/document.pdf');
|
|
51
52
|
* ```
|
|
52
53
|
*/
|
|
53
|
-
postFile(fileSource: FileSource, agentId: string, fileName?: string | null, metadata?: Record<string, any> | null): Promise<any>;
|
|
54
|
+
postFile(fileSource: FileSource, agentId: string, chatId?: string | null, fileName?: string | null, metadata?: Record<string, any> | null): Promise<any>;
|
|
54
55
|
/**
|
|
55
56
|
* This method posts a number of files to the RabbitHole API. The files are uploaded to the RabbitHole server and
|
|
56
57
|
* ingested into the RAG system.
|
|
@@ -68,6 +69,7 @@ export declare class RabbitHoleEndpoint extends AbstractEndpoint {
|
|
|
68
69
|
* - In Node.js: An array of strings path to the file
|
|
69
70
|
* - In browser: An array of File objects
|
|
70
71
|
* @param agentId ID of the agent to associate with this upload
|
|
72
|
+
* @param chatId Optional ID of the chat to associate with this upload
|
|
71
73
|
* @param metadata Optional additional metadata to associate with the file
|
|
72
74
|
*
|
|
73
75
|
* @returns Promise resolving to the API response data
|
|
@@ -86,7 +88,7 @@ export declare class RabbitHoleEndpoint extends AbstractEndpoint {
|
|
|
86
88
|
* const response = await rabbitHoleEndpoint.postFiles(['/path/to/first/document.pdf', '/path/to/second/document.pdf']);
|
|
87
89
|
* ```
|
|
88
90
|
*/
|
|
89
|
-
postFiles(fileSources: FileSource[], agentId: string, metadata?: Record<string, any> | null): Promise<any>;
|
|
91
|
+
postFiles(fileSources: FileSource[], agentId: string, chatId?: string | null, metadata?: Record<string, any> | null): Promise<any>;
|
|
90
92
|
/**
|
|
91
93
|
* This method posts a web URL to the RabbitHole API. The web URL is ingested into the RAG system. The web URL is
|
|
92
94
|
* processed by the RAG system by Web scraping, and the results are stored in the RAG database. The process is
|
|
@@ -96,11 +98,12 @@ export declare class RabbitHoleEndpoint extends AbstractEndpoint {
|
|
|
96
98
|
*
|
|
97
99
|
* @param webUrl The URL of the web page to be ingested.
|
|
98
100
|
* @param agentId The ID of the agent to be used for the upload.
|
|
101
|
+
* @param chatId Optional ID of the chat to associate with this upload.
|
|
99
102
|
* @param metadata Additional metadata to be associated with the web URL.
|
|
100
103
|
*
|
|
101
104
|
* @returns The response from the RabbitHole API.
|
|
102
105
|
*/
|
|
103
|
-
postWeb(webUrl: string, agentId: string, metadata?: Record<string, any> | null): Promise<any>;
|
|
106
|
+
postWeb(webUrl: string, agentId: string, chatId?: string | null, metadata?: Record<string, any> | null): Promise<any>;
|
|
104
107
|
/**
|
|
105
108
|
* This method posts a memory point. The memory point is ingested into the RAG system. The process is asynchronous.
|
|
106
109
|
* The provided file must be in JSON format.
|
|
@@ -74,6 +74,7 @@ class RabbitHoleEndpoint extends abstract_1.AbstractEndpoint {
|
|
|
74
74
|
* - In Node.js: A string path to the file
|
|
75
75
|
* - In browser: A File object
|
|
76
76
|
* @param agentId ID of the agent to associate with this upload
|
|
77
|
+
* @param chatId Optional ID of the chat to associate with this upload
|
|
77
78
|
* @param fileName Optional custom name for the file. If not provided:
|
|
78
79
|
* - In Node.js: The basename of the file path is used
|
|
79
80
|
* - In browser: The name property of the File object is used
|
|
@@ -95,13 +96,14 @@ class RabbitHoleEndpoint extends abstract_1.AbstractEndpoint {
|
|
|
95
96
|
* const response = await rabbitHoleEndpoint.postFile('/path/to/document.pdf');
|
|
96
97
|
* ```
|
|
97
98
|
*/
|
|
98
|
-
async postFile(fileSource, agentId, fileName, metadata) {
|
|
99
|
+
async postFile(fileSource, agentId, chatId, fileName, metadata) {
|
|
99
100
|
const form = (0, form_data_2.createFormData)();
|
|
101
|
+
const endpoint = chatId ? this.formatUrl(`/${chatId}`) : this.prefix;
|
|
100
102
|
try {
|
|
101
103
|
await this.appendFileToForm(form, fileSource, "file", fileName);
|
|
102
104
|
this.appendQueryDataToForm(form, metadata);
|
|
103
105
|
// Send the request
|
|
104
|
-
return await this.submitForm(form,
|
|
106
|
+
return await this.submitForm(form, endpoint, agentId);
|
|
105
107
|
}
|
|
106
108
|
catch (error) {
|
|
107
109
|
this.throwError(fileSource, error);
|
|
@@ -124,6 +126,7 @@ class RabbitHoleEndpoint extends abstract_1.AbstractEndpoint {
|
|
|
124
126
|
* - In Node.js: An array of strings path to the file
|
|
125
127
|
* - In browser: An array of File objects
|
|
126
128
|
* @param agentId ID of the agent to associate with this upload
|
|
129
|
+
* @param chatId Optional ID of the chat to associate with this upload
|
|
127
130
|
* @param metadata Optional additional metadata to associate with the file
|
|
128
131
|
*
|
|
129
132
|
* @returns Promise resolving to the API response data
|
|
@@ -142,15 +145,16 @@ class RabbitHoleEndpoint extends abstract_1.AbstractEndpoint {
|
|
|
142
145
|
* const response = await rabbitHoleEndpoint.postFiles(['/path/to/first/document.pdf', '/path/to/second/document.pdf']);
|
|
143
146
|
* ```
|
|
144
147
|
*/
|
|
145
|
-
async postFiles(fileSources, agentId, metadata) {
|
|
148
|
+
async postFiles(fileSources, agentId, chatId, metadata) {
|
|
146
149
|
const form = new form_data_1.default();
|
|
150
|
+
const endpoint = chatId ? this.formatUrl(`/batch/${chatId}`) : this.formatUrl("/batch");
|
|
147
151
|
try {
|
|
148
152
|
await Promise.all(fileSources.map(async (fileSource) => {
|
|
149
153
|
await this.appendFileToForm(form, fileSource, "files");
|
|
150
154
|
}));
|
|
151
155
|
// Append additional query parameters
|
|
152
156
|
this.appendQueryDataToForm(form, metadata);
|
|
153
|
-
return await this.submitForm(form,
|
|
157
|
+
return await this.submitForm(form, endpoint, agentId);
|
|
154
158
|
}
|
|
155
159
|
catch (error) {
|
|
156
160
|
this.throwError(fileSources[0], error);
|
|
@@ -165,16 +169,17 @@ class RabbitHoleEndpoint extends abstract_1.AbstractEndpoint {
|
|
|
165
169
|
*
|
|
166
170
|
* @param webUrl The URL of the web page to be ingested.
|
|
167
171
|
* @param agentId The ID of the agent to be used for the upload.
|
|
172
|
+
* @param chatId Optional ID of the chat to associate with this upload.
|
|
168
173
|
* @param metadata Additional metadata to be associated with the web URL.
|
|
169
174
|
*
|
|
170
175
|
* @returns The response from the RabbitHole API.
|
|
171
176
|
*/
|
|
172
|
-
async postWeb(webUrl, agentId, metadata) {
|
|
177
|
+
async postWeb(webUrl, agentId, chatId, metadata) {
|
|
173
178
|
const payload = { url: webUrl };
|
|
174
179
|
if (metadata) {
|
|
175
180
|
payload["metadata"] = metadata;
|
|
176
181
|
}
|
|
177
|
-
const endpoint = this.formatUrl("/web");
|
|
182
|
+
const endpoint = chatId ? this.formatUrl(`/web/${chatId}`) : this.formatUrl("/web");
|
|
178
183
|
const response = await this.getHttpClient(agentId).post(endpoint, payload);
|
|
179
184
|
if (response.status !== 200) {
|
|
180
185
|
throw new Error(`Failed to post data to ${endpoint}: ${response.statusText}`);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"rabbitHole.js","sourceRoot":"","sources":["../../src/endpoints/rabbitHole.ts"],"names":[],"mappings":";;;;;;AAAA;;;;;;GAMG;AACH,yCAA4C;AAC5C,0DAAiC;AACjC,sDAAuD;AACvD,sDAAwF;AACxF,kDAAkD;AAGlD,MAAa,kBAAmB,SAAQ,2BAAgB;IAC1C,MAAM,GAAG,aAAa,CAAC;IAEzB,UAAU,CAAC,UAAsB,EAAE,KAAU;QACjD,2DAA2D;QAC3D,IAAI,CAAC,IAAA,+BAAiB,GAAE,IAAI,OAAO,UAAU,KAAK,QAAQ,EAAE,CAAC;YACzD,MAAM,IAAI,KAAK,CAAC,oFAAoF,CAAC,CAAC;QAC1G,CAAC;aAAM,IAAI,IAAA,+BAAiB,GAAE,IAAI,OAAO,UAAU,KAAK,QAAQ,EAAE,CAAC;YAC/D,MAAM,IAAI,KAAK,CAAC,iEAAiE,CAAC,CAAC;QACvF,CAAC;QAED,8BAA8B;QAC9B,MAAM,KAAK,CAAC;IAChB,CAAC;IAEO,KAAK,CAAC,gBAAgB,CAC1B,IAAoC,EACpC,UAAsB,EACtB,OAAe,EACf,QAAwB;QAExB,sDAAsD;QACtD,MAAM,UAAU,GAAG,MAAM,IAAA,sBAAQ,EAAC,UAAU,CAAC,CAAC;QAE9C,2BAA2B;QAC3B,MAAM,aAAa,GAAG,QAAQ,IAAI,MAAM,IAAA,yBAAW,EAAC,UAAU,CAAC,CAAC;QAChE,MAAM,YAAY,GAAG,MAAM,IAAA,6BAAe,EAAC,UAAU,EAAE,aAAa,CAAC,CAAC;QAEtE,IAAI,IAAA,+BAAiB,GAAE,EAAE,CAAC;YACrB,IAAiB,CAAC,MAAM,CAAC,OAAO,EAAE,UAAU,EAAE;gBAC3C,QAAQ,EAAE,aAAa;gBACvB,WAAW,EAAE,YAAY;aAC5B,CAAC,CAAC;YAEH,OAAO;QACX,CAAC;QAED,MAAM,IAAI,GAAG,IAAI,IAAI,CAAC,CAAC,UAAU,CAAC,EAAE,EAAE,IAAI,EAAE,YAAY,EAAE,CAAC,CAAC;QAC3D,IAA4B,CAAC,MAAM,CAAC,OAAO,EAAE,IAAI,EAAE,aAAa,CAAC,CAAC;IACvE,CAAC;IAEO,qBAAqB,CACzB,IAAoC,EACpC,QAAqC;QAErC,IAAI,QAAQ,EAAE,CAAC;YACX,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC;QACtD,CAAC;IACL,CAAC;IAEO,KAAK,CAAC,UAAU,CAAC,IAAoC,EAAE,GAAW,EAAE,OAAe;QACvF,MAAM,OAAO,GAAG,IAAA,+BAAiB,GAAE;YAC/B,CAAC,CAAC,EAAE,GAAI,IAAiB,CAAC,UAAU,EAAE,EAAE;YACxC,CAAC,CAAC,EAAE,CAAC;QAET,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,EAAE;YAC/D,OAAO;SACV,CAAC,CAAC;QAEH,OAAO,QAAQ,CAAC,IAAI,CAAC;IACzB,CAAC;IAED
|
|
1
|
+
{"version":3,"file":"rabbitHole.js","sourceRoot":"","sources":["../../src/endpoints/rabbitHole.ts"],"names":[],"mappings":";;;;;;AAAA;;;;;;GAMG;AACH,yCAA4C;AAC5C,0DAAiC;AACjC,sDAAuD;AACvD,sDAAwF;AACxF,kDAAkD;AAGlD,MAAa,kBAAmB,SAAQ,2BAAgB;IAC1C,MAAM,GAAG,aAAa,CAAC;IAEzB,UAAU,CAAC,UAAsB,EAAE,KAAU;QACjD,2DAA2D;QAC3D,IAAI,CAAC,IAAA,+BAAiB,GAAE,IAAI,OAAO,UAAU,KAAK,QAAQ,EAAE,CAAC;YACzD,MAAM,IAAI,KAAK,CAAC,oFAAoF,CAAC,CAAC;QAC1G,CAAC;aAAM,IAAI,IAAA,+BAAiB,GAAE,IAAI,OAAO,UAAU,KAAK,QAAQ,EAAE,CAAC;YAC/D,MAAM,IAAI,KAAK,CAAC,iEAAiE,CAAC,CAAC;QACvF,CAAC;QAED,8BAA8B;QAC9B,MAAM,KAAK,CAAC;IAChB,CAAC;IAEO,KAAK,CAAC,gBAAgB,CAC1B,IAAoC,EACpC,UAAsB,EACtB,OAAe,EACf,QAAwB;QAExB,sDAAsD;QACtD,MAAM,UAAU,GAAG,MAAM,IAAA,sBAAQ,EAAC,UAAU,CAAC,CAAC;QAE9C,2BAA2B;QAC3B,MAAM,aAAa,GAAG,QAAQ,IAAI,MAAM,IAAA,yBAAW,EAAC,UAAU,CAAC,CAAC;QAChE,MAAM,YAAY,GAAG,MAAM,IAAA,6BAAe,EAAC,UAAU,EAAE,aAAa,CAAC,CAAC;QAEtE,IAAI,IAAA,+BAAiB,GAAE,EAAE,CAAC;YACrB,IAAiB,CAAC,MAAM,CAAC,OAAO,EAAE,UAAU,EAAE;gBAC3C,QAAQ,EAAE,aAAa;gBACvB,WAAW,EAAE,YAAY;aAC5B,CAAC,CAAC;YAEH,OAAO;QACX,CAAC;QAED,MAAM,IAAI,GAAG,IAAI,IAAI,CAAC,CAAC,UAAU,CAAC,EAAE,EAAE,IAAI,EAAE,YAAY,EAAE,CAAC,CAAC;QAC3D,IAA4B,CAAC,MAAM,CAAC,OAAO,EAAE,IAAI,EAAE,aAAa,CAAC,CAAC;IACvE,CAAC;IAEO,qBAAqB,CACzB,IAAoC,EACpC,QAAqC;QAErC,IAAI,QAAQ,EAAE,CAAC;YACX,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC;QACtD,CAAC;IACL,CAAC;IAEO,KAAK,CAAC,UAAU,CAAC,IAAoC,EAAE,GAAW,EAAE,OAAe;QACvF,MAAM,OAAO,GAAG,IAAA,+BAAiB,GAAE;YAC/B,CAAC,CAAC,EAAE,GAAI,IAAiB,CAAC,UAAU,EAAE,EAAE;YACxC,CAAC,CAAC,EAAE,CAAC;QAET,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,EAAE;YAC/D,OAAO;SACV,CAAC,CAAC;QAEH,OAAO,QAAQ,CAAC,IAAI,CAAC;IACzB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoCG;IACH,KAAK,CAAC,QAAQ,CACV,UAAsB,EACtB,OAAe,EACf,MAAsB,EACtB,QAAwB,EACxB,QAAqC;QAErC,MAAM,IAAI,GAAG,IAAA,0BAAc,GAAE,CAAC;QAE9B,MAAM,QAAQ,GAAG,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC;QAErE,IAAI,CAAC;YACD,MAAM,IAAI,CAAC,gBAAgB,CAAC,IAAI,EAAE,UAAU,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;YAChE,IAAI,CAAC,qBAAqB,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;YAE3C,mBAAmB;YACnB,OAAO,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;QAC1D,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACb,IAAI,CAAC,UAAU,CAAC,UAAU,EAAE,KAAK,CAAC,CAAA;QACtC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;IACH,KAAK,CAAC,SAAS,CACX,WAAyB,EACzB,OAAe,EACf,MAAsB,EACtB,QAAqC;QAErC,MAAM,IAAI,GAAG,IAAI,mBAAQ,EAAE,CAAC;QAE5B,MAAM,QAAQ,GAAG,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,UAAU,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;QAExF,IAAI,CAAC;YACD,MAAM,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC,GAAG,CAAC,KAAK,EAAE,UAAU,EAAE,EAAE;gBACnD,MAAM,IAAI,CAAC,gBAAgB,CAAC,IAAI,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC;YAC3D,CAAC,CAAC,CAAC,CAAC;YAEJ,qCAAqC;YACrC,IAAI,CAAC,qBAAqB,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;YAE3C,OAAO,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;QAC1D,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACb,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAAA;QAC1C,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,OAAO,CACT,MAAc,EACd,OAAe,EACf,MAAsB,EACtB,QAAqC;QAErC,MAAM,OAAO,GAAwB,EAAE,GAAG,EAAE,MAAM,EAAE,CAAC;QACrD,IAAI,QAAQ,EAAE,CAAC;YACX,OAAO,CAAC,UAAU,CAAC,GAAG,QAAQ,CAAC;QACnC,CAAC;QAED,MAAM,QAAQ,GAAG,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;QAEpF,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;QAC3E,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;YAC1B,MAAM,IAAI,KAAK,CAAC,0BAA0B,QAAQ,KAAK,QAAQ,CAAC,UAAU,EAAE,CAAC,CAAC;QAClF,CAAC;QACD,OAAO,QAAQ,CAAC,IAAI,CAAC;IACzB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,KAAK,CAAC,UAAU,CACZ,UAAsB,EACtB,OAAe,EACf,QAAwB;QAExB,MAAM,IAAI,GAAG,IAAI,mBAAQ,EAAE,CAAC;QAE5B,IAAI,CAAC;YACD,MAAM,IAAI,CAAC,gBAAgB,CAAC,IAAI,EAAE,UAAU,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;YAEhE,OAAO,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;QACrE,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACb,IAAI,CAAC,UAAU,CAAC,UAAU,EAAE,KAAK,CAAC,CAAA;QACtC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,mBAAmB,CAAC,OAAe;QACrC,OAAO,IAAI,CAAC,GAAG,CAAyB,IAAI,CAAC,SAAS,CAAC,oBAAoB,CAAC,EAAE,OAAO,CAAC,CAAC;IAC3F,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,aAAa,CAAC,OAAe;QAC/B,OAAO,IAAI,CAAC,GAAG,CAAW,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,CAAC;IAC/D,CAAC;CACJ;AA1RD,gDA0RC"}
|