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

package/dist-cjs/protocols/Aws_restJson1.js

@@ -96,6 +96,7 @@ const se_CreateDocumentCommand = async (input, context) => {
     let body;
     body = JSON.stringify((0, smithy_client_1.take)(input, {
         'content': [],
+        'description': [],
         'metadata': _ => se_Document(_, context),
         'originalFormat': [],
         'originalId': [],
@@ -440,6 +441,8 @@ const se_ListDocumentsCommand = async (input, context) => {
         [_o]: [() => input.offset !== void 0, () => (input[_o].toString())],
         [_s]: [, input[_s]],
         [_se]: [, input[_se]],
+        [_oI]: [, input[_oI]],
+        [_st]: [, input[_st]],
     });
     let body;
     b.m("GET")
@@ -605,6 +608,7 @@ const se_UpdateDocumentCommand = async (input, context) => {
     let body;
     body = JSON.stringify((0, smithy_client_1.take)(input, {
         'content': [],
+        'description': [],
         'originalFormat': [],
         'originalId': [],
         'originalName': [],
@@ -1410,6 +1414,8 @@ const _cI = "companyId";
 const _l = "limit";
 const _lL = "logLevel";
 const _o = "offset";
+const _oI = "originalId";
 const _s = "sort";
 const _sT = "syncType";
 const _se = "search";
+const _st = "status";

package/dist-es/protocols/Aws_restJson1.js

@@ -88,6 +88,7 @@ export const se_CreateDocumentCommand = async (input, context) => {
     let body;
     body = JSON.stringify(take(input, {
         'content': [],
+        'description': [],
         'metadata': _ => se_Document(_, context),
         'originalFormat': [],
         'originalId': [],
@@ -413,6 +414,8 @@ export const se_ListDocumentsCommand = async (input, context) => {
         [_o]: [() => input.offset !== void 0, () => (input[_o].toString())],
         [_s]: [, input[_s]],
         [_se]: [, input[_se]],
+        [_oI]: [, input[_oI]],
+        [_st]: [, input[_st]],
     });
     let body;
     b.m("GET")
@@ -570,6 +573,7 @@ export const se_UpdateDocumentCommand = async (input, context) => {
     let body;
     body = JSON.stringify(take(input, {
         'content': [],
+        'description': [],
         'originalFormat': [],
         'originalId': [],
         'originalName': [],
@@ -1340,6 +1344,8 @@ const _cI = "companyId";
 const _l = "limit";
 const _lL = "logLevel";
 const _o = "offset";
+const _oI = "originalId";
 const _s = "sort";
 const _sT = "syncType";
 const _se = "search";
+const _st = "status";

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

@@ -38,6 +38,7 @@ declare const CreateDocumentCommand_base: {
  *   title: "STRING_VALUE", // required
  *   url: "STRING_VALUE",
  *   content: "STRING_VALUE",
+ *   description: "STRING_VALUE",
  *   originalFormat: "STRING_VALUE", // required
  *   originalName: "STRING_VALUE", // required
  *   originalId: "STRING_VALUE",
@@ -52,6 +53,7 @@ declare const CreateDocumentCommand_base: {
  * //     title: "STRING_VALUE", // required
  * //     url: "STRING_VALUE",
  * //     content: "STRING_VALUE",
+ * //     description: "STRING_VALUE",
  * //     originalFormat: "STRING_VALUE", // required
  * //     originalName: "STRING_VALUE", // required
  * //     originalId: "STRING_VALUE",

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

@@ -46,6 +46,7 @@ declare const GetDocumentCommand_base: {
  * //     title: "STRING_VALUE", // required
  * //     url: "STRING_VALUE",
  * //     content: "STRING_VALUE",
+ * //     description: "STRING_VALUE",
  * //     originalFormat: "STRING_VALUE", // required
  * //     originalName: "STRING_VALUE", // required
  * //     originalId: "STRING_VALUE",

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

@@ -46,6 +46,7 @@ declare const GetDocumentWithContentAndChunksCommand_base: {
  * //     title: "STRING_VALUE", // required
  * //     url: "STRING_VALUE",
  * //     content: "STRING_VALUE",
+ * //     description: "STRING_VALUE",
  * //     originalFormat: "STRING_VALUE", // required
  * //     originalName: "STRING_VALUE", // required
  * //     originalId: "STRING_VALUE",

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

@@ -41,6 +41,8 @@ declare const ListDocumentsCommand_base: {
  *   sort: "STRING_VALUE",
  *   dataSourceId: "STRING_VALUE", // required
  *   search: "STRING_VALUE",
+ *   originalId: "STRING_VALUE",
+ *   status: "draft" || "pending" || "processing" || "completed" || "failed",
  * };
  * const command = new ListDocumentsCommand(input);
  * const response = await client.send(command);
@@ -50,6 +52,7 @@ declare const ListDocumentsCommand_base: {
  * //       title: "STRING_VALUE", // required
  * //       url: "STRING_VALUE",
  * //       content: "STRING_VALUE",
+ * //       description: "STRING_VALUE",
  * //       originalFormat: "STRING_VALUE", // required
  * //       originalName: "STRING_VALUE", // required
  * //       originalId: "STRING_VALUE",

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

@@ -38,6 +38,7 @@ declare const UpdateDocumentCommand_base: {
  *   title: "STRING_VALUE", // required
  *   url: "STRING_VALUE",
  *   content: "STRING_VALUE",
+ *   description: "STRING_VALUE",
  *   originalFormat: "STRING_VALUE", // required
  *   originalName: "STRING_VALUE", // required
  *   originalId: "STRING_VALUE",
@@ -52,6 +53,7 @@ declare const UpdateDocumentCommand_base: {
  * //     title: "STRING_VALUE", // required
  * //     url: "STRING_VALUE",
  * //     content: "STRING_VALUE",
+ * //     description: "STRING_VALUE",
  * //     originalFormat: "STRING_VALUE", // required
  * //     originalName: "STRING_VALUE", // required
  * //     originalId: "STRING_VALUE",

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

@@ -416,6 +416,11 @@ export interface CreateDocumentInput {
      * @public
      */
     content?: string | undefined;
+    /**
+     * Optional detailed description of the document content and purpose. Helps users understand what the document is about.
+     * @public
+     */
+    description?: string | undefined;
     /**
      * File format/extension of the original document for reference. Examples: 'pdf', 'docx', 'md', 'html', 'txt'. Helps identify source document type
      * @public
@@ -442,7 +447,7 @@ export interface CreateDocumentInput {
      */
     dataSourceId: string;
     /**
-     * Additional metadata of the document. Example: \{ 'createdAt': '2025-01-01T00:00:00Z', 'updatedAt': '2025-05-01T00:00:00Z', 'createdBy': 'user@example.com' \}
+     * Additional metadata of the document. Example: `\{ 'createdAt': '2025-01-01T00:00:00Z', 'updatedAt': '2025-05-01T00:00:00Z', 'createdBy': 'user@example.com' \}`
      * @public
      */
     metadata?: __DocumentType | undefined;
@@ -481,6 +486,11 @@ export interface DocumentItem {
      * @public
      */
     content?: string | undefined;
+    /**
+     * Optional detailed description of the document content and purpose. Helps users understand what the document is about.
+     * @public
+     */
+    description?: string | undefined;
     /**
      * File format/extension of the original document for reference. Examples: 'pdf', 'docx', 'md', 'html', 'txt'. Helps identify source document type
      * @public
@@ -1534,6 +1544,16 @@ export interface ListDocumentsInput {
      * @public
      */
     search?: string | undefined;
+    /**
+     * Original ID from the source system, preserving the reference to the source document.
+     * @public
+     */
+    originalId?: string | undefined;
+    /**
+     * Status of the document.
+     * @public
+     */
+    status?: DocumentStatus | undefined;
 }
 /**
  * @public
@@ -1595,7 +1615,7 @@ export interface SearchHistoryFilter {
      */
     sessionId?: string | undefined;
     /**
-     * Filter history by the session URI. Used for tracking and analytics purposes. Example: chatbots://\{agentId\}/id-of-chat-session/id-of-message
+     * Filter history by the session URI. Used for tracking and analytics purposes. Example: `chatbots://\{agentId\}/id-of-chat-session/id-of-message`
      * @public
      */
     sessionUri?: string | undefined;
@@ -1850,7 +1870,7 @@ export interface SearchKnowledgeBaseInput {
      */
     sessionUser?: string | undefined;
     /**
-     * The session URI. Used for tracking and analytics purposes. Example: chatbots://\{agentId\}/id-of-chat-session/id-of-message
+     * The session URI. Used for tracking and analytics purposes. Example: `chatbots://\{agentId\}/id-of-chat-session/id-of-message`
      * @public
      */
     sessionUri?: string | undefined;
@@ -1964,6 +1984,11 @@ export interface UpdateDocumentInput {
      * @public
      */
     content?: string | undefined;
+    /**
+     * Optional detailed description of the document content and purpose. Helps users understand what the document is about.
+     * @public
+     */
+    description?: string | undefined;
     /**
      * File format/extension of the original document for reference. Examples: 'pdf', 'docx', 'md', 'html', 'txt'. Helps identify source document type
      * @public

package/package.json

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