@wildix/wim-knowledge-base-client 0.0.52 → 0.0.54

package/dist-cjs/protocols/Aws_restJson1.js

@@ -216,7 +216,7 @@ const se_GenerateSearchAnswerCommand = async (input, context) => {
         'maxOutputTokens': [],
         'model': [],
         'searchQuery': [],
-        'searchResults': _ => se_SearchKnowledgeBaseResults(_, context),
+        'searchResults': _ => se_SearchKnowledgeBaseResultsList(_, context),
         'systemPrompt': [],
         'temperature': _ => (0, smithy_client_1.serializeFloat)(_),
     }));
@@ -765,7 +765,7 @@ const de_GenerateSearchAnswerCommand = async (output, context) => {
     const doc = (0, smithy_client_1.take)(data, {
         'answer': smithy_client_1.expectString,
         'metadata': smithy_client_1._json,
-        'sources': _ => de_SearchKnowledgeBaseResults(_, context),
+        'sources': _ => de_SearchKnowledgeBaseResultsList(_, context),
     });
     Object.assign(contents, doc);
     return contents;
@@ -996,7 +996,7 @@ const de_ListSearchQueriesHistoryCommand = 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, {
-        'results': _ => de_SearchHistoryResultsList(_, context),
+        'history': _ => de_SearchHistoryList(_, context),
     });
     Object.assign(contents, doc);
     return contents;
@@ -1012,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': smithy_client_1._json,
-        'results': _ => de_SearchKnowledgeBaseResults(_, context),
+        'results': _ => de_SearchKnowledgeBaseResultsList(_, context),
     });
     Object.assign(contents, doc);
     return contents;
@@ -1217,8 +1217,9 @@ const se_DescribeDataSourceParameters = (input, context) => {
         'proxy': _ => se_Document(_, context),
     });
 };
