@wildix/wim-knowledge-base-client 0.0.49 → 0.0.51

package/dist-cjs/models/models_0.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SearchThresholdValue = exports.SyncLogLevel = exports.SyncDataSourceStatus = exports.SyncDataSourceMode = exports.DownloadDocumentType = exports.DocumentStatus = exports.DataSourceType = exports.ScheduleConfiguration = exports.DataSourceConfig = exports.KnowledgeBaseNotFoundException = exports.DocumentNotFoundException = exports.DataSourceNotFoundException = exports.UnauthorizedException = exports.ForbiddenException = exports.ValidationException = void 0;
+exports.SearchThresholdValue = exports.SearchStrategy = exports.SyncLogLevel = exports.SyncDataSourceStatus = exports.SyncDataSourceMode = exports.DownloadDocumentType = exports.DocumentStatus = exports.DataSourceType = exports.ScheduleConfiguration = exports.DataSourceConfig = exports.KnowledgeBaseNotFoundException = exports.DocumentNotFoundException = exports.DataSourceNotFoundException = exports.UnauthorizedException = exports.ForbiddenException = exports.ValidationException = void 0;
 const KnowledgeBaseServiceException_1 = require("./KnowledgeBaseServiceException");
 class ValidationException extends KnowledgeBaseServiceException_1.KnowledgeBaseServiceException {
     name = "ValidationException";
@@ -131,6 +131,11 @@ exports.SyncLogLevel = {
     INFO: "info",
     WARN: "warn",
 };
+exports.SearchStrategy = {
+    BM25: "bm25",
+    HYBRID: "hybrid",
+    VECTOR: "vector",
+};
 exports.SearchThresholdValue = {
     HIGH: "high",
     LOW: "low",

package/dist-cjs/protocols/Aws_restJson1.js

@@ -503,6 +503,7 @@ const se_SearchKnowledgeBaseCommand = async (input, context) => {
         'externalSessionId': [],
         'query': [],
         'searchLimit': [],
+        'searchStrategy': [],
         'searchThreshold': [],
         'searchUser': [],
         'useQueryOptimization': [],
@@ -763,8 +764,8 @@ const de_GenerateSearchAnswerCommand = async (output, context) => {
     const data = (0, smithy_client_1.expectNonNull)(((0, smithy_client_1.expectObject)(await (0, core_1.parseJsonBody)(output.body, context))), "body");
     const doc = (0, smithy_client_1.take)(data, {
         'answer': smithy_client_1.expectString,
-        'metadata': _ => de_Document(_, context),
-        'sources': _ => de_Document(_, context),
+        'metadata': smithy_client_1._json,
+        'sources': _ => de_SearchKnowledgeBaseResults(_, context),
     });
     Object.assign(contents, doc);
     return contents;
@@ -1011,7 +1012,7 @@ const de_SearchKnowledgeBaseCommand = async (output, context) => {
     });
     const data = (0, smithy_client_1.expectNonNull)(((0, smithy_client_1.expectObject)(await (0, core_1.parseJsonBody)(output.body, context))), "body");
     const doc = (0, smithy_client_1.take)(data, {
-        'metadata': _ => de_Document(_, context),
+        'metadata': smithy_client_1._json,
         'results': _ => de_SearchKnowledgeBaseResults(_, context),
     });
     Object.assign(contents, doc);

package/dist-es/models/models_0.js

@@ -122,6 +122,11 @@ export const SyncLogLevel = {
     INFO: "info",
     WARN: "warn",
 };
+export const SearchStrategy = {
+    BM25: "bm25",
+    HYBRID: "hybrid",
+    VECTOR: "vector",
+};
 export const SearchThresholdValue = {
     HIGH: "high",
     LOW: "low",

package/dist-es/protocols/Aws_restJson1.js

@@ -473,6 +473,7 @@ export const se_SearchKnowledgeBaseCommand = async (input, context) => {
         'externalSessionId': [],
         'query': [],
         'searchLimit': [],
+        'searchStrategy': [],
         'searchThreshold': [],
         'searchUser': [],
         'useQueryOptimization': [],
@@ -717,8 +718,8 @@ export const de_GenerateSearchAnswerCommand = async (output, context) => {
     const data = __expectNonNull((__expectObject(await parseBody(output.body, context))), "body");
     const doc = take(data, {
         'answer': __expectString,
-        'metadata': _ => de_Document(_, context),
-        'sources': _ => de_Document(_, context),
+        'metadata': _json,
+        'sources': _ => de_SearchKnowledgeBaseResults(_, context),
     });
     Object.assign(contents, doc);
     return contents;
@@ -949,7 +950,7 @@ export const de_SearchKnowledgeBaseCommand = async (output, context) => {
     });
     const data = __expectNonNull((__expectObject(await parseBody(output.body, context))), "body");
     const doc = take(data, {
-        'metadata': _ => de_Document(_, context),
+        'metadata': _json,
         'results': _ => de_SearchKnowledgeBaseResults(_, context),
     });
     Object.assign(contents, doc);

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

@@ -60,8 +60,26 @@ declare const GenerateSearchAnswerCommand_base: {
  * const response = await client.send(command);
  * // { // GenerateSearchAnswerOutput
  * //   answer: "STRING_VALUE", // required
- * //   metadata: "DOCUMENT_VALUE", // required
- * //   sources: "DOCUMENT_VALUE", // required
+ * //   metadata: { // AnswerMetadata
+ * //     model: "STRING_VALUE", // required
+ * //     inputTokens: Number("int"), // required
+ * //     outputTokens: Number("int"), // required
+ * //     duration: Number("int"), // required
+ * //   },
+ * //   sources: [ // SearchKnowledgeBaseResults // required
+ * //     { // SearchKnowledgeBaseResult
+ * //       documentId: "STRING_VALUE", // required
+ * //       documentTitle: "STRING_VALUE", // required
+ * //       documentUrl: "STRING_VALUE", // required
+ * //       dataSourceId: "STRING_VALUE", // required
+ * //       dataSourceType: "files" || "confluence" || "gdrive", // required
+ * //       content: "STRING_VALUE", // required
+ * //       score: Number("double"), // required
+ * //       documentHierarchy: [ // StringList
+ * //         "STRING_VALUE",
+ * //       ],
+ * //     },
+ * //   ],
  * // };
  *
  * ```

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

@@ -38,6 +38,7 @@ declare const SearchKnowledgeBaseCommand_base: {
  *   companyId: "STRING_VALUE",
  *   knowledgeBaseId: "STRING_VALUE", // required
  *   query: "STRING_VALUE", // required
+ *   searchStrategy: "bm25" || "vector" || "hybrid",
  *   searchLimit: Number("int"),
  *   searchThreshold: "low" || "medium" || "high",
  *   useQueryOptimization: true || false,
@@ -61,7 +62,11 @@ declare const SearchKnowledgeBaseCommand_base: {
  * //       ],
  * //     },
  * //   ],
- * //   metadata: "DOCUMENT_VALUE",
+ * //   metadata: { // SearchResultMetadata
+ * //     duration: Number("int"), // required
+ * //     inputTokens: Number("int"), // required
+ * //     outputTokens: Number("int"), // required
+ * //   },
  * // };
  *
  * ```

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

@@ -34,6 +34,15 @@ export declare class UnauthorizedException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<UnauthorizedException, __BaseException>);
 }
+/**
+ * @public
+ */
+export interface AnswerMetadata {
+    model: string;
+    inputTokens: number;
+    outputTokens: number;
+    duration: number;
+}
 /**
  * @public
  */
@@ -1018,8 +1027,8 @@ export interface GenerateSearchAnswerInput {
  */
 export interface GenerateSearchAnswerOutput {
     answer: string;
-    metadata: __DocumentType;
-    sources: __DocumentType;
+    metadata: AnswerMetadata;
+    sources: (SearchKnowledgeBaseResult)[];
 }
 /**
  * @public
@@ -1490,6 +1499,19 @@ export interface ListSearchQueriesHistoryInput {
 export interface ListSearchQueriesHistoryOutput {
     results: (__DocumentType)[];
 }
+/**
+ * @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
@@ -1522,6 +1544,11 @@ export interface SearchKnowledgeBaseInput {
      * @public
      */
     query: string;
+    /**
+     * Search algorithm strategy: 'bm25' (full-text keyword search), 'vector' (semantic similarity search using embeddings), 'hybrid' (combines both methods for best results). Defaults to 'hybrid' if not specified
+     * @public
+     */
+    searchStrategy?: SearchStrategy | undefined;
     /**
      * Maximum number of search results to return. Controls the size of the result set. Valid range: 1-50. Defaults to 10 if not specified. Higher values return more results but may include less relevant matches
      * @public
@@ -1548,12 +1575,20 @@ export interface SearchKnowledgeBaseInput {
      */
     externalSessionId?: string | undefined;
 }
+/**
+ * @public
+ */
+export interface SearchResultMetadata {
+    duration: number;
+    inputTokens: number;
+    outputTokens: number;
+}
 /**
  * @public
  */
 export interface SearchKnowledgeBaseOutput {
     results: (SearchKnowledgeBaseResult)[];
-    metadata?: __DocumentType | undefined;
+    metadata: SearchResultMetadata;
 }
 /**
  * @public

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@wildix/wim-knowledge-base-client",
     "description": "@wildix/wim-knowledge-base-client client",
-    "version": "0.0.49",
+    "version": "0.0.51",
     "scripts": {
         "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
         "build:cjs": "tsc -p tsconfig.cjs.json",