@wildix/wim-knowledge-base-client 0.0.7

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

@@ -0,0 +1,981 @@
+import { KnowledgeBaseServiceException as __BaseException } from "./KnowledgeBaseServiceException";
+import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
+import { DocumentType as __DocumentType } from "@smithy/types";
+/**
+ * @public
+ */
+export declare class ValidationException extends __BaseException {
+    readonly name: "ValidationException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
+}
+/**
+ * @public
+ */
+export declare class ForbiddenException extends __BaseException {
+    readonly name: "ForbiddenException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<ForbiddenException, __BaseException>);
+}
+/**
+ * @public
+ */
+export declare class UnauthorizedException extends __BaseException {
+    readonly name: "UnauthorizedException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<UnauthorizedException, __BaseException>);
+}
+/**
+ * @public
+ */
+export interface ConfluencePagesConfig {
+    enabled: (string)[];
+    disabled: (string)[];
+}
+/**
+ * @public
+ */
+export interface ConfluenceConfig {
+    /**
+     * The URL of the Confluence instance. Example: https://your-confluence-domain.atlassian.net
+     * @public
+     */
+    url: string;
+    /**
+     * The username or email of the Confluence instance.
+     * @public
+     */
+    username: string;
+    /**
+     * The API token of the Confluence instance.
+     * @public
+     */
+    apiKey: string;
+    /**
+     * The space ID of the Confluence instance.
+     * @public
+     */
+    spaceId: string;
+    pages?: ConfluencePagesConfig | undefined;
+}
+/**
+ * @public
+ */
+export interface UserFilesConfig {
+    allowedExtensions: (string)[];
+}
+/**
+ * @public
+ */
+export interface GDriveFoldersConfig {
+    enabled: (string)[];
+    disabled: (string)[];
+}
+/**
+ * @public
+ */
+export interface GDriveConfig {
+    /**
+     * The Nango connection ID of the GDrive instance.
+     * @public
+     */
+    nangoConnectionId: string;
+    folders: GDriveFoldersConfig;
+}
+/**
+ * @public
+ */
+export type DataSourceConfig = DataSourceConfig.ConfluenceMember | DataSourceConfig.FilesMember | DataSourceConfig.GdriveMember | DataSourceConfig.$UnknownMember;
+/**
+ * @public
+ */
+export declare namespace DataSourceConfig {
+    interface ConfluenceMember {
+        confluence: ConfluenceConfig;
+        gdrive?: never;
+        files?: never;
+        $unknown?: never;
+    }
+    interface GdriveMember {
+        confluence?: never;
+        gdrive: GDriveConfig;
+        files?: never;
+        $unknown?: never;
+    }
+    interface FilesMember {
+        confluence?: never;
+        gdrive?: never;
+        files: UserFilesConfig;
+        $unknown?: never;
+    }
+    /**
+     * @public
+     */
+    interface $UnknownMember {
+        confluence?: never;
+        gdrive?: never;
+        files?: never;
+        $unknown: [string, any];
+    }
+    interface Visitor<T> {
+        confluence: (value: ConfluenceConfig) => T;
+        gdrive: (value: GDriveConfig) => T;
+        files: (value: UserFilesConfig) => T;
+        _: (name: string, value: any) => T;
+    }
+    const visit: <T>(value: DataSourceConfig, visitor: Visitor<T>) => T;
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const DataSourceType: {
+    readonly CONFLUENCE: "confluence";
+    readonly FILES: "files";
+    readonly GDRIVE: "gdrive";
+    readonly PROXY: "proxy";
+};
+/**
+ * @public
+ */
+export type DataSourceType = typeof DataSourceType[keyof typeof DataSourceType];
+/**
+ * @public
+ */
+export interface CreateDataSourceInput {
+    /**
+     * The name of the data source. Example: Product Confluence
+     * @public
+     */
+    name: string;
+    /**
+     * The description of the data source. Example: This data source contains information about the products and services we offer in Confluence.
+     * @public
+     */
+    description?: string | undefined;
+    /**
+     * The type of the data source. Example: confluence
+     * @public
+     */
+    type: DataSourceType;
+    config: DataSourceConfig;
+    /**
+     * Whether the data source is enabled. Example: true
+     * @public
+     */
+    enabled: boolean;
+    /**
+     * The sync schedule of the data source. Example: 0 *\/6 * * * (every 6 hours)
+     * @public
+     */
+    syncSchedule?: string | undefined;
+    /**
+     * The unique identifier of the tenant when a service token is used.
+     * @public
+     */
+    companyId?: string | undefined;
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const SyncDataSourceMode: {
+    readonly FULL: "full";
+    readonly INCREMENTAL: "incremental";
+    readonly UNKNOWN: "unknown";
+};
+/**
+ * @public
+ */
+export type SyncDataSourceMode = typeof SyncDataSourceMode[keyof typeof SyncDataSourceMode];
+/**
+ * @public
+ * @enum
+ */
+export declare const SyncDataSourceStatus: {
+    readonly FAILED: "failed";
+    readonly IDLE: "idle";
+    readonly RUNNING: "running";
+    readonly SUCCESS: "success";
+};
+/**
+ * @public
+ */
+export type SyncDataSourceStatus = typeof SyncDataSourceStatus[keyof typeof SyncDataSourceStatus];
+/**
+ * @public
+ */
+export interface DataSourceItem {
+    /**
+     * The name of the data source. Example: Product Confluence
+     * @public
+     */
+    name: string;
+    /**
+     * The description of the data source. Example: This data source contains information about the products and services we offer in Confluence.
+     * @public
+     */
+    description?: string | undefined;
+    /**
+     * The type of the data source. Example: confluence
+     * @public
+     */
+    type: DataSourceType;
+    config: DataSourceConfig;
+    /**
+     * Whether the data source is enabled. Example: true
+     * @public
+     */
+    enabled: boolean;
+    /**
+     * The sync schedule of the data source. Example: 0 *\/6 * * * (every 6 hours)
+     * @public
+     */
+    syncSchedule?: string | undefined;
+    id: string;
+    companyId: string;
+    createdAt: string;
+    updatedAt: string;
+    syncStatus: SyncDataSourceStatus;
+    /**
+     * The last time the data source was synced. Example: 2021-01-01T00:00:00Z
+     * @public
+     */
+    lastSyncedAt?: string | undefined;
+    /**
+     * The mode of the last sync. Example: full or incremental
+     * @public
+     */
+    lastSyncMode?: SyncDataSourceMode | undefined;
+    /**
+     * The error message of the last sync. Example: Error syncing data source
+     * @public
+     */
+    lastSyncErrorMessage?: string | undefined;
+}
+/**
+ * @public
+ */
+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
+ */
+export interface CreateDocumentInput {
+    /**
+     * The title of the document. Example: Product Knowledge Base
+     * @public
+     */
+    title: string;
+    /**
+     * The URL of the document. Example: https://www.example.com/product-knowledge-base
+     * @public
+     */
+    url?: string | undefined;
+    /**
+     * The content of the document. Example: This document contains information about the products and services we offer.
+     * @public
+     */
+    content?: string | undefined;
+    /**
+     * The format of the original document. Example: pdf, docx, etc.
+     * @public
+     */
+    originalFormat: string;
+    /**
+     * The name/ID of the original document. Example: product-knowledge-base.pdf
+     * @public
+     */
+    originalName: string;
+    /**
+     * The original ID of the document. Example: confluence-page-1234567890
+     * @public
+     */
+    originalId?: string | undefined;
+    /**
+     * The unique identifier of the tenant when a service token is used.
+     * @public
+     */
+    companyId?: string | undefined;
+    dataSourceId: string;
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const DocumentStatus: {
+    readonly COMPLETED: "completed";
+    readonly FAILED: "failed";
+    readonly PENDING: "pending";
+    readonly PROCESSING: "processing";
+};
+/**
+ * @public
+ */
+export type DocumentStatus = typeof DocumentStatus[keyof typeof DocumentStatus];
+/**
+ * @public
+ */
+export interface DocumentItem {
+    /**
+     * The title of the document. Example: Product Knowledge Base
+     * @public
+     */
+    title: string;
+    /**
+     * The URL of the document. Example: https://www.example.com/product-knowledge-base
+     * @public
+     */
+    url?: string | undefined;
+    /**
+     * The content of the document. Example: This document contains information about the products and services we offer.
+     * @public
+     */
+    content?: string | undefined;
+    /**
+     * The format of the original document. Example: pdf, docx, etc.
+     * @public
+     */
+    originalFormat: string;
+    /**
+     * The name/ID of the original document. Example: product-knowledge-base.pdf
+     * @public
+     */
+    originalName: string;
+    /**
+     * The original ID of the document. Example: confluence-page-1234567890
+     * @public
+     */
+    originalId?: string | undefined;
+    id: string;
+    companyId: string;
+    dataSourceId: string;
+    s3OriginalKey?: string | undefined;
+    s3MarkdownKey?: string | undefined;
+    createdAt: string;
+    updatedAt: string;
+    status: DocumentStatus;
+    errorMessage?: string | undefined;
+}
+/**
+ * @public
+ */
+export interface CreateDocumentOutput {
+    document: DocumentItem;
+}
+/**
+ * @public
+ */
+export interface CreateKnowledgeBaseInput {
+    /**
+     * The name of the knowledge base. Example: Product Knowledge Base
+     * @public
+     */
+    name: string;
+    /**
+     * The description of the knowledge base. Example: This knowledge base contains information about the products and services we offer.
+     * @public
+     */
+    description?: string | undefined;
+    dataSources: (string)[];
+    /**
+     * The unique identifier of the tenant when a service token is used.
+     * @public
+     */
+    companyId?: string | undefined;
+}
+/**
+ * @public
+ */
+export interface KnowledgeBaseItem {
+    /**
+     * The name of the knowledge base. Example: Product Knowledge Base
+     * @public
+     */
+    name: string;
+    /**
+     * The description of the knowledge base. Example: This knowledge base contains information about the products and services we offer.
+     * @public
+     */
+    description?: string | undefined;
+    dataSources: (string)[];
+    id: string;
+    companyId: string;
+    createdAt: string;
+    updatedAt: string;
+}
+/**
+ * @public
+ */
+export interface CreateKnowledgeBaseOutput {
+    knowledgeBase: KnowledgeBaseItem;
+}
+/**
+ * @public
+ */
+export interface DeleteDataSourceInput {
+    /**
+     * The unique identifier of the tenant when a service token is used.
+     * @public
+     */
+    companyId?: string | undefined;
+    dataSourceId: string;
+}
+/**
+ * @public
+ */
+export interface DeleteDataSourceOutput {
+}
+/**
+ * @public
+ */
+export interface DeleteDocumentInput {
+    /**
+     * The unique identifier of the tenant when a service token is used.
+     * @public
+     */
+    companyId?: string | undefined;
+    dataSourceId: string;
+    documentId: string;
+}
+/**
+ * @public
+ */
+export interface DeleteDocumentOutput {
+}
+/**
+ * @public
+ */
+export interface DeleteKnowledgeBaseInput {
+    /**
+     * The unique identifier of the tenant when a service token is used.
+     * @public
+     */
+    companyId?: string | undefined;
+    knowledgeBaseId: string;
+}
+/**
+ * @public
+ */
+export interface DeleteKnowledgeBaseOutput {
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const DownloadDocumentType: {
+    readonly MARKDOWN: "markdown";
+    readonly ORIGINAL: "original";
+};
+/**
+ * @public
+ */
+export type DownloadDocumentType = typeof DownloadDocumentType[keyof typeof DownloadDocumentType];
+/**
+ * @public
+ */
+export interface GetAuthorizationSessionForDataSourceInput {
+    /**
+     * The unique identifier of the tenant when a service token is used.
+     * @public
+     */
+    companyId?: string | undefined;
+    dataSourceId: string;
+}
+/**
+ * @public
+ */
+export interface GetAuthorizationSessionForDataSourceOutput {
+    authorizationSession: string;
+}
+/**
+ * @public
+ */
+export interface GetDataSourceInput {
+    /**
+     * The unique identifier of the tenant when a service token is used.
+     * @public
+     */
+    companyId?: string | undefined;
+    dataSourceId: string;
+}
+/**
+ * @public
+ */
+export interface GetDataSourceOutput {
+    dataSource: DataSourceItem;
+}
+/**
+ * @public
+ */
+export interface GetDocumentInput {
+    /**
+     * The unique identifier of the tenant when a service token is used.
+     * @public
+     */
+    companyId?: string | undefined;
+    dataSourceId: string;
+    documentId: string;
+}
+/**
+ * @public
+ */
+export interface GetDocumentOutput {
+    document: DocumentItem;
+}
+/**
+ * @public
+ */
+export interface GetDocumentPresignedDownloadUrlInput {
+    /**
+     * The unique identifier of the tenant when a service token is used.
+     * @public
+     */
+    companyId?: string | undefined;
+    dataSourceId: string;
+    documentId: string;
+    documentType?: DownloadDocumentType | undefined;
+}
+/**
+ * @public
+ */
+export interface GetDocumentPresignedDownloadUrlOutput {
+    presignedDownloadUrl: string;
+}
+/**
+ * @public
+ */
+export interface GetDocumentPresignedUploadUrlInput {
+    /**
+     * The unique identifier of the tenant when a service token is used.
+     * @public
+     */
+    companyId?: string | undefined;
+    dataSourceId: string;
+    documentId: string;
+}
+/**
+ * @public
+ */
+export interface GetDocumentPresignedUploadUrlOutput {
+    presignedUploadUrl: string;
+}
+/**
+ * @public
+ */
+export interface GetKnowledgeBaseInput {
+    /**
+     * The unique identifier of the tenant when a service token is used.
+     * @public
+     */
+    companyId?: string | undefined;
+    knowledgeBaseId: string;
+}
+/**
+ * @public
+ */
+export interface GetKnowledgeBaseOutput {
+    knowledgeBase: KnowledgeBaseItem;
+}
+/**
+ * @public
+ */
+export interface GetSyncLogsInput {
+    /**
+     * The unique identifier of the tenant when a service token is used.
+     * @public
+     */
+    companyId?: string | undefined;
+    dataSourceId: string;
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const SyncLogLevel: {
+    readonly DEBUG: "debug";
+    readonly ERROR: "error";
+    readonly INFO: "info";
+    readonly WARN: "warn";
+};
+/**
+ * @public
+ */
+export type SyncLogLevel = typeof SyncLogLevel[keyof typeof SyncLogLevel];
+/**
+ * @public
+ */
+export interface SyncLogItem {
+    timestamp: string;
+    level: SyncLogLevel;
+    message: string;
+}
+/**
+ * @public
+ */
+export interface GetSyncLogsOutput {
+    logs: (SyncLogItem)[];
+}
+/**
+ * @public
+ */
+export interface GetSyncStatusInput {
+    /**
+     * The unique identifier of the tenant when a service token is used.
+     * @public
+     */
+    companyId?: string | undefined;
+    dataSourceId: string;
+}
+/**
+ * @public
+ */
+export interface GetSyncStatusOutput {
+    syncStatus: SyncDataSourceStatus;
+    /**
+     * The progress of the sync. Example: 55
+     * @public
+     */
+    progress?: number | undefined;
+    /**
+     * The error message of the sync. Example: Error syncing data source
+     * @public
+     */
+    syncErrorMessage?: string | undefined;
+}
+/**
+ * @public
+ */
+export interface ListDataSourcesInput {
+    /**
+     * The unique identifier of the tenant when a service token is used.
+     * @public
+     */
+    companyId?: string | undefined;
+}
+/**
+ * @public
+ */
+export interface ListDataSourcesOutput {
+    dataSources: (DataSourceItem)[];
+}
+/**
+ * @public
+ */
+export interface ListDocumentsInput {
+    /**
+     * The unique identifier of the tenant when a service token is used.
+     * @public
+     */
+    companyId?: string | undefined;
+    dataSourceId: string;
+}
+/**
+ * @public
+ */
+export interface ListDocumentsOutput {
+    documents: (DocumentItem)[];
+}
+/**
+ * @public
+ */
+export interface ListKnowledgeBasesInput {
+    /**
+     * The unique identifier of the tenant when a service token is used.
+     * @public
+     */
+    companyId?: string | undefined;
+}
+/**
+ * @public
+ */
+export interface ListKnowledgeBasesOutput {
+    knowledgeBases: (KnowledgeBaseItem)[];
+}
+/**
+ * @public
+ */
+export interface LlmConfig {
+    /**
+     * The LLM provider to use for the answer. Example: openai, anthropic, google, etc.
+     * @public
+     */
+    provider: string;
+    /**
+     * The model to use for the answer. Example: gpt-4o, gpt-4o-mini, etc.
+     * @public
+     */
+    model: string;
+    /**
+     * The temperature to use for the answer. Example: 0.5
+     * @public
+     */
+    temperature?: 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
+     */
+    systemPrompt?: string | undefined;
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const SearchStrategy: {
+    readonly BM25: "bm25";
+    readonly HYBRID: "hybrid";
+    readonly VECTOR: "vector";
+};
+/**
+ * @public
+ */
+export type SearchStrategy = typeof SearchStrategy[keyof typeof SearchStrategy];
+/**
+ * @public
+ */
+export interface SearchConfig {
+    /**
+     * The number of results to return. Example: 10
+     * @public
+     */
+    topK?: number | undefined;
+    /**
+     * The threshold for the results. Example: 0.5
+     * @public
+     */
+    threshold?: number | undefined;
+    /**
+     * The search strategy to use. Example: hybrid
+     * @public
+     */
+    searchStrategy?: SearchStrategy | undefined;
+}
+/**
+ * @public
+ */
+export interface QueryKnowledgeBaseInput {
+    /**
+     * The unique identifier of the tenant when a service token is used.
+     * @public
+     */
+    companyId?: string | undefined;
+    knowledgeBaseId: string;
+    query: string;
+    searchConfig?: SearchConfig | undefined;
+    llmConfig?: LlmConfig | undefined;
+}
+/**
+ * @public
+ */
+export interface QueryKnowledgeBaseOutput {
+    result: string;
+    metadata: __DocumentType;
+}
+/**
+ * @public
+ */
+export interface SearchKnowledgeBaseInput {
+    /**
+     * The unique identifier of the tenant when a service token is used.
+     * @public
+     */
+    companyId?: string | undefined;
+    knowledgeBaseId: string;
+    query: string;
+    searchConfig?: SearchConfig | undefined;
+}
+/**
+ * @public
+ */
+export interface SearchKnowledgeBaseResult {
+    documentId: string;
+    score: number;
+    source: string;
+    content: string;
+    url: string;
+}
+/**
+ * @public
+ */
+export interface SearchKnowledgeBaseOutput {
+    results: (SearchKnowledgeBaseResult)[];
+}
+/**
+ * @public
+ */
+export interface SyncDataSourceInput {
+    /**
+     * The unique identifier of the tenant when a service token is used.
+     * @public
+     */
+    companyId?: string | undefined;
+    dataSourceId: string;
+    syncType: SyncDataSourceMode;
+}
+/**
+ * @public
+ */
+export interface SyncDataSourceOutput {
+}
+/**
+ * @public
+ */
+export interface UpdateDataSourceInput {
+    /**
+     * The name of the data source. Example: Product Confluence
+     * @public
+     */
+    name: string;
+    /**
+     * The description of the data source. Example: This data source contains information about the products and services we offer in Confluence.
+     * @public
+     */
+    description?: string | undefined;
+    /**
+     * The type of the data source. Example: confluence
+     * @public
+     */
+    type: DataSourceType;
+    config: DataSourceConfig;
+    /**
+     * Whether the data source is enabled. Example: true
+     * @public
+     */
+    enabled: boolean;
+    /**
+     * The sync schedule of the data source. Example: 0 *\/6 * * * (every 6 hours)
+     * @public
+     */
+    syncSchedule?: string | undefined;
+    /**
+     * The unique identifier of the tenant when a service token is used.
+     * @public
+     */
+    companyId?: string | undefined;
+    dataSourceId: string;
+}
+/**
+ * @public
+ */
+export interface UpdateDataSourceOutput {
+    dataSource: DataSourceItem;
+}
+/**
+ * @public
+ */
+export interface UpdateDocumentInput {
+    /**
+     * The title of the document. Example: Product Knowledge Base
+     * @public
+     */
+    title: string;
+    /**
+     * The URL of the document. Example: https://www.example.com/product-knowledge-base
+     * @public
+     */
+    url?: string | undefined;
+    /**
+     * The content of the document. Example: This document contains information about the products and services we offer.
+     * @public
+     */
+    content?: string | undefined;
+    /**
+     * The format of the original document. Example: pdf, docx, etc.
+     * @public
+     */
+    originalFormat: string;
+    /**
+     * The name/ID of the original document. Example: product-knowledge-base.pdf
+     * @public
+     */
+    originalName: string;
+    /**
+     * The original ID of the document. Example: confluence-page-1234567890
+     * @public
+     */
+    originalId?: string | undefined;
+    /**
+     * The unique identifier of the tenant when a service token is used.
+     * @public
+     */
+    companyId?: string | undefined;
+    dataSourceId: string;
+    documentId: string;
+}
+/**
+ * @public
+ */
+export interface UpdateDocumentOutput {
+    document: DocumentItem;
+}
+/**
+ * @public
+ */
+export interface UpdateKnowledgeBaseInput {
+    /**
+     * The name of the knowledge base. Example: Product Knowledge Base
+     * @public
+     */
+    name: string;
+    /**
+     * The description of the knowledge base. Example: This knowledge base contains information about the products and services we offer.
+     * @public
+     */
+    description?: string | undefined;
+    dataSources: (string)[];
+    /**
+     * The unique identifier of the tenant when a service token is used.
+     * @public
+     */
+    companyId?: string | undefined;
+    knowledgeBaseId: string;
+}
+/**
+ * @public
+ */
+export interface UpdateKnowledgeBaseOutput {
+    knowledgeBase: KnowledgeBaseItem;
+}