@wildix/wim-knowledge-base-client 0.0.37 → 0.0.39

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': [],
+        'metadata': _ => se_Document(_, context),
         'originalFormat': [],
         'originalId': [],
         'originalName': [],
@@ -374,6 +375,7 @@ const se_QueryKnowledgeBaseCommand = async (input, context) => {
     const headers = (0, smithy_client_1.map)({}, smithy_client_1.isSerializableHeaderValue, {
         'content-type': 'application/json',
         [_xsu]: input[_sU],
+        [_xesi]: input[_eSI],
     });
     b.bp("/api/v1/knowledge-bases/{knowledgeBaseId}/query");
     b.p('knowledgeBaseId', () => input.knowledgeBaseId, '{knowledgeBaseId}', false);
@@ -398,6 +400,7 @@ const se_SearchKnowledgeBaseCommand = async (input, context) => {
     const headers = (0, smithy_client_1.map)({}, smithy_client_1.isSerializableHeaderValue, {
         'content-type': 'application/json',
         [_xsu]: input[_sU],
+        [_xesi]: input[_eSI],
     });
     b.bp("/api/v1/knowledge-bases/{knowledgeBaseId}/search");
     b.p('knowledgeBaseId', () => input.knowledgeBaseId, '{knowledgeBaseId}', false);
@@ -1173,6 +1176,7 @@ const collectBodyString = (streamBody, context) => (0, smithy_client_1.collectBo
 const _c = "company";
 const _cI = "companyId";
 const _dT = "documentType";
+const _eSI = "externalSessionId";
 const _l = "limit";
 const _o = "offset";
 const _q = "query";
@@ -1180,4 +1184,5 @@ const _sT = "syncType";
 const _sU = "searchUser";
 const _wC = "withContent";
 const _wCi = "withChunks";
+const _xesi = "x-external-session-id";
 const _xsu = "x-search-user";

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': [],
+        'metadata': _ => se_Document(_, context),
         'originalFormat': [],
         'originalId': [],
         'originalName': [],
@@ -350,6 +351,7 @@ export const se_QueryKnowledgeBaseCommand = async (input, context) => {
     const headers = map({}, isSerializableHeaderValue, {
         'content-type': 'application/json',
         [_xsu]: input[_sU],
+        [_xesi]: input[_eSI],
     });
     b.bp("/api/v1/knowledge-bases/{knowledgeBaseId}/query");
     b.p('knowledgeBaseId', () => input.knowledgeBaseId, '{knowledgeBaseId}', false);
@@ -373,6 +375,7 @@ export const se_SearchKnowledgeBaseCommand = async (input, context) => {
     const headers = map({}, isSerializableHeaderValue, {
         'content-type': 'application/json',
         [_xsu]: input[_sU],
+        [_xesi]: input[_eSI],
     });
     b.bp("/api/v1/knowledge-bases/{knowledgeBaseId}/search");
     b.p('knowledgeBaseId', () => input.knowledgeBaseId, '{knowledgeBaseId}', false);
@@ -1115,6 +1118,7 @@ const collectBodyString = (streamBody, context) => collectBody(streamBody, conte
 const _c = "company";
 const _cI = "companyId";
 const _dT = "documentType";
+const _eSI = "externalSessionId";
 const _l = "limit";
 const _o = "offset";
 const _q = "query";
@@ -1122,4 +1126,5 @@ const _sT = "syncType";
 const _sU = "searchUser";
 const _wC = "withContent";
 const _wCi = "withChunks";
+const _xesi = "x-external-session-id";
 const _xsu = "x-search-user";

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

@@ -43,6 +43,7 @@ declare const CreateDocumentCommand_base: {
  *   originalId: "STRING_VALUE",
  *   companyId: "STRING_VALUE",
  *   dataSourceId: "STRING_VALUE", // required
+ *   metadata: "DOCUMENT_VALUE",
  * };
  * const command = new CreateDocumentCommand(input);
  * const response = await client.send(command);

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

@@ -27,7 +27,7 @@ declare const GetDocumentPresignedUploadUrlCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * Get a presigned URL for uploading the original file of the document
+ * Get a presigned URL for uploading the original file of the document. You must upload the file to this URL using the PUT method.
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -53,6 +53,7 @@ declare const QueryKnowledgeBaseCommand_base: {
  *     systemPrompt: "STRING_VALUE",
  *   },
  *   searchUser: "STRING_VALUE",
+ *   externalSessionId: "STRING_VALUE",
  * };
  * const command = new QueryKnowledgeBaseCommand(input);
  * const response = await client.send(command);

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

@@ -47,6 +47,7 @@ declare const SearchKnowledgeBaseCommand_base: {
  *   },
  *   withMetadata: true || false,
  *   searchUser: "STRING_VALUE",
+ *   externalSessionId: "STRING_VALUE",
  * };
  * const command = new SearchKnowledgeBaseCommand(input);
  * const response = await client.send(command);

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

@@ -530,7 +530,7 @@ export interface CreateDocumentInput {
      */
     url?: string | undefined;
     /**
-     * Optional document content in plain text or markdown format. For file uploads, can be the document content. For integrated sources (Confluence, GDrive), typically populated during sync from the original source
+     * Optional document content in plain text or markdown format. For file uploads, can be the document content.
      * @public
      */
     content?: string | undefined;
@@ -545,7 +545,7 @@ export interface CreateDocumentInput {
      */
     originalName: string;
     /**
-     * Original ID from the source system, preserving the reference to the source document. Examples: 'confluence-page-1234567890' (for Confluence), 'gdrive-file-abc123' (for Google Drive)
+     * Original ID from the source system, preserving the reference to the source document. Examples: 'confluence-page-1234567890' (for Confluence), 'gdrive-file-abc123' (for Google Drive), sha1(original-file-content) (for file uploads)
      * @public
      */
     originalId?: string | undefined;
@@ -559,6 +559,11 @@ export interface CreateDocumentInput {
      * @public
      */
     dataSourceId: string;
+    /**
+     * 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;
 }
 /**
  * @public
@@ -590,7 +595,7 @@ export interface DocumentItem {
      */
     url?: string | undefined;
     /**
-     * Optional document content in plain text or markdown format. For file uploads, can be the document content. For integrated sources (Confluence, GDrive), typically populated during sync from the original source
+     * Optional document content in plain text or markdown format. For file uploads, can be the document content.
      * @public
      */
     content?: string | undefined;
@@ -605,7 +610,7 @@ export interface DocumentItem {
      */
     originalName: string;
     /**
-     * Original ID from the source system, preserving the reference to the source document. Examples: 'confluence-page-1234567890' (for Confluence), 'gdrive-file-abc123' (for Google Drive)
+     * Original ID from the source system, preserving the reference to the source document. Examples: 'confluence-page-1234567890' (for Confluence), 'gdrive-file-abc123' (for Google Drive), sha1(original-file-content) (for file uploads)
      * @public
      */
     originalId?: string | undefined;
@@ -1476,6 +1481,11 @@ export interface QueryKnowledgeBaseInput {
      * @public
      */
     searchUser?: string | undefined;
+    /**
+     * The external session ID. Used for tracking and analytics purposes.
+     * @public
+     */
+    externalSessionId?: string | undefined;
 }
 /**
  * @public
@@ -1519,6 +1529,11 @@ export interface SearchKnowledgeBaseInput {
      * @public
      */
     searchUser?: string | undefined;
+    /**
+     * The external session ID. Used for tracking and analytics purposes. Example: 123e4567-e89b-12d3-a456-426614174000
+     * @public
+     */
+    externalSessionId?: string | undefined;
 }
 /**
  * @public
@@ -1638,7 +1653,7 @@ export interface UpdateDocumentInput {
      */
     url?: string | undefined;
     /**
-     * Optional document content in plain text or markdown format. For file uploads, can be the document content. For integrated sources (Confluence, GDrive), typically populated during sync from the original source
+     * Optional document content in plain text or markdown format. For file uploads, can be the document content.
      * @public
      */
     content?: string | undefined;
@@ -1653,7 +1668,7 @@ export interface UpdateDocumentInput {
      */
     originalName: string;
     /**
-     * Original ID from the source system, preserving the reference to the source document. Examples: 'confluence-page-1234567890' (for Confluence), 'gdrive-file-abc123' (for Google Drive)
+     * Original ID from the source system, preserving the reference to the source document. Examples: 'confluence-page-1234567890' (for Confluence), 'gdrive-file-abc123' (for Google Drive), sha1(original-file-content) (for file uploads)
      * @public
      */
     originalId?: string | undefined;

package/package.json

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