@wildix/wim-knowledge-base-client 0.0.10 → 0.0.13

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

@@ -34,6 +34,84 @@ export declare class UnauthorizedException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<UnauthorizedException, __BaseException>);
 }
+/**
+ * @public
+ */
+export interface CleanDataSourceInput {
+    /**
+     * The unique identifier of the tenant when a service token is used.
+     * @public
+     */
+    companyId?: string | undefined;
+    /**
+     * The ID of the data source. Example: 123e4567-e89b-12d3-a456-426614174000
+     * @public
+     */
+    dataSourceId: string;
+}
+/**
+ * @public
+ */
+export interface CleanDataSourceOutput {
+}
+/**
+ * @public
+ */
+export declare class DataSourceNotFoundException extends __BaseException {
+    readonly name: "DataSourceNotFoundException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<DataSourceNotFoundException, __BaseException>);
+}
+/**
+ * @public
+ */
+export declare class DocumentNotFoundException extends __BaseException {
+    readonly name: "DocumentNotFoundException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<DocumentNotFoundException, __BaseException>);
+}
+/**
+ * @public
+ */
+export declare class KnowledgeBaseNotFoundException extends __BaseException {
+    readonly name: "KnowledgeBaseNotFoundException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<KnowledgeBaseNotFoundException, __BaseException>);
+}
+/**
+ * @public
+ */
+export interface CloneDataSourceInput {
+    /**
+     * The unique identifier of the tenant when a service token is used.
+     * @public
+     */
+    companyId?: string | undefined;
+    /**
+     * The ID of the data source. Example: 123e4567-e89b-12d3-a456-426614174000
+     * @public
+     */
+    dataSourceId: string;
+}
+/**
+ * @public
+ */
+export interface CloneDataSourceOutput {
+    /**
+     * The ID of the data source. Example: 123e4567-e89b-12d3-a456-426614174000
+     * @public
+     */
+    dataSourceId: string;
+}
 /**
  * @public
  */
