@wildix/wim-knowledge-base-client 0.0.14 → 0.0.17

package/dist-cjs/protocols/Aws_restJson1.js

@@ -206,6 +206,7 @@ const se_GetDocumentCommand = async (input, context) => {
     b.p('documentId', () => input.documentId, '{documentId}', false);
     const query = (0, smithy_client_1.map)({
         [_c]: [, input[_cI]],
+        [_wC]: [() => input.withChunks !== void 0, () => (input[_wC].toString())],
     });
     let body;
     b.m("GET")
@@ -643,6 +644,7 @@ const de_GetDocumentCommand = 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, {
+        'chunks': smithy_client_1._json,
         'document': smithy_client_1._json,
     });
     Object.assign(contents, doc);
@@ -998,6 +1000,7 @@ const se_DataSourceConfig = (input, context) => {
 };
 const se_LlmConfig = (input, context) => {
     return (0, smithy_client_1.take)(input, {
+        'maxOutputTokens': [],
         'model': [],
         'provider': [],
         'systemPrompt': [],
@@ -1118,3 +1121,4 @@ const _l = "limit";
 const _o = "offset";
 const _q = "query";
 const _sT = "syncType";
+const _wC = "withChunks";

package/dist-es/protocols/Aws_restJson1.js

@@ -192,6 +192,7 @@ export const se_GetDocumentCommand = async (input, context) => {
     b.p('documentId', () => input.documentId, '{documentId}', false);
     const query = map({
         [_c]: [, input[_cI]],
+        [_wC]: [() => input.withChunks !== void 0, () => (input[_wC].toString())],
     });
     let body;
     b.m("GET")
@@ -603,6 +604,7 @@ export const de_GetDocumentCommand = async (output, context) => {
     });
     const data = __expectNonNull((__expectObject(await parseBody(output.body, context))), "body");
     const doc = take(data, {
+        'chunks': _json,
         'document': _json,
     });
     Object.assign(contents, doc);
@@ -942,6 +944,7 @@ const se_DataSourceConfig = (input, context) => {
 };
 const se_LlmConfig = (input, context) => {
     return take(input, {
+        'maxOutputTokens': [],
         'model': [],
         'provider': [],
         'systemPrompt': [],
@@ -1062,3 +1065,4 @@ const _l = "limit";
 const _o = "offset";
 const _q = "query";
 const _sT = "syncType";
+const _wC = "withChunks";

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

@@ -38,6 +38,7 @@ declare const GetDocumentCommand_base: {
  *   companyId: "STRING_VALUE",
  *   dataSourceId: "STRING_VALUE", // required
  *   documentId: "STRING_VALUE", // required
+ *   withChunks: true || false,
  * };
  * const command = new GetDocumentCommand(input);
  * const response = await client.send(command);
@@ -59,6 +60,15 @@ declare const GetDocumentCommand_base: {
  * //     status: "draft" || "pending" || "processing" || "completed" || "failed", // required
  * //     errorMessage: "STRING_VALUE",
  * //   },
+ * //   chunks: [ // ChunksList
+ * //     { // ChunkItem
+ * //       id: "STRING_VALUE", // required
+ * //       documentId: "STRING_VALUE", // required
+ * //       content: "STRING_VALUE", // required
+ * //       createdAt: "STRING_VALUE", // required
+ * //       updatedAt: "STRING_VALUE", // required
+ * //     },
+ * //   ],
  * // };
  *
  * ```

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

@@ -44,9 +44,10 @@ declare const QueryKnowledgeBaseCommand_base: {
  *     searchStrategy: "bm25" || "vector" || "hybrid",
  *   },
  *   llmConfig: { // LlmConfig
- *     provider: "STRING_VALUE", // required
- *     model: "STRING_VALUE", // required
+ *     provider: "STRING_VALUE",
+ *     model: "STRING_VALUE",
  *     temperature: Number("double"),
+ *     maxOutputTokens: Number("int"),
  *     systemPrompt: "STRING_VALUE",
  *   },
  * };

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

@@ -34,6 +34,24 @@ export declare class UnauthorizedException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<UnauthorizedException, __BaseException>);
 }
+/**
+ * @public
+ */
+export interface ChunkItem {
+    /**
+     * The ID of the chunk. Example: 123e4567-e89b-12d3-a456-426614174000
+     * @public
+     */
+    id: string;
+    /**
+     * The ID of the document. Example: 123e4567-e89b-12d3-a456-426614174000
+     * @public
+     */
+    documentId: string;
+    content: string;
+    createdAt: string;
+    updatedAt: string;
+}
 /**
  * @public
  */
@@ -732,12 +750,14 @@ export interface GetDocumentInput {
      * @public
      */
     documentId: string;
+    withChunks?: boolean | undefined;
 }
 /**
  * @public
  */
 export interface GetDocumentOutput {
     document: DocumentItem;
+    chunks?: (ChunkItem)[] | undefined;
 }
 /**
  * @public
@@ -963,17 +983,22 @@ export interface LlmConfig {
      * The LLM provider to use for the answer. Example: openai, anthropic, google, etc.
      * @public
      */
-    provider: string;
+    provider?: string | undefined;
     /**
      * The model to use for the answer. Example: gpt-4o, gpt-4o-mini, etc.
      * @public
      */
-    model: string;
+    model?: string | undefined;
     /**
-     * The temperature to use for the answer. Example: 0.5
+     * The temperature to use for the answer. The lower the temperature, the more deterministic the answer will be.
      * @public
      */
     temperature?: number | undefined;
+    /**
+     * The max output tokens to use for the answer. The bigger the number, the more detailed the answer will be.
+     * @public
+     */
+    maxOutputTokens?: number | undefined;
     /**
      * The system prompt to use for the answer. Example: You are a helpful assistant that can answer questions about the knowledge base.
      * @public
@@ -1003,12 +1028,12 @@ export interface SearchConfig {
      */
     topK?: number | undefined;
     /**
-     * The threshold for the results. Example: 0.5
+     * The threshold for the search results. Example: 0.5. The bigger the threshold, the less results will be returned.
      * @public
      */
     threshold?: number | undefined;
     /**
-     * The search strategy to use. Example: hybrid
+     * The search strategy to use. Example: hybrid. The hybrid strategy will use the vector search and the text search to return the results.
      * @public
      */
     searchStrategy?: SearchStrategy | undefined;

package/package.json

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