@wildix/wim-knowledge-base-client 0.0.24 → 0.0.26

package/dist-cjs/protocols/Aws_restJson1.js

@@ -385,6 +385,7 @@ const se_SearchKnowledgeBaseCommand = async (input, context) => {
     let body;
     body = JSON.stringify((0, smithy_client_1.take)(input, {
         'searchConfig': _ => se_SearchConfig(_, context),
+        'withMetadata': [],
     }));
     b.m("POST")
         .h(headers)
@@ -802,6 +803,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),
         'results': _ => de_SearchKnowledgeBaseResults(_, context),
     });
     Object.assign(contents, doc);
@@ -1032,9 +1034,11 @@ const se_ProxyConfig = (input, context) => {
 };
 const se_SearchConfig = (input, context) => {
     return (0, smithy_client_1.take)(input, {
+        'extendMetadata': [],
         'searchStrategy': [],
         'threshold': smithy_client_1.serializeFloat,
         'topK': [],
+        'useQueryOptimization': [],
     });
 };
 const de_Document = (output, context) => {
@@ -1111,12 +1115,12 @@ const de_ProxyConfig = (output, context) => {
 const de_SearchKnowledgeBaseResult = (output, context) => {
     return (0, smithy_client_1.take)(output, {
         'content': 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,
         'score': smithy_client_1.limitedParseDouble,
-        'source': smithy_client_1.expectString,
     });
 };
 const de_SearchKnowledgeBaseResults = (output, context) => {

package/dist-es/protocols/Aws_restJson1.js

@@ -361,6 +361,7 @@ export const se_SearchKnowledgeBaseCommand = async (input, context) => {
     let body;
     body = JSON.stringify(take(input, {
         'searchConfig': _ => se_SearchConfig(_, context),
+        'withMetadata': [],
     }));
     b.m("POST")
         .h(headers)
@@ -752,6 +753,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),
         'results': _ => de_SearchKnowledgeBaseResults(_, context),
     });
     Object.assign(contents, doc);
@@ -976,9 +978,11 @@ const se_ProxyConfig = (input, context) => {
 };
 const se_SearchConfig = (input, context) => {
     return take(input, {
+        'extendMetadata': [],
         'searchStrategy': [],
         'threshold': __serializeFloat,
         'topK': [],
+        'useQueryOptimization': [],
     });
 };
 const de_Document = (output, context) => {
@@ -1055,12 +1059,12 @@ const de_ProxyConfig = (output, context) => {
 const de_SearchKnowledgeBaseResult = (output, context) => {
     return take(output, {
         'content': __expectString,
+        'dataSourceId': __expectString,
         'dataSourceType': __expectString,
         'documentId': __expectString,
         'documentTitle': __expectString,
         'documentUrl': __expectString,
         'score': __limitedParseDouble,
-        'source': __expectString,
     });
 };
 const de_SearchKnowledgeBaseResults = (output, context) => {

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

@@ -37,13 +37,8 @@ declare const CreateKnowledgeBaseCommand_base: {
  * const input = { // CreateKnowledgeBaseInput
  *   name: "STRING_VALUE", // required
  *   description: "STRING_VALUE",
- *   dataSources: [ // KnowledgeBaseDataSourcesList // required
- *     { // DataSourceListItem
- *       id: "STRING_VALUE", // required
- *       name: "STRING_VALUE", // required
- *       type: "files" || "confluence" || "gdrive" || "proxy", // required
- *       enabled: true || false, // required
- *     },
+ *   dataSources: [ // DataSourceIdsList // required
+ *     "STRING_VALUE",
  *   ],
  *   companyId: "STRING_VALUE",
  * };
@@ -53,13 +48,8 @@ declare const CreateKnowledgeBaseCommand_base: {
  * //   knowledgeBase: { // KnowledgeBaseItem
  * //     name: "STRING_VALUE", // required
  * //     description: "STRING_VALUE",
- * //     dataSources: [ // KnowledgeBaseDataSourcesList // required
- * //       { // DataSourceListItem
- * //         id: "STRING_VALUE", // required
- * //         name: "STRING_VALUE", // required
- * //         type: "files" || "confluence" || "gdrive" || "proxy", // required
- * //         enabled: true || false, // required
- * //       },
+ * //     dataSources: [ // DataSourceIdsList // required
+ * //       "STRING_VALUE",
  * //     ],
  * //     id: "STRING_VALUE", // required
  * //     companyId: "STRING_VALUE", // required

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

@@ -44,13 +44,8 @@ declare const GetKnowledgeBaseCommand_base: {
  * //   knowledgeBase: { // KnowledgeBaseItem
  * //     name: "STRING_VALUE", // required
  * //     description: "STRING_VALUE",
- * //     dataSources: [ // KnowledgeBaseDataSourcesList // required
- * //       { // DataSourceListItem
- * //         id: "STRING_VALUE", // required
- * //         name: "STRING_VALUE", // required
- * //         type: "files" || "confluence" || "gdrive" || "proxy", // required
- * //         enabled: true || false, // required
- * //       },
+ * //     dataSources: [ // DataSourceIdsList // required
+ * //       "STRING_VALUE",
  * //     ],
  * //     id: "STRING_VALUE", // required
  * //     companyId: "STRING_VALUE", // required

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

@@ -44,13 +44,8 @@ declare const ListKnowledgeBasesCommand_base: {
  * //     { // KnowledgeBaseItem
  * //       name: "STRING_VALUE", // required
  * //       description: "STRING_VALUE",
- * //       dataSources: [ // KnowledgeBaseDataSourcesList // required
- * //         { // DataSourceListItem
- * //           id: "STRING_VALUE", // required
- * //           name: "STRING_VALUE", // required
- * //           type: "files" || "confluence" || "gdrive" || "proxy", // required
- * //           enabled: true || false, // required
- * //         },
+ * //       dataSources: [ // DataSourceIdsList // required
+ * //         "STRING_VALUE",
  * //       ],
  * //       id: "STRING_VALUE", // required
  * //       companyId: "STRING_VALUE", // required

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

@@ -42,6 +42,8 @@ declare const QueryKnowledgeBaseCommand_base: {
  *     topK: Number("int"),
  *     threshold: Number("double"),
  *     searchStrategy: "bm25" || "vector" || "hybrid",
+ *     useQueryOptimization: true || false,
+ *     extendMetadata: true || false,
  *   },
  *   llmConfig: { // LlmConfig
  *     provider: "STRING_VALUE",

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

@@ -42,7 +42,10 @@ declare const SearchKnowledgeBaseCommand_base: {
  *     topK: Number("int"),
  *     threshold: Number("double"),
  *     searchStrategy: "bm25" || "vector" || "hybrid",
+ *     useQueryOptimization: true || false,
+ *     extendMetadata: true || false,
  *   },
+ *   withMetadata: true || false,
  * };
  * const command = new SearchKnowledgeBaseCommand(input);
  * const response = await client.send(command);
@@ -51,13 +54,14 @@ declare const SearchKnowledgeBaseCommand_base: {
  * //     { // SearchKnowledgeBaseResult
  * //       documentId: "STRING_VALUE", // required
  * //       documentTitle: "STRING_VALUE", // required
- * //       score: Number("double"), // required
- * //       source: "STRING_VALUE", // required
- * //       content: "STRING_VALUE", // required
  * //       documentUrl: "STRING_VALUE", // required
+ * //       dataSourceId: "STRING_VALUE", // required
  * //       dataSourceType: "files" || "confluence" || "gdrive" || "proxy", // required
+ * //       content: "STRING_VALUE", // required
+ * //       score: Number("double"), // required
  * //     },
  * //   ],
+ * //   metadata: "DOCUMENT_VALUE",
  * // };
  *
  * ```

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

@@ -37,13 +37,8 @@ declare const UpdateKnowledgeBaseCommand_base: {
  * const input = { // UpdateKnowledgeBaseInput
  *   name: "STRING_VALUE", // required
  *   description: "STRING_VALUE",
- *   dataSources: [ // KnowledgeBaseDataSourcesList // required
- *     { // DataSourceListItem
- *       id: "STRING_VALUE", // required
- *       name: "STRING_VALUE", // required
- *       type: "files" || "confluence" || "gdrive" || "proxy", // required
- *       enabled: true || false, // required
- *     },
+ *   dataSources: [ // DataSourceIdsList // required
+ *     "STRING_VALUE",
  *   ],
  *   companyId: "STRING_VALUE",
  *   knowledgeBaseId: "STRING_VALUE", // required
@@ -54,13 +49,8 @@ declare const UpdateKnowledgeBaseCommand_base: {
  * //   knowledgeBase: { // KnowledgeBaseItem
  * //     name: "STRING_VALUE", // required
  * //     description: "STRING_VALUE",
- * //     dataSources: [ // KnowledgeBaseDataSourcesList // required
- * //       { // DataSourceListItem
- * //         id: "STRING_VALUE", // required
- * //         name: "STRING_VALUE", // required
- * //         type: "files" || "confluence" || "gdrive" || "proxy", // required
- * //         enabled: true || false, // required
- * //       },
+ * //     dataSources: [ // DataSourceIdsList // required
+ * //       "STRING_VALUE",
  * //     ],
  * //     id: "STRING_VALUE", // required
  * //     companyId: "STRING_VALUE", // required

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

@@ -579,31 +579,6 @@ export interface DocumentItem {
 export interface CreateDocumentOutput {
     document: DocumentItem;
 }
-/**
- * @public
- */
-export interface DataSourceListItem {
-    /**
-     * The ID of the data source. Example: 123e4567-e89b-12d3-a456-426614174000
-     * @public
-     */
-    id: string;
-    /**
-     * The name of the data source. Example: Product Confluence
-     * @public
-     */
-    name: string;
-    /**
-     * The type of the data source. Example: confluence
-     * @public
-     */
-    type: DataSourceType;
-    /**
-     * Whether the data source is enabled. Example: true
-     * @public
-     */
-    enabled: boolean;
-}
 /**
  * @public
  */
@@ -618,7 +593,7 @@ export interface CreateKnowledgeBaseInput {
      * @public
      */
     description?: string | undefined;
-    dataSources: (DataSourceListItem)[];
+    dataSources: (string)[];
     /**
      * The unique identifier of the tenant when a service token is used.
      * @public
@@ -639,7 +614,7 @@ export interface KnowledgeBaseItem {
      * @public
      */
     description?: string | undefined;
-    dataSources: (DataSourceListItem)[];
+    dataSources: (string)[];
     /**
      * The ID of the knowledge base. Example: 123e4567-e89b-12d3-a456-426614174000
      * @public
@@ -1289,6 +1264,16 @@ export interface SearchConfig {
      * @public
      */
     searchStrategy?: SearchStrategy | undefined;
+    /**
+     * Whether to use the query transform to improve the search results. Example: true. The query transform will use the query to improve the search results.
+     * @public
+     */
+    useQueryOptimization?: boolean | undefined;
+    /**
+     * Whether to extend the metadata of the search results. Example: true. The metadata will be extended with the additional information.
+     * @public
+     */
+    extendMetadata?: boolean | undefined;
 }
 /**
  * @public
@@ -1352,6 +1337,11 @@ export interface SearchKnowledgeBaseInput {
      * @public
      */
     searchConfig?: SearchConfig | undefined;
+    /**
+     * Whether to include the metadata of the search results.
+     * @public
+     */
+    withMetadata?: boolean | undefined;
 }
 /**
  * @public
@@ -1363,21 +1353,22 @@ export interface SearchKnowledgeBaseResult {
      */
     documentId: string;
     documentTitle: string;
-    score: number;
+    documentUrl: string;
     /**
      * The ID of the data source. Example: 123e4567-e89b-12d3-a456-426614174000
      * @public
      */
-    source: string;
-    content: string;
-    documentUrl: string;
+    dataSourceId: string;
     dataSourceType: DataSourceType;
+    content: string;
+    score: number;
 }
 /**
  * @public
  */
 export interface SearchKnowledgeBaseOutput {
     results: (SearchKnowledgeBaseResult)[];
+    metadata?: __DocumentType | undefined;
 }
 /**
  * @public
@@ -1537,7 +1528,7 @@ export interface UpdateKnowledgeBaseInput {
      * @public
      */
     description?: string | undefined;
-    dataSources: (DataSourceListItem)[];
+    dataSources: (string)[];
     /**
      * The unique identifier of the tenant when a service token is used.
      * @public

package/package.json

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