@@ -315,6 +393,10 @@ export interface DataSourceItem {
      * @public
      */
     syncSchedule?: string | undefined;
+    /**
+     * The ID of the data source. Example: 123e4567-e89b-12d3-a456-426614174000
+     * @public
+     */
     id: string;
     companyId: string;
     createdAt: string;
@@ -342,39 +424,6 @@ export interface DataSourceItem {
 export interface CreateDataSourceOutput {
     dataSource: DataSourceItem;
 }
-/**
- * @public
- */
-export declare class DataSourceNotFoundException extends __BaseException {
-    readonly name: "DataSourceNotFoundException";
-    readonly $fault: "client";
-    /**
-     * @internal
-     */
-    constructor(opts: __ExceptionOptionType<DataSourceNotFoundException, __BaseException>);
-}
-/**
- * @public
- */
-export declare class DocumentNotFoundException extends __BaseException {
-    readonly name: "DocumentNotFoundException";
-    readonly $fault: "client";
-    /**
-     * @internal
-     */
-    constructor(opts: __ExceptionOptionType<DocumentNotFoundException, __BaseException>);
-}
-/**
- * @public
- */
-export declare class KnowledgeBaseNotFoundException extends __BaseException {
-    readonly name: "KnowledgeBaseNotFoundException";
-    readonly $fault: "client";
-    /**
-     * @internal
-     */
-    constructor(opts: __ExceptionOptionType<KnowledgeBaseNotFoundException, __BaseException>);
-}
 /**
  * @public
  */
@@ -414,6 +463,10 @@ export interface CreateDocumentInput {
      * @public
      */
     companyId?: string | undefined;
+    /**
+     * The ID of the data source. Example: 123e4567-e89b-12d3-a456-426614174000
+     * @public
+     */
     dataSourceId: string;
 }
 /**
@@ -422,6 +475,7 @@ export interface CreateDocumentInput {
  */
 export declare const DocumentStatus: {
     readonly COMPLETED: "completed";
+    readonly DRAFT: "draft";
     readonly FAILED: "failed";
     readonly PENDING: "pending";
     readonly PROCESSING: "processing";
@@ -464,8 +518,16 @@ export interface DocumentItem {
      * @public
      */
     originalId?: string | undefined;
+    /**
+     * The ID of the document. Example: 123e4567-e89b-12d3-a456-426614174000
+     * @public
+     */
     id: string;
     companyId: string;
+    /**
+     * The ID of the data source. Example: 123e4567-e89b-12d3-a456-426614174000
+     * @public
+     */
     dataSourceId: string;
     s3OriginalKey?: string | undefined;
     s3MarkdownKey?: string | undefined;
@@ -516,6 +578,10 @@ export interface KnowledgeBaseItem {
      */
     description?: string | undefined;
     dataSources: (string)[];
+    /**
+     * The ID of the knowledge base. Example: 123e4567-e89b-12d3-a456-426614174000
+     * @public
+     */
     id: string;
     companyId: string;
     createdAt: string;
@@ -536,6 +602,10 @@ export interface DeleteDataSourceInput {
      * @public
      */
     companyId?: string | undefined;
+    /**
+     * The ID of the data source. Example: 123e4567-e89b-12d3-a456-426614174000
+     * @public
+     */
     dataSourceId: string;
 }
 /**
@@ -552,7 +622,15 @@ export interface DeleteDocumentInput {
      * @public
      */
     companyId?: string | undefined;
+    /**
+     * The ID of the data source. Example: 123e4567-e89b-12d3-a456-426614174000
+     * @public
+     */
     dataSourceId: string;
+    /**
+     * The ID of the document. Example: 123e4567-e89b-12d3-a456-426614174000
+     * @public
+     */
     documentId: string;
 }
 /**
@@ -569,6 +647,10 @@ export interface DeleteKnowledgeBaseInput {
      * @public
      */
     companyId?: string | undefined;
+    /**
+     * The ID of the knowledge base. Example: 123e4567-e89b-12d3-a456-426614174000
+     * @public
+     */
     knowledgeBaseId: string;
 }
 /**
@@ -597,6 +679,10 @@ export interface GetDataSourceInput {
      * @public
      */
     companyId?: string | undefined;
+    /**
+     * The ID of the data source. Example: 123e4567-e89b-12d3-a456-426614174000
+     * @public
+     */
     dataSourceId: string;
 }
 /**
@@ -614,7 +700,15 @@ export interface GetDocumentInput {
      * @public
      */
     companyId?: string | undefined;
+    /**
+     * The ID of the data source. Example: 123e4567-e89b-12d3-a456-426614174000
+     * @public
+     */
     dataSourceId: string;
+    /**
+     * The ID of the document. Example: 123e4567-e89b-12d3-a456-426614174000
+     * @public
+     */
     documentId: string;
 }
 /**
@@ -632,7 +726,15 @@ export interface GetDocumentPresignedDownloadUrlInput {
      * @public
      */
     companyId?: string | undefined;
+    /**
+     * The ID of the data source. Example: 123e4567-e89b-12d3-a456-426614174000
+     * @public
+     */
     dataSourceId: string;
+    /**
+     * The ID of the document. Example: 123e4567-e89b-12d3-a456-426614174000
+     * @public
+     */
     documentId: string;
     documentType?: DownloadDocumentType | undefined;
 }
@@ -651,7 +753,15 @@ export interface GetDocumentPresignedUploadUrlInput {
      * @public
      */
     companyId?: string | undefined;
+    /**
+     * The ID of the data source. Example: 123e4567-e89b-12d3-a456-426614174000
+     * @public
+     */
     dataSourceId: string;
+    /**
+     * The ID of the document. Example: 123e4567-e89b-12d3-a456-426614174000
+     * @public
+     */
     documentId: string;
 }
 /**
@@ -669,6 +779,10 @@ export interface GetExtraInfoForDataSourceInput {
      * @public
      */
     companyId?: string | undefined;
+    /**
+     * The ID of the data source. Example: 123e4567-e89b-12d3-a456-426614174000
+     * @public
+     */
     dataSourceId: string;
     parameters: __DocumentType;
 }
