cheshirecat-typescript-client 1.2.3 → 1.2.4
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/README.md +8 -6
- package/dist/client.d.ts +5 -5
- package/dist/client.js.map +1 -1
- package/dist/clients/httpclient.d.ts +1 -1
- package/dist/clients/httpclient.js +2 -2
- package/dist/clients/httpclient.js.map +1 -1
- package/dist/clients/wsclient.d.ts +3 -3
- package/dist/clients/wsclient.js +2 -4
- package/dist/clients/wsclient.js.map +1 -1
- package/dist/endpoints/abstract.d.ts +5 -5
- package/dist/endpoints/abstract.js +2 -2
- package/dist/endpoints/abstract.js.map +1 -1
- package/dist/endpoints/admins.d.ts +3 -3
- package/dist/endpoints/admins.js +8 -8
- package/dist/endpoints/admins.js.map +1 -1
- package/dist/endpoints/authHandler.d.ts +7 -7
- package/dist/endpoints/authHandler.js +6 -6
- package/dist/endpoints/authHandler.js.map +1 -1
- package/dist/endpoints/chunker.d.ts +7 -10
- package/dist/endpoints/chunker.js +6 -9
- package/dist/endpoints/chunker.js.map +1 -1
- package/dist/endpoints/customEndpoint.d.ts +4 -4
- package/dist/endpoints/customEndpoint.js +4 -4
- package/dist/endpoints/customEndpoint.js.map +1 -1
- package/dist/endpoints/embedder.js +1 -1
- package/dist/endpoints/embedder.js.map +1 -1
- package/dist/endpoints/fileManager.d.ts +8 -11
- package/dist/endpoints/fileManager.js +6 -9
- package/dist/endpoints/fileManager.js.map +1 -1
- package/dist/endpoints/largeLanguageModel.d.ts +7 -10
- package/dist/endpoints/largeLanguageModel.js +6 -9
- package/dist/endpoints/largeLanguageModel.js.map +1 -1
- package/dist/endpoints/memory.d.ts +43 -62
- package/dist/endpoints/memory.js +40 -59
- package/dist/endpoints/memory.js.map +1 -1
- package/dist/endpoints/message.d.ts +2 -2
- package/dist/endpoints/message.js +1 -1
- package/dist/endpoints/message.js.map +1 -1
- package/dist/endpoints/plugins.d.ts +12 -17
- package/dist/endpoints/plugins.js +11 -16
- package/dist/endpoints/plugins.js.map +1 -1
- package/dist/endpoints/rabbitHole.d.ts +11 -15
- package/dist/endpoints/rabbitHole.js +8 -12
- package/dist/endpoints/rabbitHole.js.map +1 -1
- package/dist/endpoints/settings.d.ts +12 -22
- package/dist/endpoints/settings.js +11 -21
- package/dist/endpoints/settings.js.map +1 -1
- package/dist/endpoints/users.d.ts +8 -21
- package/dist/endpoints/users.js +6 -19
- package/dist/endpoints/users.js.map +1 -1
- package/package.json +1 -1
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"memory.js","sourceRoot":"","sources":["../../src/endpoints/memory.ts"],"names":[],"mappings":";;;AAAA,yCAA4C;AAiB5C,MAAa,cAAe,SAAQ,2BAAgB;IACtC,MAAM,GAAG,SAAS,CAAC;IAE7B,4BAA4B;IAE5B
|
|
1
|
+
{"version":3,"file":"memory.js","sourceRoot":"","sources":["../../src/endpoints/memory.ts"],"names":[],"mappings":";;;AAAA,yCAA4C;AAiB5C,MAAa,cAAe,SAAQ,2BAAgB;IACtC,MAAM,GAAG,SAAS,CAAC;IAE7B,4BAA4B;IAE5B;;;;;;OAMG;IACH,KAAK,CAAC,oBAAoB,CAAC,OAAe;QACtC,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,EAAE,OAAO,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,+BAA+B,CAAC,OAAe;QACjD,OAAO,IAAI,CAAC,MAAM,CAAgC,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,EAAE,OAAO,CAAC,CAAC;IAC/F,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,qCAAqC,CACvC,UAAsB,EACtB,OAAe;QAEf,OAAO,IAAI,CAAC,MAAM,CACd,IAAI,CAAC,SAAS,CAAC,eAAe,GAAG,UAAU,CAAC,QAAQ,EAAE,CAAC,EACvD,OAAO,CACV,CAAC;IACN,CAAC;IAED,gCAAgC;IAEhC,qCAAqC;IAErC;;;;;;;OAOG;IACH,KAAK,CAAC,sBAAsB,CACxB,OAAe,EACf,MAAc;QAEd,OAAO,IAAI,CAAC,GAAG,CAA4B,IAAI,CAAC,SAAS,CAAC,uBAAuB,CAAC,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;IACzG,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,yBAAyB,CAC3B,OAAe,EACf,MAAc;QAEd,OAAO,IAAI,CAAC,MAAM,CACd,IAAI,CAAC,SAAS,CAAC,uBAAuB,CAAC,EACvC,OAAO,EACP,MAAM,CACT,CAAC;IACN,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,uBAAuB,CACzB,GAAS,EACT,IAAY,EACZ,OAAe,EACf,MAAc,EACd,KAAqB,EACrB,GAAgB;QAEhB,MAAM,OAAO,GAAG;YACZ,GAAG,EAAE,GAAG,CAAC,QAAQ,EAAE;YACnB,IAAI;YACJ,GAAG,CAAC,KAAK,IAAI,EAAC,KAAK,EAAC,CAAC;YACrB,GAAG,CAAC,GAAG,IAAI,EAAC,GAAG,EAAE,GAAG,CAAC,OAAO,EAAE,EAAC,CAAC;SACnC,CAAC;QAEF,OAAO,IAAI,CAAC,IAAI,CAA4B,IAAI,CAAC,SAAS,CAAC,uBAAuB,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;IACnH,CAAC;IAED,yCAAyC;IAEzC,uBAAuB;IAEvB;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,eAAe,CACjB,IAAY,EACZ,OAAe,EACf,MAAc,EACd,CAAiB,EACjB,QAAc;QAEd,MAAM,KAAK,GAAG;YACV,IAAI;YACJ,GAAG,CAAC,CAAC,IAAI,EAAC,CAAC,EAAC,CAAC;YACb,GAAG,CAAC,QAAQ,IAAI,EAAC,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAC,CAAC;SACxD,CAAC;QAEF,OAAO,IAAI,CAAC,GAAG,CAAqB,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;IAC3F,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,eAAe,CACjB,UAAsB,EACtB,OAAe,EACf,MAAc,EACd,WAA8B;QAE9B,IAAI,MAAM,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC5C,WAAW,CAAC,QAAQ,CAAC,QAAQ,CAAC,GAAG,MAAM,CAAC;QAC5C,CAAC;QAED,OAAO,IAAI,CAAC,IAAI,CACZ,IAAI,CAAC,SAAS,CAAC,eAAe,GAAG,UAAU,CAAC,QAAQ,EAAE,GAAG,SAAS,CAAC,EACnE,OAAO,EACP,WAAW,CACd,CAAC;IACN,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,cAAc,CAChB,UAAsB,EACtB,OAAe,EACf,MAAc,EACd,WAA8B,EAC9B,OAAe;QAEf,IAAI,MAAM,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC5C,WAAW,CAAC,QAAQ,CAAC,QAAQ,CAAC,GAAG,MAAM,CAAC;QAC5C,CAAC;QAED,OAAO,IAAI,CAAC,GAAG,CACX,IAAI,CAAC,SAAS,CAAC,eAAe,GAAG,UAAU,CAAC,QAAQ,EAAE,GAAG,UAAU,GAAG,OAAO,CAAC,EAC9E,OAAO,EACP,WAAW,CACd,CAAC;IACN,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,iBAAiB,CACnB,UAAsB,EACtB,OAAe,EACf,OAAe;QAEf,OAAO,IAAI,CAAC,MAAM,CACd,IAAI,CAAC,SAAS,CAAC,eAAe,GAAG,UAAU,CAAC,QAAQ,EAAE,GAAG,UAAU,GAAG,OAAO,CAAC,EAC9E,OAAO,CACV,CAAC;IACN,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,4BAA4B,CAC9B,UAAsB,EACtB,OAAe,EACf,QAAc;QAEd,OAAO,IAAI,CAAC,MAAM,CACd,IAAI,CAAC,SAAS,CAAC,eAAe,GAAG,UAAU,CAAC,QAAQ,EAAE,GAAG,SAAS,CAAC,EACnE,OAAO,EACP,IAAI,EACJ,QAAQ,CACX,CAAC;IACN,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,eAAe,CACjB,UAAsB,EACtB,OAAe,EACf,KAAqB,EACrB,MAAsB;QAEtB,MAAM,KAAK,GAAG;YACV,GAAG,CAAC,KAAK,IAAI,EAAC,KAAK,EAAC,CAAC;YACrB,GAAG,CAAC,MAAM,IAAI,EAAC,MAAM,EAAC,CAAC;SAC1B,CAAC;QAEF,OAAO,IAAI,CAAC,GAAG,CACX,IAAI,CAAC,SAAS,CAAC,eAAe,GAAG,UAAU,CAAC,QAAQ,EAAE,GAAG,SAAS,CAAC,EACnE,OAAO,EACP,IAAI,EACJ,KAAK,CACR,CAAC;IACN,CAAC;CAGJ;AAnRD,wCAmRC"}
|
|
@@ -11,7 +11,7 @@ export declare class MessageEndpoint extends AbstractEndpoint {
|
|
|
11
11
|
*
|
|
12
12
|
* @returns The response from the server
|
|
13
13
|
*/
|
|
14
|
-
sendHttpMessage(message: Message, agentId
|
|
14
|
+
sendHttpMessage(message: Message, agentId: string, userId: string): Promise<MessageOutput>;
|
|
15
15
|
/**
|
|
16
16
|
* This endpoint sends a message to the agent identified by the agentId parameter. The message is sent via WebSocket.
|
|
17
17
|
*
|
|
@@ -22,5 +22,5 @@ export declare class MessageEndpoint extends AbstractEndpoint {
|
|
|
22
22
|
*
|
|
23
23
|
* @returns The response from the server
|
|
24
24
|
*/
|
|
25
|
-
sendWebsocketMessage(message: Message, agentId
|
|
25
|
+
sendWebsocketMessage(message: Message, agentId: string, userId: string, closure?: (content: string) => void | null): Promise<MessageOutput>;
|
|
26
26
|
}
|
|
@@ -13,7 +13,7 @@ class MessageEndpoint extends abstract_1.AbstractEndpoint {
|
|
|
13
13
|
* @returns The response from the server
|
|
14
14
|
*/
|
|
15
15
|
async sendHttpMessage(message, agentId, userId) {
|
|
16
|
-
return this.post("/message", message.toJSON(),
|
|
16
|
+
return this.post("/message", agentId, message.toJSON(), userId);
|
|
17
17
|
}
|
|
18
18
|
/**
|
|
19
19
|
* This endpoint sends a message to the agent identified by the agentId parameter. The message is sent via WebSocket.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"message.js","sourceRoot":"","sources":["../../src/endpoints/message.ts"],"names":[],"mappings":";;;AAAA,yCAA4C;AAM5C,MAAa,eAAgB,SAAQ,2BAAgB;IACjD;;;;;;;;OAQG;IACH,KAAK,CAAC,eAAe,CAAC,OAAgB,EAAE,
|
|
1
|
+
{"version":3,"file":"message.js","sourceRoot":"","sources":["../../src/endpoints/message.ts"],"names":[],"mappings":";;;AAAA,yCAA4C;AAM5C,MAAa,eAAgB,SAAQ,2BAAgB;IACjD;;;;;;;;OAQG;IACH,KAAK,CAAC,eAAe,CAAC,OAAgB,EAAE,OAAe,EAAE,MAAc;QACnE,OAAO,IAAI,CAAC,IAAI,CACZ,UAAU,EACV,OAAO,EACP,OAAO,CAAC,MAAM,EAAE,EAChB,MAAM,CACT,CAAC;IACN,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,oBAAoB,CACtB,OAAgB,EAChB,OAAe,EACf,MAAc,EACd,OAA0C;QAE1C,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;QAC9C,IAAI,CAAC,IAAI,EAAE,CAAC;YACR,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;QAC9C,CAAC;QAED,MAAM,MAAM,GAAG,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QAEjD,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACnC,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,GAAG,EAAE;gBACnB,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACtB,CAAC,CAAC,CAAC;YAEH,MAAM,CAAC,EAAE,CAAC,SAAS,EAAE,CAAC,IAAmB,EAAE,EAAE;gBACzC,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC;gBAEhC,2BAA2B;gBAC3B,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAC,EAAE,CAAC;oBACrC,IAAI,OAAO;wBAAE,OAAO,CAAC,OAAO,CAAC,CAAC;oBAC9B,OAAO;gBACX,CAAC;gBAED,MAAM,CAAC,KAAK,EAAE,CAAC;gBACf,IAAI,CAAC;oBACD,MAAM,aAAa,GAAG,IAAI,CAAC,WAAW,CAAgB,OAAO,CAAC,CAAC;oBAC/D,OAAO,CAAC,aAAa,CAAC,CAAC;gBAC3B,CAAC;gBAAC,OAAO,KAAK,EAAE,CAAC;oBACb,MAAM,CAAC,IAAI,KAAK,CAAC,+BAA+B,GAAG,KAAK,CAAC,CAAC,CAAC;gBAC/D,CAAC;YACL,CAAC,CAAC,CAAC;YAEH,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE;gBACzB,MAAM,CAAC,IAAI,KAAK,CAAC,mBAAmB,GAAG,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC;YAC/D,CAAC,CAAC,CAAC;YAEH,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE;gBACpB,MAAM,CAAC,IAAI,KAAK,CAAC,0CAA0C,CAAC,CAAC,CAAC;YAClE,CAAC,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;IACP,CAAC;CACJ;AA1ED,0CA0EC"}
|
|
@@ -4,53 +4,48 @@ import { PluginSettingsOutput } from "../models/api/nested/plugins";
|
|
|
4
4
|
export declare class PluginsEndpoint extends AbstractEndpoint {
|
|
5
5
|
protected prefix: string;
|
|
6
6
|
/**
|
|
7
|
-
* This endpoint returns the available plugins
|
|
8
|
-
* (for multi-agent installations) or for the default agent (for single-agent installations).
|
|
7
|
+
* This endpoint returns the available plugins.
|
|
9
8
|
*
|
|
10
|
-
* @param pluginName - The name of the plugin to filter the results by (optional).
|
|
11
9
|
* @param agentId - The ID of the agent to get the available plugins for.
|
|
10
|
+
* @param pluginName - The name of the plugin to filter the results by (optional).
|
|
12
11
|
*
|
|
13
12
|
* @returns The available plugins.
|
|
14
13
|
*/
|
|
15
|
-
getAvailablePlugins(
|
|
14
|
+
getAvailablePlugins(agentId: string, pluginName?: string | null): Promise<PluginCollectionOutput>;
|
|
16
15
|
/**
|
|
17
|
-
* This endpoint toggles a plugin
|
|
18
|
-
* installations) or for the default agent (for single-agent installations).
|
|
16
|
+
* This endpoint toggles a plugin.
|
|
19
17
|
*
|
|
20
18
|
* @param pluginId - The ID of the plugin to toggle.
|
|
21
19
|
* @param agentId - The ID of the agent to toggle the plugin for.
|
|
22
20
|
*
|
|
23
21
|
* @returns The plugin toggle output.
|
|
24
22
|
*/
|
|
25
|
-
putTogglePlugin(pluginId: string, agentId
|
|
23
|
+
putTogglePlugin(pluginId: string, agentId: string): Promise<PluginToggleOutput>;
|
|
26
24
|
/**
|
|
27
|
-
* This endpoint retrieves the plugins settings
|
|
28
|
-
* (for multi-agent installations) or for the default agent (for single-agent installations).
|
|
25
|
+
* This endpoint retrieves the plugins settings.
|
|
29
26
|
*
|
|
30
27
|
* @param agentId - The ID of the agent to get the plugins settings for.
|
|
31
28
|
*
|
|
32
29
|
* @returns The plugins settings.
|
|
33
30
|
*/
|
|
34
|
-
getPluginsSettings(agentId
|
|
31
|
+
getPluginsSettings(agentId: string): Promise<PluginsSettingsOutput>;
|
|
35
32
|
/**
|
|
36
|
-
* This endpoint retrieves the plugin settings
|
|
37
|
-
* (for multi-agent installations) or for the default agent (for single-agent installations).
|
|
33
|
+
* This endpoint retrieves the plugin settings.
|
|
38
34
|
*
|
|
39
35
|
* @param pluginId - The ID of the plugin to get the settings for.
|
|
40
36
|
* @param agentId - The ID of the agent to get the plugin settings for.
|
|
41
37
|
*
|
|
42
38
|
* @returns The plugin settings.
|
|
43
39
|
*/
|
|
44
|
-
getPluginSettings(pluginId: string, agentId
|
|
40
|
+
getPluginSettings(pluginId: string, agentId: string): Promise<PluginSettingsOutput>;
|
|
45
41
|
/**
|
|
46
|
-
* This endpoint updates the plugin settings
|
|
47
|
-
* (for multi-agent installations) or for the default agent (for single-agent installations).
|
|
42
|
+
* This endpoint updates the plugin settings.
|
|
48
43
|
*
|
|
49
44
|
* @param pluginId - The ID of the plugin to update the settings for.
|
|
50
|
-
* @param values - The values to update the plugin settings with.
|
|
51
45
|
* @param agentId - The ID of the agent to update the plugin settings for.
|
|
46
|
+
* @param values - The values to update the plugin settings with.
|
|
52
47
|
*
|
|
53
48
|
* @returns The plugin settings.
|
|
54
49
|
*/
|
|
55
|
-
putPluginSettings(pluginId: string,
|
|
50
|
+
putPluginSettings(pluginId: string, agentId: string, values: any): Promise<PluginSettingsOutput>;
|
|
56
51
|
}
|
|
@@ -5,20 +5,18 @@ const abstract_1 = require("./abstract");
|
|
|
5
5
|
class PluginsEndpoint extends abstract_1.AbstractEndpoint {
|
|
6
6
|
prefix = "/plugins";
|
|
7
7
|
/**
|
|
8
|
-
* This endpoint returns the available plugins
|
|
9
|
-
* (for multi-agent installations) or for the default agent (for single-agent installations).
|
|
8
|
+
* This endpoint returns the available plugins.
|
|
10
9
|
*
|
|
11
|
-
* @param pluginName - The name of the plugin to filter the results by (optional).
|
|
12
10
|
* @param agentId - The ID of the agent to get the available plugins for.
|
|
11
|
+
* @param pluginName - The name of the plugin to filter the results by (optional).
|
|
13
12
|
*
|
|
14
13
|
* @returns The available plugins.
|
|
15
14
|
*/
|
|
16
|
-
async getAvailablePlugins(
|
|
15
|
+
async getAvailablePlugins(agentId, pluginName) {
|
|
17
16
|
return this.get(this.prefix, agentId, null, pluginName ? { query: pluginName } : {});
|
|
18
17
|
}
|
|
19
18
|
/**
|
|
20
|
-
* This endpoint toggles a plugin
|
|
21
|
-
* installations) or for the default agent (for single-agent installations).
|
|
19
|
+
* This endpoint toggles a plugin.
|
|
22
20
|
*
|
|
23
21
|
* @param pluginId - The ID of the plugin to toggle.
|
|
24
22
|
* @param agentId - The ID of the agent to toggle the plugin for.
|
|
@@ -26,11 +24,10 @@ class PluginsEndpoint extends abstract_1.AbstractEndpoint {
|
|
|
26
24
|
* @returns The plugin toggle output.
|
|
27
25
|
*/
|
|
28
26
|
async putTogglePlugin(pluginId, agentId) {
|
|
29
|
-
return this.put(this.formatUrl(`/toggle/${pluginId}`),
|
|
27
|
+
return this.put(this.formatUrl(`/toggle/${pluginId}`), agentId);
|
|
30
28
|
}
|
|
31
29
|
/**
|
|
32
|
-
* This endpoint retrieves the plugins settings
|
|
33
|
-
* (for multi-agent installations) or for the default agent (for single-agent installations).
|
|
30
|
+
* This endpoint retrieves the plugins settings.
|
|
34
31
|
*
|
|
35
32
|
* @param agentId - The ID of the agent to get the plugins settings for.
|
|
36
33
|
*
|
|
@@ -40,8 +37,7 @@ class PluginsEndpoint extends abstract_1.AbstractEndpoint {
|
|
|
40
37
|
return this.get(this.formatUrl("/settings"), agentId);
|
|
41
38
|
}
|
|
42
39
|
/**
|
|
43
|
-
* This endpoint retrieves the plugin settings
|
|
44
|
-
* (for multi-agent installations) or for the default agent (for single-agent installations).
|
|
40
|
+
* This endpoint retrieves the plugin settings.
|
|
45
41
|
*
|
|
46
42
|
* @param pluginId - The ID of the plugin to get the settings for.
|
|
47
43
|
* @param agentId - The ID of the agent to get the plugin settings for.
|
|
@@ -52,17 +48,16 @@ class PluginsEndpoint extends abstract_1.AbstractEndpoint {
|
|
|
52
48
|
return this.get(this.formatUrl(`/settings/${pluginId}`), agentId);
|
|
53
49
|
}
|
|
54
50
|
/**
|
|
55
|
-
* This endpoint updates the plugin settings
|
|
56
|
-
* (for multi-agent installations) or for the default agent (for single-agent installations).
|
|
51
|
+
* This endpoint updates the plugin settings.
|
|
57
52
|
*
|
|
58
53
|
* @param pluginId - The ID of the plugin to update the settings for.
|
|
59
|
-
* @param values - The values to update the plugin settings with.
|
|
60
54
|
* @param agentId - The ID of the agent to update the plugin settings for.
|
|
55
|
+
* @param values - The values to update the plugin settings with.
|
|
61
56
|
*
|
|
62
57
|
* @returns The plugin settings.
|
|
63
58
|
*/
|
|
64
|
-
async putPluginSettings(pluginId,
|
|
65
|
-
return this.put(this.formatUrl(`/settings/${pluginId}`),
|
|
59
|
+
async putPluginSettings(pluginId, agentId, values) {
|
|
60
|
+
return this.put(this.formatUrl(`/settings/${pluginId}`), agentId, values);
|
|
66
61
|
}
|
|
67
62
|
}
|
|
68
63
|
exports.PluginsEndpoint = PluginsEndpoint;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"plugins.js","sourceRoot":"","sources":["../../src/endpoints/plugins.ts"],"names":[],"mappings":";;;AAAA,yCAA4C;AAI5C,MAAa,eAAgB,SAAQ,2BAAgB;IACvC,MAAM,GAAG,UAAU,CAAC;IAE9B
|
|
1
|
+
{"version":3,"file":"plugins.js","sourceRoot":"","sources":["../../src/endpoints/plugins.ts"],"names":[],"mappings":";;;AAAA,yCAA4C;AAI5C,MAAa,eAAgB,SAAQ,2BAAgB;IACvC,MAAM,GAAG,UAAU,CAAC;IAE9B;;;;;;;OAOG;IACH,KAAK,CAAC,mBAAmB,CAAC,OAAe,EAAE,UAA0B;QACjE,OAAO,IAAI,CAAC,GAAG,CACX,IAAI,CAAC,MAAM,EACX,OAAO,EACP,IAAI,EACJ,UAAU,CAAC,CAAC,CAAC,EAAC,KAAK,EAAE,UAAU,EAAC,CAAC,CAAC,CAAC,EAAE,CACxC,CAAC;IACN,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,eAAe,CAAC,QAAgB,EAAE,OAAe;QACnD,OAAO,IAAI,CAAC,GAAG,CACX,IAAI,CAAC,SAAS,CAAC,WAAW,QAAQ,EAAE,CAAC,EACrC,OAAO,CACV,CAAC;IACN,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,kBAAkB,CAAC,OAAe;QACpC,OAAO,IAAI,CAAC,GAAG,CACX,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,EAC3B,OAAO,CACV,CAAC;IACN,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,iBAAiB,CAAC,QAAgB,EAAE,OAAe;QACrD,OAAO,IAAI,CAAC,GAAG,CACX,IAAI,CAAC,SAAS,CAAC,aAAa,QAAQ,EAAE,CAAC,EACvC,OAAO,CACV,CAAC;IACN,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,iBAAiB,CAAC,QAAgB,EAAE,OAAe,EAAE,MAAW;QAClE,OAAO,IAAI,CAAC,GAAG,CACX,IAAI,CAAC,SAAS,CAAC,aAAa,QAAQ,EAAE,CAAC,EACvC,OAAO,EACP,MAAM,CACT,CAAC;IACN,CAAC;CACJ;AAhFD,0CAgFC"}
|
|
@@ -28,10 +28,10 @@ export declare class RabbitHoleEndpoint extends AbstractEndpoint {
|
|
|
28
28
|
* @param fileSource The source of the file to upload:
|
|
29
29
|
* - In Node.js: A string path to the file
|
|
30
30
|
* - In browser: A File object
|
|
31
|
+
* @param agentId ID of the agent to associate with this upload
|
|
31
32
|
* @param fileName Optional custom name for the file. If not provided:
|
|
32
33
|
* - In Node.js: The basename of the file path is used
|
|
33
34
|
* - In browser: The name property of the File object is used
|
|
34
|
-
* @param agentId Optional ID of the agent to associate with this upload
|
|
35
35
|
* @param metadata Optional additional metadata to associate with the file
|
|
36
36
|
*
|
|
37
37
|
* @returns Promise resolving to the API response data
|
|
@@ -50,7 +50,7 @@ export declare class RabbitHoleEndpoint extends AbstractEndpoint {
|
|
|
50
50
|
* const response = await rabbitHoleEndpoint.postFile('/path/to/document.pdf');
|
|
51
51
|
* ```
|
|
52
52
|
*/
|
|
53
|
-
postFile(fileSource: FileSource,
|
|
53
|
+
postFile(fileSource: FileSource, agentId: string, fileName?: string | null, metadata?: Record<string, any> | null): Promise<any>;
|
|
54
54
|
/**
|
|
55
55
|
* This method posts a number of files to the RabbitHole API. The files are uploaded to the RabbitHole server and
|
|
56
56
|
* ingested into the RAG system.
|
|
@@ -67,7 +67,7 @@ export declare class RabbitHoleEndpoint extends AbstractEndpoint {
|
|
|
67
67
|
* @param fileSources The sources of the file to upload:
|
|
68
68
|
* - In Node.js: An array of strings path to the file
|
|
69
69
|
* - In browser: An array of File objects
|
|
70
|
-
* @param agentId
|
|
70
|
+
* @param agentId ID of the agent to associate with this upload
|
|
71
71
|
* @param metadata Optional additional metadata to associate with the file
|
|
72
72
|
*
|
|
73
73
|
* @returns Promise resolving to the API response data
|
|
@@ -86,7 +86,7 @@ export declare class RabbitHoleEndpoint extends AbstractEndpoint {
|
|
|
86
86
|
* const response = await rabbitHoleEndpoint.postFiles(['/path/to/first/document.pdf', '/path/to/second/document.pdf']);
|
|
87
87
|
* ```
|
|
88
88
|
*/
|
|
89
|
-
postFiles(fileSources: FileSource[], agentId
|
|
89
|
+
postFiles(fileSources: FileSource[], agentId: string, metadata?: Record<string, any> | null): Promise<any>;
|
|
90
90
|
/**
|
|
91
91
|
* This method posts a web URL to the RabbitHole API. The web URL is ingested into the RAG system. The web URL is
|
|
92
92
|
* processed by the RAG system by Web scraping, and the results are stored in the RAG database. The process is
|
|
@@ -95,24 +95,23 @@ export declare class RabbitHoleEndpoint extends AbstractEndpoint {
|
|
|
95
95
|
* process.
|
|
96
96
|
*
|
|
97
97
|
* @param webUrl The URL of the web page to be ingested.
|
|
98
|
-
* @param agentId The ID of the agent to be used for the upload.
|
|
98
|
+
* @param agentId The ID of the agent to be used for the upload.
|
|
99
99
|
* @param metadata Additional metadata to be associated with the web URL.
|
|
100
100
|
*
|
|
101
101
|
* @returns The response from the RabbitHole API.
|
|
102
102
|
*/
|
|
103
|
-
postWeb(webUrl: string, agentId
|
|
103
|
+
postWeb(webUrl: string, agentId: string, metadata?: Record<string, any> | null): Promise<any>;
|
|
104
104
|
/**
|
|
105
|
-
* This method posts a memory point
|
|
106
|
-
*
|
|
107
|
-
* RAG system. The process is asynchronous. The provided file must be in JSON format.
|
|
105
|
+
* This method posts a memory point. The memory point is ingested into the RAG system. The process is asynchronous.
|
|
106
|
+
* The provided file must be in JSON format.
|
|
108
107
|
* The CheshireCat processes the injection in the background, and the client will be informed at the end of the
|
|
109
108
|
* process.
|
|
110
109
|
*
|
|
111
110
|
* @param fileSource The source of the file to upload:
|
|
112
111
|
* - In Node.js: A string path to the file
|
|
113
112
|
* - In browser: A File object
|
|
113
|
+
* @param agentId The ID of the agent to be used for the upload.
|
|
114
114
|
* @param fileName The name of the file to be uploaded. If not provided, the name of the file will be used.
|
|
115
|
-
* @param agentId The ID of the agent to be used for the upload. If not provided, the default agent will be used.
|
|
116
115
|
*
|
|
117
116
|
* @returns The response from the RabbitHole API.
|
|
118
117
|
*
|
|
@@ -130,17 +129,14 @@ export declare class RabbitHoleEndpoint extends AbstractEndpoint {
|
|
|
130
129
|
* const response = await rabbitHoleEndpoint.postMemory('/path/to/document.json');
|
|
131
130
|
* ```
|
|
132
131
|
*/
|
|
133
|
-
postMemory(fileSource: FileSource,
|
|
132
|
+
postMemory(fileSource: FileSource, agentId: string, fileName?: string | null): Promise<any>;
|
|
134
133
|
/**
|
|
135
134
|
* This method retrieves the allowed MIME types for the RabbitHole API. The allowed MIME types are the MIME types
|
|
136
135
|
* that are allowed to be uploaded to the RabbitHole API. The allowed MIME types are returned in a list.
|
|
137
|
-
* If the agentId parameter is provided, the allowed MIME types are retrieved for the agent identified by the
|
|
138
|
-
* agentId parameter (for multi-agent installations). If the agentId parameter is not provided, the allowed MIME
|
|
139
|
-
* types are retrieved for the default agent (for single-agent installations).
|
|
140
136
|
*
|
|
141
137
|
* @param agentId The ID of the agent to be used for the upload. If not provided, the default agent will be used.
|
|
142
138
|
*
|
|
143
139
|
* @returns The allowed MIME types for the RabbitHole API.
|
|
144
140
|
*/
|
|
145
|
-
getAllowedMimeTypes(agentId
|
|
141
|
+
getAllowedMimeTypes(agentId: string): Promise<AllowedMimeTypesOutput>;
|
|
146
142
|
}
|
|
@@ -73,10 +73,10 @@ class RabbitHoleEndpoint extends abstract_1.AbstractEndpoint {
|
|
|
73
73
|
* @param fileSource The source of the file to upload:
|
|
74
74
|
* - In Node.js: A string path to the file
|
|
75
75
|
* - In browser: A File object
|
|
76
|
+
* @param agentId ID of the agent to associate with this upload
|
|
76
77
|
* @param fileName Optional custom name for the file. If not provided:
|
|
77
78
|
* - In Node.js: The basename of the file path is used
|
|
78
79
|
* - In browser: The name property of the File object is used
|
|
79
|
-
* @param agentId Optional ID of the agent to associate with this upload
|
|
80
80
|
* @param metadata Optional additional metadata to associate with the file
|
|
81
81
|
*
|
|
82
82
|
* @returns Promise resolving to the API response data
|
|
@@ -95,7 +95,7 @@ class RabbitHoleEndpoint extends abstract_1.AbstractEndpoint {
|
|
|
95
95
|
* const response = await rabbitHoleEndpoint.postFile('/path/to/document.pdf');
|
|
96
96
|
* ```
|
|
97
97
|
*/
|
|
98
|
-
async postFile(fileSource,
|
|
98
|
+
async postFile(fileSource, agentId, fileName, metadata) {
|
|
99
99
|
const form = (0, form_data_2.createFormData)();
|
|
100
100
|
try {
|
|
101
101
|
await this.appendFileToForm(form, fileSource, "file", fileName);
|
|
@@ -123,7 +123,7 @@ class RabbitHoleEndpoint extends abstract_1.AbstractEndpoint {
|
|
|
123
123
|
* @param fileSources The sources of the file to upload:
|
|
124
124
|
* - In Node.js: An array of strings path to the file
|
|
125
125
|
* - In browser: An array of File objects
|
|
126
|
-
* @param agentId
|
|
126
|
+
* @param agentId ID of the agent to associate with this upload
|
|
127
127
|
* @param metadata Optional additional metadata to associate with the file
|
|
128
128
|
*
|
|
129
129
|
* @returns Promise resolving to the API response data
|
|
@@ -164,7 +164,7 @@ class RabbitHoleEndpoint extends abstract_1.AbstractEndpoint {
|
|
|
164
164
|
* process.
|
|
165
165
|
*
|
|
166
166
|
* @param webUrl The URL of the web page to be ingested.
|
|
167
|
-
* @param agentId The ID of the agent to be used for the upload.
|
|
167
|
+
* @param agentId The ID of the agent to be used for the upload.
|
|
168
168
|
* @param metadata Additional metadata to be associated with the web URL.
|
|
169
169
|
*
|
|
170
170
|
* @returns The response from the RabbitHole API.
|
|
@@ -178,17 +178,16 @@ class RabbitHoleEndpoint extends abstract_1.AbstractEndpoint {
|
|
|
178
178
|
return response.data;
|
|
179
179
|
}
|
|
180
180
|
/**
|
|
181
|
-
* This method posts a memory point
|
|
182
|
-
*
|
|
183
|
-
* RAG system. The process is asynchronous. The provided file must be in JSON format.
|
|
181
|
+
* This method posts a memory point. The memory point is ingested into the RAG system. The process is asynchronous.
|
|
182
|
+
* The provided file must be in JSON format.
|
|
184
183
|
* The CheshireCat processes the injection in the background, and the client will be informed at the end of the
|
|
185
184
|
* process.
|
|
186
185
|
*
|
|
187
186
|
* @param fileSource The source of the file to upload:
|
|
188
187
|
* - In Node.js: A string path to the file
|
|
189
188
|
* - In browser: A File object
|
|
189
|
+
* @param agentId The ID of the agent to be used for the upload.
|
|
190
190
|
* @param fileName The name of the file to be uploaded. If not provided, the name of the file will be used.
|
|
191
|
-
* @param agentId The ID of the agent to be used for the upload. If not provided, the default agent will be used.
|
|
192
191
|
*
|
|
193
192
|
* @returns The response from the RabbitHole API.
|
|
194
193
|
*
|
|
@@ -206,7 +205,7 @@ class RabbitHoleEndpoint extends abstract_1.AbstractEndpoint {
|
|
|
206
205
|
* const response = await rabbitHoleEndpoint.postMemory('/path/to/document.json');
|
|
207
206
|
* ```
|
|
208
207
|
*/
|
|
209
|
-
async postMemory(fileSource,
|
|
208
|
+
async postMemory(fileSource, agentId, fileName) {
|
|
210
209
|
const form = new form_data_1.default();
|
|
211
210
|
try {
|
|
212
211
|
await this.appendFileToForm(form, fileSource, "file", fileName);
|
|
@@ -219,9 +218,6 @@ class RabbitHoleEndpoint extends abstract_1.AbstractEndpoint {
|
|
|
219
218
|
/**
|
|
220
219
|
* This method retrieves the allowed MIME types for the RabbitHole API. The allowed MIME types are the MIME types
|
|
221
220
|
* that are allowed to be uploaded to the RabbitHole API. The allowed MIME types are returned in a list.
|
|
222
|
-
* If the agentId parameter is provided, the allowed MIME types are retrieved for the agent identified by the
|
|
223
|
-
* agentId parameter (for multi-agent installations). If the agentId parameter is not provided, the allowed MIME
|
|
224
|
-
* types are retrieved for the default agent (for single-agent installations).
|
|
225
221
|
*
|
|
226
222
|
* @param agentId The ID of the agent to be used for the upload. If not provided, the default agent will be used.
|
|
227
223
|
*
|
|
@@ -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,kDAAsE;AAGtE,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,
|
|
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,kDAAsE;AAGtE,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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;IACH,KAAK,CAAC,QAAQ,CACV,UAAsB,EACtB,OAAe,EACf,QAAwB,EACxB,QAAqC;QAErC,MAAM,IAAI,GAAG,IAAA,0BAAc,GAAE,CAAC;QAE9B,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,IAAI,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAC7D,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACb,IAAI,CAAC,UAAU,CAAC,UAAU,EAAE,KAAK,CAAC,CAAA;QACtC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,KAAK,CAAC,SAAS,CACX,WAAyB,EACzB,OAAe,EACf,QAAqC;QAErC,MAAM,IAAI,GAAG,IAAI,mBAAQ,EAAE,CAAC;QAE5B,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,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC,CAAC;QAC1E,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACb,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAAA;QAC1C,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,OAAO,CACT,MAAc,EACd,OAAe,EACf,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,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,CAAC;QACzF,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;CACJ;AA/PD,gDA+PC"}
|
|
@@ -5,58 +5,48 @@ import { SettingOutputItem } from "../models/api/settings";
|
|
|
5
5
|
export declare class SettingsEndpoint extends AbstractEndpoint {
|
|
6
6
|
protected prefix: string;
|
|
7
7
|
/**
|
|
8
|
-
* This endpoint returns the settings of the agent identified by the agentId parameter
|
|
9
|
-
* You can omit the agentId parameter in a single-agent installation. In this case, the settings of the default
|
|
10
|
-
* agent are returned.
|
|
8
|
+
* This endpoint returns the settings of the agent identified by the agentId parameter.
|
|
11
9
|
*
|
|
12
10
|
* @param agentId The agent ID
|
|
13
11
|
*
|
|
14
12
|
* @returns The settings of the agent
|
|
15
13
|
*/
|
|
16
|
-
getSettings(agentId
|
|
14
|
+
getSettings(agentId: string): Promise<FactoryObjectSettingsOutput>;
|
|
17
15
|
/**
|
|
18
|
-
* This method creates a new setting for the agent identified by the agentId parameter
|
|
19
|
-
* You can omit the agentId parameter in a single-agent installation. In this case, the setting is created for the
|
|
20
|
-
* default agent.
|
|
16
|
+
* This method creates a new setting for the agent identified by the agentId parameter.
|
|
21
17
|
*
|
|
22
|
-
* @param values The values of the setting
|
|
23
18
|
* @param agentId The agent ID
|
|
19
|
+
* @param values The values of the setting
|
|
24
20
|
*
|
|
25
21
|
* @returns The created setting
|
|
26
22
|
*/
|
|
27
|
-
postSetting(
|
|
23
|
+
postSetting(agentId: string, values: SettingInput): Promise<SettingOutputItem>;
|
|
28
24
|
/**
|
|
29
|
-
* This endpoint returns the setting identified by the settingId parameter.
|
|
30
|
-
* identified by the agentId parameter (multi-agent installations). You can omit the agentId parameter in a
|
|
31
|
-
* single-agent installation. In this case, the setting is looked up in the default agent.
|
|
25
|
+
* This endpoint returns the setting identified by the settingId parameter.
|
|
32
26
|
*
|
|
33
27
|
* @param setting The setting ID
|
|
34
28
|
* @param agentId The agent ID
|
|
35
29
|
*
|
|
36
30
|
* @returns The setting
|
|
37
31
|
*/
|
|
38
|
-
getSetting(setting: string, agentId
|
|
32
|
+
getSetting(setting: string, agentId: string): Promise<FactoryObjectSettingsOutput>;
|
|
39
33
|
/**
|
|
40
|
-
* This method updates the setting identified by the settingId parameter.
|
|
41
|
-
* identified by the agentId parameter (multi-agent installations). You can omit the agentId parameter in a
|
|
42
|
-
* single-agent installation. In this case, the setting is updated in the default agent.
|
|
34
|
+
* This method updates the setting identified by the settingId parameter.
|
|
43
35
|
*
|
|
44
36
|
* @param setting The setting ID
|
|
45
|
-
* @param values The new values of the setting
|
|
46
37
|
* @param agentId The agent ID
|
|
38
|
+
* @param values The new values of the setting
|
|
47
39
|
*
|
|
48
40
|
* @returns The updated setting
|
|
49
41
|
*/
|
|
50
|
-
putSetting(setting: string, values: Record<string, any
|
|
42
|
+
putSetting(setting: string, agentId: string, values: Record<string, any>): Promise<FactoryObjectSettingsOutput>;
|
|
51
43
|
/**
|
|
52
|
-
* This endpoint deletes the setting identified by the settingId parameter.
|
|
53
|
-
* identified by the agentId parameter (multi-agent installations). You can omit the agentId parameter in a
|
|
54
|
-
* single-agent installation. In this case, the setting is deleted from the default agent.
|
|
44
|
+
* This endpoint deletes the setting identified by the settingId parameter.
|
|
55
45
|
*
|
|
56
46
|
* @param setting The setting ID
|
|
57
47
|
* @param agentId The agent ID
|
|
58
48
|
*
|
|
59
49
|
* @returns The deleted setting
|
|
60
50
|
*/
|
|
61
|
-
deleteSetting(setting: string, agentId
|
|
51
|
+
deleteSetting(setting: string, agentId: string): Promise<FactoryObjectSettingsOutput>;
|
|
62
52
|
}
|
|
@@ -5,9 +5,7 @@ const abstract_1 = require("./abstract");
|
|
|
5
5
|
class SettingsEndpoint extends abstract_1.AbstractEndpoint {
|
|
6
6
|
prefix = "/settings";
|
|
7
7
|
/**
|
|
8
|
-
* This endpoint returns the settings of the agent identified by the agentId parameter
|
|
9
|
-
* You can omit the agentId parameter in a single-agent installation. In this case, the settings of the default
|
|
10
|
-
* agent are returned.
|
|
8
|
+
* This endpoint returns the settings of the agent identified by the agentId parameter.
|
|
11
9
|
*
|
|
12
10
|
* @param agentId The agent ID
|
|
13
11
|
*
|
|
@@ -17,22 +15,18 @@ class SettingsEndpoint extends abstract_1.AbstractEndpoint {
|
|
|
17
15
|
return this.get(this.formatUrl("/settings"), agentId);
|
|
18
16
|
}
|
|
19
17
|
/**
|
|
20
|
-
* This method creates a new setting for the agent identified by the agentId parameter
|
|
21
|
-
* You can omit the agentId parameter in a single-agent installation. In this case, the setting is created for the
|
|
22
|
-
* default agent.
|
|
18
|
+
* This method creates a new setting for the agent identified by the agentId parameter.
|
|
23
19
|
*
|
|
24
|
-
* @param values The values of the setting
|
|
25
20
|
* @param agentId The agent ID
|
|
21
|
+
* @param values The values of the setting
|
|
26
22
|
*
|
|
27
23
|
* @returns The created setting
|
|
28
24
|
*/
|
|
29
|
-
async postSetting(
|
|
30
|
-
return this.post(this.prefix, values.toArray()
|
|
25
|
+
async postSetting(agentId, values) {
|
|
26
|
+
return this.post(this.prefix, agentId, values.toArray());
|
|
31
27
|
}
|
|
32
28
|
/**
|
|
33
|
-
* This endpoint returns the setting identified by the settingId parameter.
|
|
34
|
-
* identified by the agentId parameter (multi-agent installations). You can omit the agentId parameter in a
|
|
35
|
-
* single-agent installation. In this case, the setting is looked up in the default agent.
|
|
29
|
+
* This endpoint returns the setting identified by the settingId parameter.
|
|
36
30
|
*
|
|
37
31
|
* @param setting The setting ID
|
|
38
32
|
* @param agentId The agent ID
|
|
@@ -43,23 +37,19 @@ class SettingsEndpoint extends abstract_1.AbstractEndpoint {
|
|
|
43
37
|
return this.get(this.formatUrl(`/settings/${setting}`), agentId);
|
|
44
38
|
}
|
|
45
39
|
/**
|
|
46
|
-
* This method updates the setting identified by the settingId parameter.
|
|
47
|
-
* identified by the agentId parameter (multi-agent installations). You can omit the agentId parameter in a
|
|
48
|
-
* single-agent installation. In this case, the setting is updated in the default agent.
|
|
40
|
+
* This method updates the setting identified by the settingId parameter.
|
|
49
41
|
*
|
|
50
42
|
* @param setting The setting ID
|
|
51
|
-
* @param values The new values of the setting
|
|
52
43
|
* @param agentId The agent ID
|
|
44
|
+
* @param values The new values of the setting
|
|
53
45
|
*
|
|
54
46
|
* @returns The updated setting
|
|
55
47
|
*/
|
|
56
|
-
async putSetting(setting,
|
|
57
|
-
return this.put(this.formatUrl(`/settings/${setting}`),
|
|
48
|
+
async putSetting(setting, agentId, values) {
|
|
49
|
+
return this.put(this.formatUrl(`/settings/${setting}`), agentId, values);
|
|
58
50
|
}
|
|
59
51
|
/**
|
|
60
|
-
* This endpoint deletes the setting identified by the settingId parameter.
|
|
61
|
-
* identified by the agentId parameter (multi-agent installations). You can omit the agentId parameter in a
|
|
62
|
-
* single-agent installation. In this case, the setting is deleted from the default agent.
|
|
52
|
+
* This endpoint deletes the setting identified by the settingId parameter.
|
|
63
53
|
*
|
|
64
54
|
* @param setting The setting ID
|
|
65
55
|
* @param agentId The agent ID
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"settings.js","sourceRoot":"","sources":["../../src/endpoints/settings.ts"],"names":[],"mappings":";;;AAAA,yCAA4C;AAK5C,MAAa,gBAAiB,SAAQ,2BAAgB;IACxC,MAAM,GAAG,WAAW,CAAC;IAE/B
|
|
1
|
+
{"version":3,"file":"settings.js","sourceRoot":"","sources":["../../src/endpoints/settings.ts"],"names":[],"mappings":";;;AAAA,yCAA4C;AAK5C,MAAa,gBAAiB,SAAQ,2BAAgB;IACxC,MAAM,GAAG,WAAW,CAAC;IAE/B;;;;;;OAMG;IACH,KAAK,CAAC,WAAW,CAAC,OAAe;QAC7B,OAAO,IAAI,CAAC,GAAG,CACX,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,EAC3B,OAAO,CACV,CAAC;IACN,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,WAAW,CAAC,OAAe,EAAE,MAAoB;QACnD,OAAO,IAAI,CAAC,IAAI,CACZ,IAAI,CAAC,MAAM,EACX,OAAO,EACP,MAAM,CAAC,OAAO,EAAE,CACnB,CAAC;IACN,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,UAAU,CAAC,OAAe,EAAE,OAAe;QAC7C,OAAO,IAAI,CAAC,GAAG,CACX,IAAI,CAAC,SAAS,CAAC,aAAa,OAAO,EAAE,CAAC,EACtC,OAAO,CACV,CAAC;IACN,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,UAAU,CACZ,OAAe,EACf,OAAe,EACf,MAA2B;QAE3B,OAAO,IAAI,CAAC,GAAG,CACX,IAAI,CAAC,SAAS,CAAC,aAAa,OAAO,EAAE,CAAC,EACtC,OAAO,EACP,MAAM,CACT,CAAC;IACN,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,aAAa,CAAC,OAAe,EAAE,OAAe;QAChD,OAAO,IAAI,CAAC,MAAM,CACd,IAAI,CAAC,SAAS,CAAC,aAAa,OAAO,EAAE,CAAC,EACtC,OAAO,CACV,CAAC;IACN,CAAC;CACJ;AAnFD,4CAmFC"}
|