@wildix/xbees-users-client 1.3.0 → 1.3.1

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.
Files changed (12) hide show
  1. package/dist-cjs/models/models_0.js +15 -1
  2. package/dist-cjs/protocols/Aws_restJson1.js +4 -0
  3. package/dist-es/models/models_0.js +14 -0
  4. package/dist-es/protocols/Aws_restJson1.js +4 -0
  5. package/dist-types/commands/CreateBotCommand.d.ts +64 -0
  6. package/dist-types/commands/GetBotCallbackCommand.d.ts +64 -0
  7. package/dist-types/commands/UpdateBotCallbackCommand.d.ts +128 -0
  8. package/dist-types/models/models_0.d.ts +130 -0
  9. package/dist-types/runtimeConfig.browser.d.ts +1 -1
  10. package/dist-types/runtimeConfig.d.ts +1 -1
  11. package/dist-types/runtimeConfig.native.d.ts +1 -1
  12. package/package.json +1 -1
package/dist-cjs/models/models_0.js CHANGED
@@ -1,6 +1,6 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.WorkspaceNotFoundException = exports.UserQueryPredicateNotMetException = exports.UserQuery = exports.IdentityNotFoundException = exports.IdentityAlreadyLinkedException = exports.WorkspaceType = exports.PublicAccessIsRestrictedException = exports.UserNotFoundException = exports.UserCompanyNotValidException = exports.CannotUnbindDefaultWorkspaceException = exports.CannotRemovePrimaryIdentityException = exports.BotSecretKeyNotValidException = exports.BotNotFoundException = exports.BotEndpoint = exports.BotLlmToolType = exports.BotLlmFunctionIntegration = exports.BotLlmFunctionIntegrationMethod = exports.BotLlmFunctionIntegrationWebhookAuthorization = exports.BotLlmEmbeddedToolType = exports.BotCapability = exports.BotToolVariableHandler = exports.BotCapabilityToolPipelineType = exports.BotApiKeyNotFoundException = exports.BotIntegrationType = exports.BotAccess = exports.AppType = exports.AnonymousEntryContext = exports.AccountNotFoundException = exports.WidgetNotFoundException = exports.ChannelNotFoundException = exports.PbxColleaguesSearchStrategy = exports.PbxColleaguesQueryField = exports.GetPbxColleaguesDir = exports.PbxColleagueRole = exports.PbxLicenseType = exports.ValidationException = exports.ForbiddenException = void 0;
3
+ exports.WorkspaceNotFoundException = exports.UserQueryPredicateNotMetException = exports.UserQuery = exports.IdentityNotFoundException = exports.IdentityAlreadyLinkedException = exports.WorkspaceType = exports.PublicAccessIsRestrictedException = exports.UserNotFoundException = exports.UserCompanyNotValidException = exports.CannotUnbindDefaultWorkspaceException = exports.CannotRemovePrimaryIdentityException = exports.BotSecretKeyNotValidException = exports.BotNotFoundException = exports.BotEndpoint = exports.BotLlmToolType = exports.BotLlmFunctionIntegration = exports.BotLlmFunctionIntegrationMethod = exports.BotLlmFunctionIntegrationWebhookAuthorization = exports.BotLlmEmbeddedToolType = exports.BotCapability = exports.BotToolVariableHandler = exports.BotCapabilityToolPipelineType = exports.BotToolAnnotation = exports.BotApiKeyNotFoundException = exports.BotIntegrationType = exports.BotAccess = exports.AppType = exports.AnonymousEntryContext = exports.AccountNotFoundException = exports.WidgetNotFoundException = exports.ChannelNotFoundException = exports.PbxColleaguesSearchStrategy = exports.PbxColleaguesQueryField = exports.GetPbxColleaguesDir = exports.PbxColleagueRole = exports.PbxLicenseType = exports.ValidationException = exports.ForbiddenException = void 0;
4
4
  const UsersServiceException_1 = require("./UsersServiceException");
5
5
  class ForbiddenException extends UsersServiceException_1.UsersServiceException {
6
6
  name = "ForbiddenException";
@@ -147,6 +147,20 @@ class BotApiKeyNotFoundException extends UsersServiceException_1.UsersServiceExc
147
147
  }