@@ -687,6 +801,10 @@ export interface GetKnowledgeBaseInput {
      * @public
      */
     companyId?: string | undefined;
+    /**
+     * The ID of the knowledge base. Example: 123e4567-e89b-12d3-a456-426614174000
+     * @public
+     */
     knowledgeBaseId: string;
 }
 /**
@@ -704,7 +822,21 @@ export interface GetSyncLogsInput {
      * @public
      */
     companyId?: string | undefined;
+    /**
+     * The ID of the data source. Example: 123e4567-e89b-12d3-a456-426614174000
+     * @public
+     */
     dataSourceId: string;
+    /**
+     * The number of logs to return. Example: 50
+     * @public
+     */
+    limit?: number | undefined;
+    /**
+     * The offset of the logs to return. Example: 0
+     * @public
+     */
+    offset?: number | undefined;
 }
 /**
  * @public
@@ -743,6 +875,10 @@ export interface GetSyncStatusInput {
      * @public
      */
     companyId?: string | undefined;
+    /**
+     * The ID of the data source. Example: 123e4567-e89b-12d3-a456-426614174000
+     * @public
+     */
     dataSourceId: string;
 }
 /**
@@ -760,6 +896,11 @@ export interface GetSyncStatusOutput {
      * @public
      */
     syncErrorMessage?: string | undefined;
+    /**
+     * The last logs of the sync.
+     * @public
+     */
+    lastSyncLogs?: (SyncLogItem)[] | undefined;
 }
 /**
  * @public
@@ -786,6 +927,10 @@ export interface ListDocumentsInput {
      * @public
      */
     companyId?: string | undefined;
+    /**
+     * The ID of the data source. Example: 123e4567-e89b-12d3-a456-426614174000
+     * @public
+     */
     dataSourceId: string;
 }
 /**
@@ -877,17 +1022,34 @@ export interface QueryKnowledgeBaseInput {
      * @public
      */
     companyId?: string | undefined;
+    /**
+     * The ID of the knowledge base. Example: 123e4567-e89b-12d3-a456-426614174000
+     * @public
+     */
     knowledgeBaseId: string;
+    /**
+     * The query to search the knowledge base. Example: What is the product knowledge base?
+     * @public
+     */
     query: string;
+    /**
+     * The search configuration to use for the query. Example: \{topK: 10, threshold: 0.5, searchStrategy: 'hybrid'\}
+     * @public
+     */
     searchConfig?: SearchConfig | undefined;
+    /**
+     * The LLM configuration to use for the query. Example: \{provider: 'openai', model: 'gpt-4o', temperature: 0.5\}
+     * @public
+     */
     llmConfig?: LlmConfig | undefined;
 }
 /**
  * @public
  */
 export interface QueryKnowledgeBaseOutput {
-    result: string;
+    answer: string;
     metadata: __DocumentType;
+    sources: __DocumentType;
 }
 /**
  * @public
@@ -898,19 +1060,41 @@ export interface SearchKnowledgeBaseInput {
      * @public
      */
     companyId?: string | undefined;
+    /**
+     * The ID of the knowledge base. Example: 123e4567-e89b-12d3-a456-426614174000
+     * @public
+     */
     knowledgeBaseId: string;
+    /**
+     * The query to search the knowledge base. Example: What is the product knowledge base?
+     * @public
+     */
     query: string;
+    /**
+     * The search configuration to use for the search. Example: \{topK: 10, threshold: 0.5, searchStrategy: 'hybrid'\}
+     * @public
+     */
     searchConfig?: SearchConfig | undefined;
 }
 /**
  * @public
  */
 export interface SearchKnowledgeBaseResult {
+    /**
+     * The ID of the document. Example: 123e4567-e89b-12d3-a456-426614174000
+     * @public
+     */
     documentId: string;
+    documentTitle: string;
     score: number;
+    /**
+     * The ID of the data source. Example: 123e4567-e89b-12d3-a456-426614174000
+     * @public
+     */
     source: string;
     content: string;
-    url: string;
+    documentUrl: string;
+    dataSourceType: DataSourceType;
 }
 /**
  * @public
@@ -927,6 +1111,10 @@ export interface StartSyncDataSourceInput {
      * @public
      */
     companyId?: string | undefined;