-const se_SearchKnowledgeBaseResult = (input, context) => {
+const se_SearchKnowledgeBaseResultItem = (input, context) => {
     return (0, smithy_client_1.take)(input, {
+        'chunkId': [],
         'content': [],
         'dataSourceId': [],
         'dataSourceType': [],
@@ -1231,9 +1232,9 @@ const se_SearchKnowledgeBaseResult = (input, context) => {
         'semanticScore': smithy_client_1.serializeFloat,
     });
 };
-const se_SearchKnowledgeBaseResults = (input, context) => {
+const se_SearchKnowledgeBaseResultsList = (input, context) => {
     return input.filter((e) => e != null).map(entry => {
-        return se_SearchKnowledgeBaseResult(entry, context);
+        return se_SearchKnowledgeBaseResultItem(entry, context);
     });
 };
 const de_Document = (output, context) => {
@@ -1284,61 +1285,38 @@ const de_DescribeDataSourceResult = (output, context) => {
         'proxy': (_) => de_Document(_, context),
     });
 };
-const de_SearchHistoryRequest = (output, context) => {
-    return (0, smithy_client_1.take)(output, {
-        'externalSessionId': smithy_client_1.expectString,
-        'knowledgeBaseId': smithy_client_1.expectString,
-        'query': smithy_client_1.expectString,
-        'searchLimit': smithy_client_1.expectInt32,
-        'searchStrategy': smithy_client_1.expectString,
-        'searchThreshold': smithy_client_1.limitedParseDouble,
-        'user': smithy_client_1.expectString,
-    });
-};
-const de_SearchHistoryResponse = (output, context) => {
-    return (0, smithy_client_1.take)(output, {
-        'results': (_) => de_SearchHistorySearchResults(_, context),
-    });
-};
-const de_SearchHistoryResult = (output, context) => {
+const de_SearchHistoryItem = (output, context) => {
     return (0, smithy_client_1.take)(output, {
+        'chunks': (_) => de_SearchKnowledgeBaseResultsList(_, context),
+        'chunksCount': smithy_client_1.expectInt32,
         'companyId': smithy_client_1.expectString,
         'createdAt': (_) => (0, smithy_client_1.expectNonNull)((0, smithy_client_1.parseEpochTimestamp)((0, smithy_client_1.expectNumber)(_))),
         'request': (_) => de_SearchHistoryRequest(_, context),
-        'response': (_) => de_SearchHistoryResponse(_, context),
-        'resultsCount': smithy_client_1.expectInt32,
         'sessionId': smithy_client_1.expectString,
         'stages': smithy_client_1._json,
         'totalDuration': smithy_client_1.expectInt32,
     });
 };
-const de_SearchHistoryResultsList = (output, context) => {
+const de_SearchHistoryList = (output, context) => {
     const retVal = (output || []).filter((e) => e != null).map((entry) => {
-        return de_SearchHistoryResult(entry, context);
+        return de_SearchHistoryItem(entry, context);
     });
     return retVal;
 };
-const de_SearchHistorySearchResult = (output, context) => {
+const de_SearchHistoryRequest = (output, context) => {
     return (0, smithy_client_1.take)(output, {
-        'bm25Score': smithy_client_1.limitedParseDouble,
-        'chunkId': smithy_client_1.expectString,
-        'dataSourceId': smithy_client_1.expectString,
-        'dataSourceType': smithy_client_1.expectString,
-        'documentId': smithy_client_1.expectString,
-        'documentTitle': smithy_client_1.expectString,
-        'documentUrl': smithy_client_1.expectString,
-        'knnScore': smithy_client_1.limitedParseDouble,
-        'score': smithy_client_1.limitedParseDouble,
-    });
-};
-const de_SearchHistorySearchResults = (output, context) => {
-    const retVal = (output || []).filter((e) => e != null).map((entry) => {
-        return de_SearchHistorySearchResult(entry, context);
+        'externalSessionId': smithy_client_1.expectString,
+        'knowledgeBaseId': smithy_client_1.expectString,
+        'query': smithy_client_1.expectString,
+        'searchLimit': smithy_client_1.expectInt32,
+        'searchStrategy': smithy_client_1.expectString,
+        'searchThreshold': smithy_client_1.limitedParseDouble,
+        'user': smithy_client_1.expectString,
     });
-    return retVal;
 };
-const de_SearchKnowledgeBaseResult = (output, context) => {
+const de_SearchKnowledgeBaseResultItem = (output, context) => {
     return (0, smithy_client_1.take)(output, {
+        'chunkId': smithy_client_1.expectString,
         'content': smithy_client_1.expectString,
         'dataSourceId': smithy_client_1.expectString,
         'dataSourceType': smithy_client_1.expectString,
@@ -1351,9 +1329,9 @@ const de_SearchKnowledgeBaseResult = (output, context) => {
         'semanticScore': smithy_client_1.limitedParseDouble,
     });
 };
-const de_SearchKnowledgeBaseResults = (output, context) => {
+const de_SearchKnowledgeBaseResultsList = (output, context) => {
     const retVal = (output || []).filter((e) => e != null).map((entry) => {
-        return de_SearchKnowledgeBaseResult(entry, context);
+        return de_SearchKnowledgeBaseResultItem(entry, context);
     });
     return retVal;
 };

package/dist-es/protocols/Aws_restJson1.js

@@ -202,7 +202,7 @@ export const se_GenerateSearchAnswerCommand = async (input, context) => {
         'maxOutputTokens': [],
         'model': [],
         'searchQuery': [],
-        'searchResults': _ => se_SearchKnowledgeBaseResults(_, context),
+        'searchResults': _ => se_SearchKnowledgeBaseResultsList(_, context),
         'systemPrompt': [],
         'temperature': _ => __serializeFloat(_),
     }));
@@ -719,7 +719,7 @@ export const de_GenerateSearchAnswerCommand = async (output, context) => {
     const doc = take(data, {
         'answer': __expectString,
         'metadata': _json,
-        'sources': _ => de_SearchKnowledgeBaseResults(_, context),
+        'sources': _ => de_SearchKnowledgeBaseResultsList(_, context),
     });
     Object.assign(contents, doc);
     return contents;
@@ -935,7 +935,7 @@ export const de_ListSearchQueriesHistoryCommand = async (output, context) => {
     });
     const data = __expectNonNull((__expectObject(await parseBody(output.body, context))), "body");
     const doc = take(data, {
-        'results': _ => de_SearchHistoryResultsList(_, context),
+        'history': _ => de_SearchHistoryList(_, context),
     });
     Object.assign(contents, doc);
     return contents;
@@ -950,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': _json,
-        'results': _ => de_SearchKnowledgeBaseResults(_, context),
+        'results': _ => de_SearchKnowledgeBaseResultsList(_, context),
     });
     Object.assign(contents, doc);
     return contents;
@@ -1149,8 +1149,9 @@ const se_DescribeDataSourceParameters = (input, context) => {
         'proxy': _ => se_Document(_, context),
     });
 };
-const se_SearchKnowledgeBaseResult = (input, context) => {
+const se_SearchKnowledgeBaseResultItem = (input, context) => {
     return take(input, {
+        'chunkId': [],
         'content': [],
         'dataSourceId': [],
         'dataSourceType': [],
@@ -1163,9 +1164,9 @@ const se_SearchKnowledgeBaseResult = (input, context) => {
         'semanticScore': __serializeFloat,
     });
 };
-const se_SearchKnowledgeBaseResults = (input, context) => {
+const se_SearchKnowledgeBaseResultsList = (input, context) => {
     return input.filter((e) => e != null).map(entry => {
-        return se_SearchKnowledgeBaseResult(entry, context);
+        return se_SearchKnowledgeBaseResultItem(entry, context);
     });
 };
 const de_Document = (output, context) => {
@@ -1216,61 +1217,38 @@ const de_DescribeDataSourceResult = (output, context) => {
         'proxy': (_) => de_Document(_, context),
     });
 };
-const de_SearchHistoryRequest = (output, context) => {
-    return take(output, {
-        'externalSessionId': __expectString,
-        'knowledgeBaseId': __expectString,
-        'query': __expectString,
-        'searchLimit': __expectInt32,
-        'searchStrategy': __expectString,
-        'searchThreshold': __limitedParseDouble,
-        'user': __expectString,
-    });
-};
-const de_SearchHistoryResponse = (output, context) => {
-    return take(output, {
-        'results': (_) => de_SearchHistorySearchResults(_, context),
-    });
-};
-const de_SearchHistoryResult = (output, context) => {
+const de_SearchHistoryItem = (output, context) => {
     return take(output, {
+        'chunks': (_) => de_SearchKnowledgeBaseResultsList(_, context),
+        'chunksCount': __expectInt32,
         'companyId': __expectString,
         'createdAt': (_) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),
         'request': (_) => de_SearchHistoryRequest(_, context),
-        'response': (_) => de_SearchHistoryResponse(_, context),
-        'resultsCount': __expectInt32,
         'sessionId': __expectString,
         'stages': _json,
         'totalDuration': __expectInt32,
     });
 };
-const de_SearchHistoryResultsList = (output, context) => {
+const de_SearchHistoryList = (output, context) => {
     const retVal = (output || []).filter((e) => e != null).map((entry) => {
-        return de_SearchHistoryResult(entry, context);
+        return de_SearchHistoryItem(entry, context);
     });
     return retVal;
 };
-const de_SearchHistorySearchResult = (output, context) => {
+const de_SearchHistoryRequest = (output, context) => {
     return take(output, {
-        'bm25Score': __limitedParseDouble,
-        'chunkId': __expectString,
-        'dataSourceId': __expectString,
-        'dataSourceType': __expectString,
-        'documentId': __expectString,
-        'documentTitle': __expectString,
-        'documentUrl': __expectString,
-        'knnScore': __limitedParseDouble,
-        'score': __limitedParseDouble,
-    });
-};
-const de_SearchHistorySearchResults = (output, context) => {
-    const retVal = (output || []).filter((e) => e != null).map((entry) => {
-        return de_SearchHistorySearchResult(entry, context);
+        'externalSessionId': __expectString,
+        'knowledgeBaseId': __expectString,
+        'query': __expectString,
+        'searchLimit': __expectInt32,
+        'searchStrategy': __expectString,
+        'searchThreshold': __limitedParseDouble,
+        'user': __expectString,
     });
-    return retVal;
 };
-const de_SearchKnowledgeBaseResult = (output, context) => {
+const de_SearchKnowledgeBaseResultItem = (output, context) => {
     return take(output, {
+        'chunkId': __expectString,
         'content': __expectString,
         'dataSourceId': __expectString,
         'dataSourceType': __expectString,
@@ -1283,9 +1261,9 @@ const de_SearchKnowledgeBaseResult = (output, context) => {
         'semanticScore': __limitedParseDouble,
     });
 };
-const de_SearchKnowledgeBaseResults = (output, context) => {
+const de_SearchKnowledgeBaseResultsList = (output, context) => {
     const retVal = (output || []).filter((e) => e != null).map((entry) => {
-        return de_SearchKnowledgeBaseResult(entry, context);
+        return de_SearchKnowledgeBaseResultItem(entry, context);
     });
     return retVal;
 };

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

@@ -37,8 +37,9 @@ declare const GenerateSearchAnswerCommand_base: {
  * const input = { // GenerateSearchAnswerInput
  *   companyId: "STRING_VALUE",
  *   searchQuery: "STRING_VALUE", // required
- *   searchResults: [ // SearchKnowledgeBaseResults // required
- *     { // SearchKnowledgeBaseResult
+ *   searchResults: [ // SearchKnowledgeBaseResultsList // required
+ *     { // SearchKnowledgeBaseResultItem
+ *       chunkId: "STRING_VALUE", // required
  *       documentId: "STRING_VALUE", // required
  *       documentTitle: "STRING_VALUE", // required
  *       documentUrl: "STRING_VALUE", // required
@@ -68,8 +69,9 @@ declare const GenerateSearchAnswerCommand_base: {
  * //     outputTokens: Number("int"), // required
  * //     duration: Number("int"), // required
  * //   },
- * //   sources: [ // SearchKnowledgeBaseResults // required
- * //     { // SearchKnowledgeBaseResult
+ * //   sources: [ // SearchKnowledgeBaseResultsList // required
+ * //     { // SearchKnowledgeBaseResultItem
+ * //       chunkId: "STRING_VALUE", // required
  * //       documentId: "STRING_VALUE", // required
  * //       documentTitle: "STRING_VALUE", // required
  * //       documentUrl: "STRING_VALUE", // required

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

@@ -51,8 +51,8 @@ declare const ListSearchQueriesHistoryCommand_base: {
  * const command = new ListSearchQueriesHistoryCommand(input);
  * const response = await client.send(command);
  * // { // ListSearchQueriesHistoryOutput
- * //   results: [ // SearchHistoryResultsList // required
- * //     { // SearchHistoryResult
+ * //   history: [ // SearchHistoryList // required
+ * //     { // SearchHistoryItem
  * //       sessionId: "STRING_VALUE", // required
  * //       companyId: "STRING_VALUE", // required
  * //       request: { // SearchHistoryRequest
@@ -90,24 +90,26 @@ declare const ListSearchQueriesHistoryCommand_base: {
  * //           duration: Number("int"), // required
  * //         },
  * //       },
- * //       response: { // SearchHistoryResponse
- * //         results: [ // SearchHistorySearchResults // required
- * //           { // SearchHistorySearchResult
- * //             chunkId: "STRING_VALUE", // required
- * //             documentId: "STRING_VALUE", // required
- * //             documentTitle: "STRING_VALUE", // required
- * //             documentUrl: "STRING_VALUE", // required
- * //             dataSourceId: "STRING_VALUE", // required
- * //             dataSourceType: "files" || "confluence" || "gdrive", // required
- * //             score: Number("double"), // required
- * //             bm25Score: Number("double"),
- * //             knnScore: Number("double"),
- * //           },
- * //         ],
- * //       },
+ * //       chunks: [ // SearchKnowledgeBaseResultsList // required
+ * //         { // SearchKnowledgeBaseResultItem
+ * //           chunkId: "STRING_VALUE", // required
+ * //           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
+ * //           fullTextScore: Number("double"),
+ * //           semanticScore: Number("double"),
+ * //           documentHierarchy: [ // StringList
+ * //             "STRING_VALUE",
+ * //           ],
+ * //         },
+ * //       ],
  * //       createdAt: new Date("TIMESTAMP"), // required
  * //       totalDuration: Number("int"), // required
- * //       resultsCount: Number("int"), // required
+ * //       chunksCount: Number("int"), // required
  * //     },
  * //   ],
  * // };

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

@@ -48,8 +48,9 @@ declare const SearchKnowledgeBaseCommand_base: {
  * const command = new SearchKnowledgeBaseCommand(input);
  * const response = await client.send(command);
  * // { // SearchKnowledgeBaseOutput
- * //   results: [ // SearchKnowledgeBaseResults // required
- * //     { // SearchKnowledgeBaseResult
+ * //   results: [ // SearchKnowledgeBaseResultsList // required
+ * //     { // SearchKnowledgeBaseResultItem
+ * //       chunkId: "STRING_VALUE", // required
  * //       documentId: "STRING_VALUE", // required
  * //       documentTitle: "STRING_VALUE", // required
  * //       documentUrl: "STRING_VALUE", // required

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

@@ -944,7 +944,12 @@ export interface DescribeDataSourceOutput {
 /**
  * @public
  */
-export interface SearchKnowledgeBaseResult {
+export interface SearchKnowledgeBaseResultItem {
+    /**
+     * The ID of the chunk. Example: 123e4567-e89b-12d3-a456-426614174000
+     * @public
+     */
+    chunkId: string;
     /**
      * Unique identifier of the document
      * @public
@@ -965,12 +970,12 @@ export interface SearchKnowledgeBaseResult {
      */
     score: number;
     /**
-     * The score of the result, calculated from the full-text search score.
+     * The score of the result, calculated from the full-text bm25 search score.
      * @public
      */
     fullTextScore?: number | undefined;
     /**
-     * The score of the result, calculated from the semantic search score.
+     * The score of the result, calculated from the semantic vector search score.
      * @public
      */
     semanticScore?: number | undefined;
@@ -998,7 +1003,7 @@ export interface GenerateSearchAnswerInput {
      * The search results to be used to generate the answer. The LLM will use the search results to generate an answer based on the found results.
      * @public
      */
-    searchResults: (SearchKnowledgeBaseResult)[];
+    searchResults: (SearchKnowledgeBaseResultItem)[];
     /**
      * The specific provider and model identifier. Examples: 'openai/gpt-4o' or 'openai/gpt-4o-mini' for OpenAI, 'mistral/mistral-small-2506' for Mistral. Check provider documentation for available models
      * @public
@@ -1026,7 +1031,7 @@ export interface GenerateSearchAnswerInput {
 export interface GenerateSearchAnswerOutput {
     answer: string;
     metadata: AnswerMetadata;
-    sources: (SearchKnowledgeBaseResult)[];
+    sources: (SearchKnowledgeBaseResultItem)[];
 }
 /**
  * @public
@@ -1511,38 +1516,6 @@ export interface SearchHistoryRequest {
     searchLimit: number;
     searchThreshold: number;
 }
-/**
- * @public
- */
-export interface SearchHistorySearchResult {
-    /**
-     * The ID of the chunk. Example: 123e4567-e89b-12d3-a456-426614174000
-     * @public
-     */
-    chunkId: string;
-    /**
-     * Unique identifier of the document
-     * @public
-     */
-    documentId: string;
-    documentTitle: string;
-    documentUrl: string;
-    /**
-     * Unique identifier of the data source
-     * @public
-     */
-    dataSourceId: string;
-    dataSourceType: DataSourceType;
-    score: number;
-    bm25Score?: number | undefined;
-    knnScore?: number | undefined;
-}
-/**
- * @public
- */
-export interface SearchHistoryResponse {
-    results: (SearchHistorySearchResult)[];
-}
 /**
  * @public
  */
@@ -1575,21 +1548,21 @@ export interface SearchHistoryStages {
 /**
  * @public
  */
-export interface SearchHistoryResult {
+export interface SearchHistoryItem {
     sessionId: string;
     companyId: string;
     request: SearchHistoryRequest;
     stages: SearchHistoryStages;
-    response: SearchHistoryResponse;
+    chunks: (SearchKnowledgeBaseResultItem)[];
     createdAt: Date;
     totalDuration: number;
-    resultsCount: number;
+    chunksCount: number;
 }
 /**
  * @public
  */
 export interface ListSearchQueriesHistoryOutput {
-    results: (SearchHistoryResult)[];
+    history: (SearchHistoryItem)[];
 }
 /**
  * @public
@@ -1665,7 +1638,7 @@ export interface SearchResultMetadata {
  * @public
  */
 export interface SearchKnowledgeBaseOutput {
-    results: (SearchKnowledgeBaseResult)[];
+    results: (SearchKnowledgeBaseResultItem)[];
     metadata: SearchResultMetadata;
 }
 /**

package/package.json

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