@wildix/xbees-users-client 4.0.3 → 4.0.4

package/dist-cjs/models/enums.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.WorkspaceType = exports.BotLlmToolType = exports.BotLlmFunctionIntegrationMethod = exports.BotLlmEmbeddedToolType = exports.BotCapabilityToolPipelineType = exports.BotIntegrationType = exports.BotAccess = exports.AppType = exports.PbxColleaguesSearchStrategy = exports.PbxColleaguesQueryField = exports.GetPbxColleaguesDir = exports.PbxColleagueRole = exports.PbxLicenseType = void 0;
+exports.WorkspaceType = exports.BotLlmToolType = exports.BotLlmFunctionIntegrationMethod = exports.BotLlmEmbeddedToolType = exports.BotCapabilityToolPipelineType = exports.BotIntegrationType = exports.BotAccess = exports.AppType = exports.PbxColleaguesSearchStrategy = exports.PbxColleaguesQueryField = exports.GetPbxColleaguesDir = exports.PbxColleagueRole = exports.SearchThresholdValue = exports.SearchStrategy = exports.PbxLicenseType = void 0;
 exports.PbxLicenseType = {
     BASIC: "basic",
     BUSINESS: "business",
@@ -8,6 +8,16 @@ exports.PbxLicenseType = {
     PREMIUM: "premium",
     WIZYCONF: "wizyconf",
 };
+exports.SearchStrategy = {
+    BM25: "bm25",
+    HYBRID: "hybrid",
+    VECTOR: "vector",
+};
+exports.SearchThresholdValue = {
+    HIGH: "high",
+    LOW: "low",
+    MEDIUM: "medium",
+};
 exports.PbxColleagueRole = {
     ADMIN: "admin",
     FAX: "fax",

package/dist-cjs/schemas/schemas_0.js

@@ -369,8 +369,10 @@ const _sE = "syntheticEmail";
 const _sF = "searchFields";
 const _sI = "sourceId";
 const _sIk = "skippedInvitees";
+const _sL = "searchLimit";
 const _sP = "sipPassword";
 const _sS = "searchStrategy";
+const _sT = "searchThreshold";
 const _sU = "streamUser";
 const _sc = "scope";
 const _se = "searchable";
@@ -633,8 +635,8 @@ exports.BotDialogflowCxEndpoint$ = [3, n3, _BDCE,
 ];
 exports.BotKnowledgeBase$ = [3, n3, _BKB,
     0,
-    [_kBI, _in, _an],
-    [0, 0, () => BotToolAnnotationsList]
+    [_kBI, _in, _sS, _sT, _sL, _an],
+    [0, 0, 0, 0, 1, () => BotToolAnnotationsList]
 ];
 exports.BotLlmEmbeddedTool$ = [3, n3, _BLET,
     0,

package/dist-es/models/enums.js

@@ -5,6 +5,16 @@ export const PbxLicenseType = {
     PREMIUM: "premium",
     WIZYCONF: "wizyconf",
 };
+export const SearchStrategy = {
+    BM25: "bm25",
+    HYBRID: "hybrid",
+    VECTOR: "vector",
+};
+export const SearchThresholdValue = {
+    HIGH: "high",
+    LOW: "low",
+    MEDIUM: "medium",
+};
 export const PbxColleagueRole = {
     ADMIN: "admin",
     FAX: "fax",

package/dist-es/schemas/schemas_0.js

@@ -362,8 +362,10 @@ const _sE = "syntheticEmail";
 const _sF = "searchFields";
 const _sI = "sourceId";
 const _sIk = "skippedInvitees";
+const _sL = "searchLimit";
 const _sP = "sipPassword";
 const _sS = "searchStrategy";
+const _sT = "searchThreshold";
 const _sU = "streamUser";
 const _sc = "scope";
 const _se = "searchable";
@@ -626,8 +628,8 @@ export var BotDialogflowCxEndpoint$ = [3, n3, _BDCE,
 ];
 export var BotKnowledgeBase$ = [3, n3, _BKB,
     0,
-    [_kBI, _in, _an],
-    [0, 0, () => BotToolAnnotationsList]
+    [_kBI, _in, _sS, _sT, _sL, _an],
+    [0, 0, 0, 0, 1, () => BotToolAnnotationsList]
 ];
 export var BotLlmEmbeddedTool$ = [3, n3, _BLET,
     0,

package/dist-types/commands/CreateBotCommand.d.ts

@@ -173,6 +173,9 @@ declare const CreateBotCommand_base: {
  *             kb: { // BotKnowledgeBase
  *               knowledgeBaseId: "STRING_VALUE",
  *               instructions: "STRING_VALUE",
+ *               searchStrategy: "bm25" || "vector" || "hybrid",
+ *               searchThreshold: "low" || "medium" || "high",
+ *               searchLimit: Number("int"),
  *               annotations: [
  *                 {//  Union: only one key present
  *                   tag: {

package/dist-types/commands/GetBotCallbackCommand.d.ts

@@ -172,6 +172,9 @@ declare const GetBotCallbackCommand_base: {
  * //             kb: { // BotKnowledgeBase
  * //               knowledgeBaseId: "STRING_VALUE",
  * //               instructions: "STRING_VALUE",
+ * //               searchStrategy: "bm25" || "vector" || "hybrid",
+ * //               searchThreshold: "low" || "medium" || "high",
+ * //               searchLimit: Number("int"),
  * //               annotations: [
  * //                 {//  Union: only one key present
  * //                   tag: {

package/dist-types/commands/UpdateBotCallbackCommand.d.ts

@@ -168,6 +168,9 @@ declare const UpdateBotCallbackCommand_base: {
  *             kb: { // BotKnowledgeBase
  *               knowledgeBaseId: "STRING_VALUE",
  *               instructions: "STRING_VALUE",
+ *               searchStrategy: "bm25" || "vector" || "hybrid",
+ *               searchThreshold: "low" || "medium" || "high",
+ *               searchLimit: Number("int"),
  *               annotations: [
  *                 {//  Union: only one key present
  *                   tag: {
@@ -342,6 +345,9 @@ declare const UpdateBotCallbackCommand_base: {
  * //             kb: { // BotKnowledgeBase
  * //               knowledgeBaseId: "STRING_VALUE",
  * //               instructions: "STRING_VALUE",
+ * //               searchStrategy: "bm25" || "vector" || "hybrid",
+ * //               searchThreshold: "low" || "medium" || "high",
+ * //               searchLimit: Number("int"),
  * //               annotations: [
  * //                 {//  Union: only one key present
  * //                   tag: {

package/dist-types/models/enums.d.ts

@@ -13,6 +13,32 @@ export declare const PbxLicenseType: {
  * @public
  */
 export type PbxLicenseType = (typeof PbxLicenseType)[keyof typeof PbxLicenseType];
+/**
+ * @public
+ * @enum
+ */
+export declare const SearchStrategy: {
+    readonly BM25: "bm25";
+    readonly HYBRID: "hybrid";
+    readonly VECTOR: "vector";
+};
+/**
+ * @public
+ */
+export type SearchStrategy = (typeof SearchStrategy)[keyof typeof SearchStrategy];
+/**
+ * @public
+ * @enum
+ */
+export declare const SearchThresholdValue: {
+    readonly HIGH: "high";
+    readonly LOW: "low";
+    readonly MEDIUM: "medium";
+};
+/**
+ * @public
+ */
+export type SearchThresholdValue = (typeof SearchThresholdValue)[keyof typeof SearchThresholdValue];
 /**
  * @public
  * @enum

package/dist-types/models/models_0.d.ts

@@ -1,5 +1,5 @@
 import type { DocumentType as __DocumentType } from "@smithy/types";
-import type { AppType, BotAccess, BotCapabilityToolPipelineType, BotIntegrationType, BotLlmEmbeddedToolType, BotLlmFunctionIntegrationMethod, BotLlmToolType, GetPbxColleaguesDir, PbxColleagueRole, PbxColleaguesQueryField, PbxColleaguesSearchStrategy, PbxLicenseType, WorkspaceType } from "./enums";
+import type { AppType, BotAccess, BotCapabilityToolPipelineType, BotIntegrationType, BotLlmEmbeddedToolType, BotLlmFunctionIntegrationMethod, BotLlmToolType, GetPbxColleaguesDir, PbxColleagueRole, PbxColleaguesQueryField, PbxColleaguesSearchStrategy, PbxLicenseType, SearchStrategy, SearchThresholdValue, WorkspaceType } from "./enums";
 /**
  * @public
  */
@@ -705,6 +705,21 @@ export interface BotKnowledgeBase {
      * @public
      */
     instructions?: string | undefined;
+    /**
+     * Search algorithm strategy used for this knowledge base capability.
+     * @public
+     */
+    searchStrategy?: SearchStrategy | undefined;
+    /**
+     * Minimum similarity threshold used for this knowledge base capability.
+     * @public
+     */
+    searchThreshold?: SearchThresholdValue | undefined;
+    /**
+     * Maximum number of search results returned by this knowledge base capability.
+     * @public
+     */
+    searchLimit?: number | undefined;
     annotations?: BotToolAnnotation[] | undefined;
 }
 /**

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@wildix/xbees-users-client",
     "description": "@wildix/xbees-users-client client",
-    "version": "4.0.3",
+    "version": "4.0.4",
     "scripts": {
         "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
         "build:cjs": "tsc -p tsconfig.cjs.json",