+    /**
+     * The ID of the data source. Example: 123e4567-e89b-12d3-a456-426614174000
+     * @public
+     */
     dataSourceId: string;
     syncType: SyncDataSourceMode;
 }
@@ -944,6 +1132,10 @@ export interface StopSyncDataSourceInput {
      * @public
      */
     companyId?: string | undefined;
+    /**
+     * The ID of the data source. Example: 123e4567-e89b-12d3-a456-426614174000
+     * @public
+     */
     dataSourceId: string;
 }
 /**
@@ -986,6 +1178,10 @@ export interface UpdateDataSourceInput {
      * @public
      */
     companyId?: string | undefined;
+    /**
+     * The ID of the data source. Example: 123e4567-e89b-12d3-a456-426614174000
+     * @public
+     */
     dataSourceId: string;
 }
 /**
@@ -1033,7 +1229,15 @@ export interface UpdateDocumentInput {
      * @public
      */
     companyId?: string | undefined;
+    /**
+     * The ID of the data source. Example: 123e4567-e89b-12d3-a456-426614174000
+     * @public
+     */
     dataSourceId: string;
+    /**
+     * The ID of the document. Example: 123e4567-e89b-12d3-a456-426614174000
+     * @public
+     */
     documentId: string;
 }
 /**
@@ -1062,6 +1266,10 @@ export interface UpdateKnowledgeBaseInput {
      * @public
      */
     companyId?: string | undefined;
+    /**
+     * The ID of the knowledge base. Example: 123e4567-e89b-12d3-a456-426614174000
+     * @public
+     */
     knowledgeBaseId: string;
 }
 /**

package/dist-types/protocols/Aws_restJson1.d.ts

@@ -1,3 +1,5 @@
+import { CleanDataSourceCommandInput, CleanDataSourceCommandOutput } from "../commands/CleanDataSourceCommand";
+import { CloneDataSourceCommandInput, CloneDataSourceCommandOutput } from "../commands/CloneDataSourceCommand";
 import { CreateDataSourceCommandInput, CreateDataSourceCommandOutput } from "../commands/CreateDataSourceCommand";
 import { CreateDocumentCommandInput, CreateDocumentCommandOutput } from "../commands/CreateDocumentCommand";
 import { CreateKnowledgeBaseCommandInput, CreateKnowledgeBaseCommandOutput } from "../commands/CreateKnowledgeBaseCommand";
@@ -24,6 +26,14 @@ import { UpdateDocumentCommandInput, UpdateDocumentCommandOutput } from "../comm
 import { UpdateKnowledgeBaseCommandInput, UpdateKnowledgeBaseCommandOutput } from "../commands/UpdateKnowledgeBaseCommand";
 import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@smithy/protocol-http";
 import { SerdeContext as __SerdeContext } from "@smithy/types";
+/**
+ * serializeAws_restJson1CleanDataSourceCommand
+ */
+export declare const se_CleanDataSourceCommand: (input: CleanDataSourceCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
+/**
+ * serializeAws_restJson1CloneDataSourceCommand
+ */
+export declare const se_CloneDataSourceCommand: (input: CloneDataSourceCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
 /**
  * serializeAws_restJson1CreateDataSourceCommand
  */
@@ -120,6 +130,14 @@ export declare const se_UpdateDocumentCommand: (input: UpdateDocumentCommandInpu
  * serializeAws_restJson1UpdateKnowledgeBaseCommand
  */
 export declare const se_UpdateKnowledgeBaseCommand: (input: UpdateKnowledgeBaseCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
+/**
+ * deserializeAws_restJson1CleanDataSourceCommand
+ */
+export declare const de_CleanDataSourceCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<CleanDataSourceCommandOutput>;
+/**
+ * deserializeAws_restJson1CloneDataSourceCommand
+ */
+export declare const de_CloneDataSourceCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<CloneDataSourceCommandOutput>;
 /**
  * deserializeAws_restJson1CreateDataSourceCommand
  */

package/package.json

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