148
148
  }
149
149
  exports.BotApiKeyNotFoundException = BotApiKeyNotFoundException;
150
+ var BotToolAnnotation;
151
+ (function (BotToolAnnotation) {
152
+ BotToolAnnotation.visit = (value, visitor) => {
153
+ if (value.tag !== undefined)
154
+ return visitor.tag(value.tag);
155
+ if (value.comment !== undefined)
156
+ return visitor.comment(value.comment);
157
+ if (value.variables !== undefined)
158
+ return visitor.variables(value.variables);
159
+ if (value.result !== undefined)
160
+ return visitor.result(value.result);
161
+ return visitor._(value.$unknown[0], value.$unknown[1]);
162
+ };
163
+ })(BotToolAnnotation || (exports.BotToolAnnotation = BotToolAnnotation = {}));
150
164
  exports.BotCapabilityToolPipelineType = {
151
165
  ASYNC_REQUEST: "async_request",
152
166
  ASYNC_REQUEST_GUIDED: "async_request_guided",
package/dist-cjs/protocols/Aws_restJson1.js CHANGED
@@ -1733,6 +1733,7 @@ const se_BotEndpoint = (input, context) => {
1733
1733
  };
1734
1734
  const se_BotLlmEmbeddedTool = (input, context) => {
1735
1735
  return (0, smithy_client_1.take)(input, {
1736
+ 'annotations': smithy_client_1._json,
1736
1737
  'name': [],
1737
1738
  'parameters': _ => se_Document(_, context),
1738
1739
  'type': [],
@@ -1780,6 +1781,7 @@ const se_BotLlmFunctionIntegrationWebhook = (input, context) => {
1780
1781
  };
1781
1782
  const se_BotLlmTool = (input, context) => {
1782
1783
  return (0, smithy_client_1.take)(input, {
1784
+ 'annotations': smithy_client_1._json,
1783
1785
  'function': _ => se_BotLlmFunctionDefinition(_, context),
1784
1786
  'type': [],
1785
1787
  });
@@ -1835,6 +1837,7 @@ const de_BotEndpoint = (output, context) => {
1835
1837
  };
1836
1838
  const de_BotLlmEmbeddedTool = (output, context) => {
1837
1839
  return (0, smithy_client_1.take)(output, {
1840
+ 'annotations': smithy_client_1._json,
1838
1841
  'name': smithy_client_1.expectString,
1839
1842
  'parameters': (_) => de_Document(_, context),
1840
1843
  'type': smithy_client_1.expectString,
@@ -1885,6 +1888,7 @@ const de_BotLlmFunctionIntegrationWebhook = (output, context) => {
1885
1888
  };
1886
1889
  const de_BotLlmTool = (output, context) => {
1887
1890
  return (0, smithy_client_1.take)(output, {
1891
+ 'annotations': smithy_client_1._json,
1888
1892
  'function': (_) => de_BotLlmFunctionDefinition(_, context),
1889
1893
  'type': smithy_client_1.expectString,
1890
1894
  });
package/dist-es/models/models_0.js CHANGED
@@ -138,6 +138,20 @@ export class BotApiKeyNotFoundException extends __BaseException {
138
138
  Object.setPrototypeOf(this, BotApiKeyNotFoundException.prototype);
139
139
  }
140
140
  }
141
+ export var BotToolAnnotation;
142
+ (function (BotToolAnnotation) {
143
+ BotToolAnnotation.visit = (value, visitor) => {
144
+ if (value.tag !== undefined)
145
+ return visitor.tag(value.tag);
146
+ if (value.comment !== undefined)
147
+ return visitor.comment(value.comment);
148
+ if (value.variables !== undefined)
149
+ return visitor.variables(value.variables);
150
+ if (value.result !== undefined)
151
+ return visitor.result(value.result);
152
+ return visitor._(value.$unknown[0], value.$unknown[1]);
153
+ };
154
+ })(BotToolAnnotation || (BotToolAnnotation = {}));
141
155
  export const BotCapabilityToolPipelineType = {
142
156
  ASYNC_REQUEST: "async_request",
143
157
  ASYNC_REQUEST_GUIDED: "async_request_guided",
package/dist-es/protocols/Aws_restJson1.js CHANGED
@@ -1639,6 +1639,7 @@ const se_BotEndpoint = (input, context) => {
1639
1639
  };
1640
1640
  const se_BotLlmEmbeddedTool = (input, context) => {
1641
1641
  return take(input, {
1642
+ 'annotations': _json,
1642
1643
  'name': [],
1643
1644
  'parameters': _ => se_Document(_, context),
1644
1645
  'type': [],
@@ -1686,6 +1687,7 @@ const se_BotLlmFunctionIntegrationWebhook = (input, context) => {
1686
1687
  };
1687
1688
  const se_BotLlmTool = (input, context) => {
1688
1689
  return take(input, {
1690
+ 'annotations': _json,
1689
1691
  'function': _ => se_BotLlmFunctionDefinition(_, context),
1690
1692
  'type': [],
1691
1693
  });
@@ -1741,6 +1743,7 @@ const de_BotEndpoint = (output, context) => {
1741
1743
  };
1742
1744
  const de_BotLlmEmbeddedTool = (output, context) => {
1743
1745
  return take(output, {
1746
+ 'annotations': _json,
1744
1747
  'name': __expectString,
1745
1748
  'parameters': (_) => de_Document(_, context),
1746
1749
  'type': __expectString,
@@ -1791,6 +1794,7 @@ const de_BotLlmFunctionIntegrationWebhook = (output, context) => {
1791
1794
  };
1792
1795
  const de_BotLlmTool = (output, context) => {
1793
1796
  return take(output, {
1797
+ 'annotations': _json,
1794
1798
  'function': (_) => de_BotLlmFunctionDefinition(_, context),
1795
1799
  'type': __expectString,
1796
1800
  });
package/dist-types/commands/CreateBotCommand.d.ts CHANGED
@@ -55,6 +55,22 @@ declare const CreateBotCommand_base: {
55
55
  * type: "HANDOVER" || "DELEGATE" || "SUGGESTIONS", // required
56
56
  * name: "STRING_VALUE", // required
57
57
  * parameters: "DOCUMENT_VALUE",
58
+ * annotations: [ // BotToolAnnotationsList
59
+ * { // BotToolAnnotation Union: only one key present
60
+ * tag: { // BotToolTagAnnotation
61
+ * value: "STRING_VALUE",
62
+ * applyOnSuccess: true || false,
63
+ * applyOnFailure: true || false,
64
+ * },
65
+ * comment: { // BotToolCommentAnnotation
66
+ * value: "STRING_VALUE",
67
+ * applyOnSuccess: true || false,
68
+ * applyOnFailure: true || false,
69
+ * },
70
+ * variables: {},
71
+ * result: {},
72
+ * },
73
+ * ],
58
74
  * },
59
75
  * ],
60
76
  * tools: [ // BotLlmToolsList
@@ -95,6 +111,22 @@ declare const CreateBotCommand_base: {
95
111
  * },
96
112
  * },
97
113
  * },
114
+ * annotations: [
115
+ * {// Union: only one key present
116
+ * tag: {
117
+ * value: "STRING_VALUE",
118
+ * applyOnSuccess: true || false,
119
+ * applyOnFailure: true || false,
120
+ * },
121
+ * comment: {
122
+ * value: "STRING_VALUE",
123
+ * applyOnSuccess: true || false,
124
+ * applyOnFailure: true || false,
125
+ * },
126
+ * variables: {},
127
+ * result: {},
128
+ * },
129
+ * ],
98
130
  * },
99
131
  * ],
100
132
  * capabilities: [ // BotCapabilitiesList
@@ -119,10 +151,42 @@ declare const CreateBotCommand_base: {
119
151
  * type: "blocking_request" || "blocking_request_guided" || "async_request" || "async_request_guided",
120
152
  * instructions: "STRING_VALUE",
121
153
  * },
154
+ * annotations: [
155
+ * {// Union: only one key present
156
+ * tag: {
157
+ * value: "STRING_VALUE",
158
+ * applyOnSuccess: true || false,
159
+ * applyOnFailure: true || false,
160
+ * },
161
+ * comment: {
162
+ * value: "STRING_VALUE",
163
+ * applyOnSuccess: true || false,
164
+ * applyOnFailure: true || false,
165
+ * },
166
+ * variables: {},
167
+ * result: {},
168
+ * },
169
+ * ],
122
170
  * },
123
171
  * kb: { // BotKnowledgeBase
124
172
  * knowledgeBaseId: "STRING_VALUE",
125
173
  * instructions: "STRING_VALUE",
174
+ * annotations: [
175
+ * {// Union: only one key present
176
+ * tag: {
177
+ * value: "STRING_VALUE",
178
+ * applyOnSuccess: true || false,
179
+ * applyOnFailure: true || false,
180
+ * },
181
+ * comment: {
182
+ * value: "STRING_VALUE",
183
+ * applyOnSuccess: true || false,
184
+ * applyOnFailure: true || false,
185
+ * },
186
+ * variables: {},
187
+ * result: {},
188
+ * },
189
+ * ],
126
190
  * },
127
191
  * },
128
192
  * ],
package/dist-types/commands/GetBotCallbackCommand.d.ts CHANGED
@@ -54,6 +54,22 @@ declare const GetBotCallbackCommand_base: {
54
54
  * // type: "HANDOVER" || "DELEGATE" || "SUGGESTIONS", // required
55
55
  * // name: "STRING_VALUE", // required
56
56
  * // parameters: "DOCUMENT_VALUE",
57
+ * // annotations: [ // BotToolAnnotationsList
58
+ * // { // BotToolAnnotation Union: only one key present
59
+ * // tag: { // BotToolTagAnnotation
60
+ * // value: "STRING_VALUE",
61
+ * // applyOnSuccess: true || false,
62
+ * // applyOnFailure: true || false,
63
+ * // },
64
+ * // comment: { // BotToolCommentAnnotation
65
+ * // value: "STRING_VALUE",
66
+ * // applyOnSuccess: true || false,
67
+ * // applyOnFailure: true || false,
68
+ * // },
69
+ * // variables: {},
70
+ * // result: {},
71
+ * // },
72
+ * // ],
57
73
  * // },
58
74
  * // ],
59
75
  * // tools: [ // BotLlmToolsList
@@ -94,6 +110,22 @@ declare const GetBotCallbackCommand_base: {
94
110
  * // },
95
111
  * // },
96
112
  * // },
113
+ * // annotations: [
114
+ * // {// Union: only one key present
115
+ * // tag: {
116
+ * // value: "STRING_VALUE",
117
+ * // applyOnSuccess: true || false,
118
+ * // applyOnFailure: true || false,
119
+ * // },
120
+ * // comment: {
121
+ * // value: "STRING_VALUE",
122
+ * // applyOnSuccess: true || false,
123
+ * // applyOnFailure: true || false,
124
+ * // },
125
+ * // variables: {},
126
+ * // result: {},
127
+ * // },
128
+ * // ],
97
129
  * // },
98
130
  * // ],
99
131
  * // capabilities: [ // BotCapabilitiesList
@@ -118,10 +150,42 @@ declare const GetBotCallbackCommand_base: {
118
150
  * // type: "blocking_request" || "blocking_request_guided" || "async_request" || "async_request_guided",
119
151
  * // instructions: "STRING_VALUE",
120
152
  * // },
153
+ * // annotations: [
154
+ * // {// Union: only one key present
155
+ * // tag: {
156
+ * // value: "STRING_VALUE",
157
+ * // applyOnSuccess: true || false,
158
+ * // applyOnFailure: true || false,
159
+ * // },
160
+ * // comment: {
161
+ * // value: "STRING_VALUE",
162
+ * // applyOnSuccess: true || false,
163
+ * // applyOnFailure: true || false,
164
+ * // },
165
+ * // variables: {},
166
+ * // result: {},
167
+ * // },
168
+ * // ],
121
169
  * // },
122
170
  * // kb: { // BotKnowledgeBase
123
171
  * // knowledgeBaseId: "STRING_VALUE",
124
172
  * // instructions: "STRING_VALUE",
173
+ * // annotations: [
174
+ * // {// Union: only one key present
175
+ * // tag: {
176
+ * // value: "STRING_VALUE",
177
+ * // applyOnSuccess: true || false,
178
+ * // applyOnFailure: true || false,
179
+ * // },
180
+ * // comment: {
181
+ * // value: "STRING_VALUE",
182
+ * // applyOnSuccess: true || false,
183
+ * // applyOnFailure: true || false,
184
+ * // },
185
+ * // variables: {},
186
+ * // result: {},
187
+ * // },
188
+ * // ],
125
189
  * // },
126
190
  * // },
127
191
  * // ],
package/dist-types/commands/UpdateBotCallbackCommand.d.ts CHANGED
@@ -50,6 +50,22 @@ declare const UpdateBotCallbackCommand_base: {
50
50
  * type: "HANDOVER" || "DELEGATE" || "SUGGESTIONS", // required
51
51
  * name: "STRING_VALUE", // required
52
52
  * parameters: "DOCUMENT_VALUE",
53
+ * annotations: [ // BotToolAnnotationsList
54
+ * { // BotToolAnnotation Union: only one key present
55
+ * tag: { // BotToolTagAnnotation
56
+ * value: "STRING_VALUE",
57
+ * applyOnSuccess: true || false,
58
+ * applyOnFailure: true || false,
59
+ * },
60
+ * comment: { // BotToolCommentAnnotation
61
+ * value: "STRING_VALUE",
62
+ * applyOnSuccess: true || false,
63
+ * applyOnFailure: true || false,
64
+ * },
65
+ * variables: {},
66
+ * result: {},
67
+ * },
68
+ * ],
53
69
  * },
54
70
  * ],
55
71
  * tools: [ // BotLlmToolsList
@@ -90,6 +106,22 @@ declare const UpdateBotCallbackCommand_base: {
90
106
  * },
91
107
  * },
92
108
  * },
109
+ * annotations: [
110
+ * {// Union: only one key present
111
+ * tag: {
112
+ * value: "STRING_VALUE",
113
+ * applyOnSuccess: true || false,
114
+ * applyOnFailure: true || false,
115
+ * },
116
+ * comment: {
117
+ * value: "STRING_VALUE",
118
+ * applyOnSuccess: true || false,
119
+ * applyOnFailure: true || false,
120
+ * },
121
+ * variables: {},
122
+ * result: {},
123
+ * },
124
+ * ],
93
125
  * },
94
126
  * ],
95
127
  * capabilities: [ // BotCapabilitiesList
@@ -114,10 +146,42 @@ declare const UpdateBotCallbackCommand_base: {
114
146
  * type: "blocking_request" || "blocking_request_guided" || "async_request" || "async_request_guided",
115
147
  * instructions: "STRING_VALUE",
116
148
  * },
149
+ * annotations: [
150
+ * {// Union: only one key present
151
+ * tag: {
152
+ * value: "STRING_VALUE",
153
+ * applyOnSuccess: true || false,
154
+ * applyOnFailure: true || false,
155
+ * },
156
+ * comment: {
157
+ * value: "STRING_VALUE",
158
+ * applyOnSuccess: true || false,
159
+ * applyOnFailure: true || false,
160
+ * },
161
+ * variables: {},
162
+ * result: {},
163
+ * },
164
+ * ],
117
165
  * },
118
166
  * kb: { // BotKnowledgeBase
119
167
  * knowledgeBaseId: "STRING_VALUE",
120
168
  * instructions: "STRING_VALUE",
169
+ * annotations: [
170
+ * {// Union: only one key present
171
+ * tag: {
172
+ * value: "STRING_VALUE",
173
+ * applyOnSuccess: true || false,
174
+ * applyOnFailure: true || false,
175
+ * },
176
+ * comment: {
177
+ * value: "STRING_VALUE",
178
+ * applyOnSuccess: true || false,
179
+ * applyOnFailure: true || false,
180
+ * },
181
+ * variables: {},
182
+ * result: {},
183
+ * },
184
+ * ],
121
185
  * },
122
186
  * },
123
187
  * ],
@@ -160,6 +224,22 @@ declare const UpdateBotCallbackCommand_base: {
160
224
  * // type: "HANDOVER" || "DELEGATE" || "SUGGESTIONS", // required
161
225
  * // name: "STRING_VALUE", // required
162
226
  * // parameters: "DOCUMENT_VALUE",
227
+ * // annotations: [ // BotToolAnnotationsList
228
+ * // { // BotToolAnnotation Union: only one key present
229
+ * // tag: { // BotToolTagAnnotation
230
+ * // value: "STRING_VALUE",
231
+ * // applyOnSuccess: true || false,
232
+ * // applyOnFailure: true || false,
233
+ * // },
234
+ * // comment: { // BotToolCommentAnnotation
235
+ * // value: "STRING_VALUE",
236
+ * // applyOnSuccess: true || false,
237
+ * // applyOnFailure: true || false,
238
+ * // },
239
+ * // variables: {},
240
+ * // result: {},
241
+ * // },
242
+ * // ],
163
243
  * // },
164
244
  * // ],
165
245
  * // tools: [ // BotLlmToolsList
@@ -200,6 +280,22 @@ declare const UpdateBotCallbackCommand_base: {
200
280
  * // },
201
281
  * // },
202
282
  * // },
283
+ * // annotations: [
284
+ * // {// Union: only one key present
285
+ * // tag: {
286
+ * // value: "STRING_VALUE",
287
+ * // applyOnSuccess: true || false,
288
+ * // applyOnFailure: true || false,
289
+ * // },
290
+ * // comment: {
291
+ * // value: "STRING_VALUE",
292
+ * // applyOnSuccess: true || false,
293
+ * // applyOnFailure: true || false,
294
+ * // },
295
+ * // variables: {},
296
+ * // result: {},
297
+ * // },
298
+ * // ],
203
299
  * // },
204
300
  * // ],
205
301
  * // capabilities: [ // BotCapabilitiesList
@@ -224,10 +320,42 @@ declare const UpdateBotCallbackCommand_base: {
224
320
  * // type: "blocking_request" || "blocking_request_guided" || "async_request" || "async_request_guided",
225
321
  * // instructions: "STRING_VALUE",
226
322
  * // },
323
+ * // annotations: [
324
+ * // {// Union: only one key present
325
+ * // tag: {
326
+ * // value: "STRING_VALUE",
327
+ * // applyOnSuccess: true || false,
328
+ * // applyOnFailure: true || false,
329
+ * // },
330
+ * // comment: {
331
+ * // value: "STRING_VALUE",
332
+ * // applyOnSuccess: true || false,
333
+ * // applyOnFailure: true || false,
334
+ * // },
335
+ * // variables: {},
336
+ * // result: {},
337
+ * // },
338
+ * // ],
227
339
  * // },
228
340
  * // kb: { // BotKnowledgeBase
229
341
  * // knowledgeBaseId: "STRING_VALUE",
230
342
  * // instructions: "STRING_VALUE",
343
+ * // annotations: [
344
+ * // {// Union: only one key present
345
+ * // tag: {
346
+ * // value: "STRING_VALUE",
347
+ * // applyOnSuccess: true || false,
348
+ * // applyOnFailure: true || false,
349
+ * // },
350
+ * // comment: {
351
+ * // value: "STRING_VALUE",
352
+ * // applyOnSuccess: true || false,
353
+ * // applyOnFailure: true || false,
354
+ * // },
355
+ * // variables: {},
356
+ * // result: {},
357
+ * // },
358
+ * // ],
231
359
  * // },
232
360
  * // },
233
361
  * // ],
package/dist-types/models/models_0.d.ts CHANGED
@@ -731,6 +731,132 @@ export declare class BotApiKeyNotFoundException extends __BaseException {
731
731
  */
732
732
  constructor(opts: __ExceptionOptionType<BotApiKeyNotFoundException, __BaseException>);
733
733
  }
734
+ /**
735
+ * Comment annotation emitted after a tool completes.
736
+ * @public
737
+ */
738
+ export interface BotToolCommentAnnotation {
739
+ /**
740
+ * Static handlebars expression resolved against bot variables and helpers.
741
+ * @public
742
+ */
743
+ value?: string | undefined;
744
+ /**
745
+ * Apply when the tool succeeds.
746
+ * @public
747
+ */
748
+ applyOnSuccess?: boolean | undefined;
749
+ /**
750
+ * Apply when the tool fails.
751
+ * @public
752
+ */
753
+ applyOnFailure?: boolean | undefined;
754
+ }
755
+ /**
756
+ * Result annotation emitted after a tool completes.
757
+ * @public
758
+ */
759
+ export interface BotToolResultAnnotation {
760
+ }
761
+ /**
762
+ * Tag annotation emitted after a tool completes.
763
+ * @public
764
+ */
765
+ export interface BotToolTagAnnotation {
766
+ /**
767
+ * Static handlebars expression resolved against bot variables and helpers.
768
+ * @public
769
+ */
770
+ value?: string | undefined;
771
+ /**
772
+ * Apply when the tool succeeds.
773
+ * @public
774
+ */
775
+ applyOnSuccess?: boolean | undefined;
776
+ /**
777
+ * Apply when the tool fails.
778
+ * @public
779
+ */
780
+ applyOnFailure?: boolean | undefined;
781
+ }
782
+ /**
783
+ * Variables annotation emitted after a tool completes.
784
+ * @public
785
+ */
786
+ export interface BotToolVariablesAnnotation {
787
+ }
788
+ /**
789
+ * Configuration for annotations emitted after a tool completes. Tag and comment annotations can provide a handlebars value, while variables and result annotations opt into logging runtime data.
790
+ * @public
791
+ */
792
+ export type BotToolAnnotation = BotToolAnnotation.CommentMember | BotToolAnnotation.ResultMember | BotToolAnnotation.TagMember | BotToolAnnotation.VariablesMember | BotToolAnnotation.$UnknownMember;
793
+ /**
794
+ * @public
795
+ */
796
+ export declare namespace BotToolAnnotation {
797
+ /**
798
+ * Tag annotation emitted after a tool completes.
799
+ * @public
800
+ */
801
+ interface TagMember {
802
+ tag: BotToolTagAnnotation;
803
+ comment?: never;
804
+ variables?: never;
805
+ result?: never;
806
+ $unknown?: never;
807
+ }
808
+ /**
809
+ * Comment annotation emitted after a tool completes.
810
+ * @public
811
+ */
812
+ interface CommentMember {
813
+ tag?: never;
814
+ comment: BotToolCommentAnnotation;
815
+ variables?: never;
816
+ result?: never;
817
+ $unknown?: never;
818
+ }
819
+ /**
820
+ * Variables annotation emitted after a tool completes.
821
+ * @public
822
+ */
823
+ interface VariablesMember {
824
+ tag?: never;
825
+ comment?: never;
826
+ variables: BotToolVariablesAnnotation;
827
+ result?: never;
828
+ $unknown?: never;
829
+ }
830
+ /**
831
+ * Result annotation emitted after a tool completes.
832
+ * @public
833
+ */
834
+ interface ResultMember {
835
+ tag?: never;
836
+ comment?: never;
837
+ variables?: never;
838
+ result: BotToolResultAnnotation;
839
+ $unknown?: never;
840
+ }
841
+ /**
842
+ * @public
843
+ */
844
+ interface $UnknownMember {
845
+ tag?: never;
846
+ comment?: never;
847
+ variables?: never;
848
+ result?: never;
849
+ $unknown: [string, any];
850
+ }
851
+ interface Visitor<T> {
852
+ tag: (value: BotToolTagAnnotation) => T;
853
+ comment: (value: BotToolCommentAnnotation) => T;
854
+ variables: (value: BotToolVariablesAnnotation) => T;
855
+ result: (value: BotToolResultAnnotation) => T;
856
+ _: (name: string, value: any) => T;
857
+ }
858
+ const visit: <T>(value: BotToolAnnotation, visitor: Visitor<T>) => T;
859
+ }
734
860
  /**
735
861
  * @public
736
862
  */
@@ -741,6 +867,7 @@ export interface BotKnowledgeBase {
741
867
  * @public
742
868
  */
743
869
  instructions?: string | undefined;
870
+ annotations?: (BotToolAnnotation)[] | undefined;
744
871
  }
745
872
  /**
746
873
  * @public
@@ -853,6 +980,7 @@ export interface BotCapabilityTool {
853
980
  id: string;
854
981
  variables?: (BotToolVariable)[] | undefined;
855
982
  pipeline?: BotCapabilityToolPipeline | undefined;
983
+ annotations?: (BotToolAnnotation)[] | undefined;
856
984
  }
857
985
  /**
858
986
  * @public
@@ -911,6 +1039,7 @@ export interface BotLlmEmbeddedTool {
911
1039
  * @public
912
1040
  */
913
1041
  parameters?: __DocumentType | undefined;
1042
+ annotations?: (BotToolAnnotation)[] | undefined;
914
1043
  }
915
1044
  /**
916
1045
  * @public
@@ -1078,6 +1207,7 @@ export type BotLlmToolType = typeof BotLlmToolType[keyof typeof BotLlmToolType];
1078
1207
  export interface BotLlmTool {
1079
1208
  type: BotLlmToolType;
1080
1209
  function?: BotLlmFunctionDefinition | undefined;
1210
+ annotations?: (BotToolAnnotation)[] | undefined;
1081
1211
  }
1082
1212
  /**
1083
1213
  * @public
package/dist-types/runtimeConfig.browser.d.ts CHANGED
@@ -9,7 +9,7 @@ export declare const getRuntimeConfig: (config: UsersClientConfig) => {
9
9
  bodyLengthChecker: import("@smithy/types").BodyLengthCalculator;
10
10
  defaultUserAgentProvider: (config?: import("@aws-sdk/util-user-agent-browser").PreviouslyResolved | undefined) => Promise<import("@smithy/types").UserAgent>;
11
11
  maxAttempts: number | import("@smithy/types").Provider<number>;
12
- requestHandler: import("@smithy/protocol-http").HttpHandler<any> | RequestHandler;
12
+ requestHandler: import("@smithy/core/protocols").HttpHandler<any> | RequestHandler;
13
13
  retryMode: string | import("@smithy/types").Provider<string>;
14
14
  sha256: import("@smithy/types").HashConstructor;
15
15
  streamCollector: import("@smithy/types").StreamCollector;
package/dist-types/runtimeConfig.d.ts CHANGED
@@ -9,7 +9,7 @@ export declare const getRuntimeConfig: (config: UsersClientConfig) => {
9
9
  bodyLengthChecker: import("@smithy/types").BodyLengthCalculator;
10
10
  defaultUserAgentProvider: (config?: import("@aws-sdk/util-user-agent-node").PreviouslyResolved | undefined) => Promise<import("@smithy/types").UserAgent>;
11
11
  maxAttempts: number | import("@smithy/types").Provider<number>;
12
- requestHandler: RequestHandler | import("@smithy/protocol-http").HttpHandler<any>;
12
+ requestHandler: RequestHandler | import("@smithy/core/protocols").HttpHandler<any>;
13
13
  retryMode: string | import("@smithy/types").Provider<string>;
14
14
  sha256: import("@smithy/types").HashConstructor;
15
15
  streamCollector: import("@smithy/types").StreamCollector;
package/dist-types/runtimeConfig.native.d.ts CHANGED
@@ -7,7 +7,7 @@ export declare const getRuntimeConfig: (config: UsersClientConfig) => {
7
7
  sha256: import("@smithy/types").HashConstructor;
8
8
  env?: "stage" | "stable" | "prod" | undefined;
9
9
  token: import("@wildix/smithy-utils").TokenProvider;
10
- requestHandler: import("@smithy/types").NodeHttpHandlerOptions | import("@smithy/types").FetchHttpHandlerOptions | Record<string, unknown> | import("@smithy/protocol-http").HttpHandler<any> | import("@smithy/fetch-http-handler").FetchHttpHandler;
10
+ requestHandler: import("@smithy/types").NodeHttpHandlerOptions | import("@smithy/types").FetchHttpHandlerOptions | Record<string, unknown> | import("@smithy/core/protocols").HttpHandler<any> | import("@smithy/fetch-http-handler").FetchHttpHandler;
11
11
  cacheMiddleware?: boolean | undefined;
12
12
  protocol?: import("@smithy/types").ClientProtocol<any, any> | import("@smithy/types").$ClientProtocol<any, any> | import("@smithy/types").ClientProtocolCtor<any, any> | import("@smithy/types").$ClientProtocolCtor<any, any> | undefined;
13
13
  protocolSettings?: {
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@wildix/xbees-users-client",
3
3
  "description": "@wildix/xbees-users-client client",
4
- "version": "1.3.0",
4
+ "version": "1.3.1",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",