@wildix/wim-knowledge-base-client 0.1.0 → 0.1.2

package/dist-cjs/protocols/Aws_restJson1.js

@@ -974,6 +974,7 @@ const de_ListDataSourceSynchronizationLogsCommand = 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, {
         'logs': smithy_client_1._json,
+        'metadata': smithy_client_1._json,
     });
     Object.assign(contents, doc);
     return contents;
@@ -989,6 +990,7 @@ const de_ListDocumentsCommand = 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, {
         'documents': smithy_client_1._json,
+        'metadata': smithy_client_1._json,
     });
     Object.assign(contents, doc);
     return contents;
@@ -1034,6 +1036,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, {
         'history': _ => de_SearchHistoryList(_, context),
+        'metadata': smithy_client_1._json,
     });
     Object.assign(contents, doc);
     return contents;
@@ -1343,13 +1346,13 @@ const de_SearchHistoryList = (output, 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,
+        'sessionUri': smithy_client_1.expectString,
+        'sessionUser': smithy_client_1.expectString,
     });
 };
 const de_SearchHistoryResultItem = (output, context) => {

package/dist-es/protocols/Aws_restJson1.js

@@ -915,6 +915,7 @@ export const de_ListDataSourceSynchronizationLogsCommand = async (output, contex
     const data = __expectNonNull((__expectObject(await parseBody(output.body, context))), "body");
     const doc = take(data, {
         'logs': _json,
+        'metadata': _json,
     });
     Object.assign(contents, doc);
     return contents;
@@ -929,6 +930,7 @@ export const de_ListDocumentsCommand = async (output, context) => {
     const data = __expectNonNull((__expectObject(await parseBody(output.body, context))), "body");
     const doc = take(data, {
         'documents': _json,
+        'metadata': _json,
     });
     Object.assign(contents, doc);
     return contents;
@@ -971,6 +973,7 @@ export const de_ListSearchQueriesHistoryCommand = async (output, context) => {
     const data = __expectNonNull((__expectObject(await parseBody(output.body, context))), "body");
     const doc = take(data, {
         'history': _ => de_SearchHistoryList(_, context),
+        'metadata': _json,
     });
     Object.assign(contents, doc);
     return contents;
@@ -1273,13 +1276,13 @@ const de_SearchHistoryList = (output, context) => {
 };
 const de_SearchHistoryRequest = (output, context) => {
     return take(output, {
-        'externalSessionId': __expectString,
         'knowledgeBaseId': __expectString,
         'query': __expectString,
         'searchLimit': __expectInt32,
         'searchStrategy': __expectString,
         'searchThreshold': __limitedParseDouble,
-        'user': __expectString,
+        'sessionUri': __expectString,
+        'sessionUser': __expectString,
     });
 };
 const de_SearchHistoryResultItem = (output, context) => {

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

@@ -53,6 +53,11 @@ declare const ListDataSourceSynchronizationLogsCommand_base: {
  * //       message: "STRING_VALUE", // required
  * //     },
  * //   ],
+ * //   metadata: { // PaginationMetadata
+ * //     total: Number("int"), // required
+ * //     limit: Number("int"),
+ * //     offset: Number("int"),
+ * //   },
  * // };
  *
  * ```

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

@@ -65,6 +65,11 @@ declare const ListDocumentsCommand_base: {
  * //       errorMessage: "STRING_VALUE",
  * //     },
  * //   ],
+ * //   metadata: { // PaginationMetadata
+ * //     total: Number("int"), // required
+ * //     limit: Number("int"),
+ * //     offset: Number("int"),
+ * //   },
  * // };
  *
  * ```

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

@@ -43,8 +43,8 @@ declare const ListSearchQueriesHistoryCommand_base: {
  *     knowledgeBaseId: "STRING_VALUE",
  *     dataSourceId: "STRING_VALUE",
  *     sessionId: "STRING_VALUE",
- *     externalSessionId: "STRING_VALUE",
- *     searchUser: "STRING_VALUE",
+ *     sessionUri: "STRING_VALUE",
+ *     sessionUser: "STRING_VALUE",
  *     withEmptyResults: true || false,
  *   },
  *   search: "STRING_VALUE",
@@ -59,8 +59,8 @@ declare const ListSearchQueriesHistoryCommand_base: {
  * //       companyId: "STRING_VALUE", // required
  * //       request: { // SearchHistoryRequest
  * //         query: "STRING_VALUE", // required
- * //         user: "STRING_VALUE", // required
- * //         externalSessionId: "STRING_VALUE", // required
+ * //         sessionUser: "STRING_VALUE", // required
+ * //         sessionUri: "STRING_VALUE", // required
  * //         knowledgeBaseId: "STRING_VALUE", // required
  * //         searchStrategy: "bm25" || "vector" || "hybrid", // required
  * //         searchLimit: Number("int"), // required
@@ -122,6 +122,11 @@ declare const ListSearchQueriesHistoryCommand_base: {
  * //       resultsCount: Number("int"), // required
  * //     },
  * //   ],
+ * //   metadata: { // PaginationMetadata
+ * //     total: Number("int"), // required
+ * //     limit: Number("int"),
+ * //     offset: Number("int"),
+ * //   },
  * // };
  *
  * ```

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

@@ -1481,11 +1481,32 @@ export interface SyncLogItem {
     level: SyncLogLevel;
     message: string;
 }
+/**
+ * @public
+ */
+export interface PaginationMetadata {
+    /**
+     * The total number of results.
+     * @public
+     */
+    total: number;
+    /**
+     * The number of results per page.
+     * @public
+     */
+    limit?: number | undefined;
+    /**
+     * The offset from which to start the results.
+     * @public
+     */
+    offset?: number | undefined;
+}
 /**
  * @public
  */
 export interface ListDataSourceSynchronizationLogsOutput {
     logs: (SyncLogItem)[];
+    metadata: PaginationMetadata;
 }
 /**
  * @public
@@ -1519,6 +1540,7 @@ export interface ListDocumentsInput {
  */
 export interface ListDocumentsOutput {
     documents: (DocumentItem)[];
+    metadata: PaginationMetadata;
 }
 /**
  * @public
@@ -1573,15 +1595,15 @@ export interface SearchHistoryFilter {
      */
     sessionId?: string | undefined;
     /**
-     * Filter history by the external session ID from the client.
+     * Filter history by the session URI. Used for tracking and analytics purposes. Example: chatbots://\{agentId\}/id-of-chat-session/id-of-message
      * @public
      */
-    externalSessionId?: string | undefined;
+    sessionUri?: string | undefined;
     /**
      * Filter history by the user who performs the search in the knowledge base. Example: user@example.com
      * @public
      */
-    searchUser?: string | undefined;
+    sessionUser?: string | undefined;
     /**
      * Whether to include the history results with empty results.
      * @public
@@ -1638,8 +1660,8 @@ export type SearchStrategy = typeof SearchStrategy[keyof typeof SearchStrategy];
  */
 export interface SearchHistoryRequest {
     query: string;
-    user: string;
-    externalSessionId: string;
+    sessionUser: string;
+    sessionUri: string;
     /**
      * Unique identifier of the knowledge base
      * @public
@@ -1768,6 +1790,7 @@ export interface SearchHistoryItem {
  */
 export interface ListSearchQueriesHistoryOutput {
     history: (SearchHistoryItem)[];
+    metadata: PaginationMetadata;
 }
 /**
  * @public

package/package.json

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