@blueking/ai-ui-sdk 0.1.0-beta.13 → 0.1.0-beta.15

package/dist/types/dataset.d.ts

@@ -0,0 +1,232 @@
+import type { IPage } from './common';
+import type { DatasetDataOperatRecordActionId, DatasetDataOperatRecordResultCode, DatasetDataSourceType, DatasetType, UserStatus } from './enum';
+import type { IFileInfo, IFileInfoApi } from './file';
+export interface IDatasetInfo {
+    all: number;
+}
+export interface IDatasetFormApi {
+    component_ids: number[];
+    company_id: string;
+    dataset_name: string;
+    type: DatasetType;
+}
+export interface IDatasetForm {
+    componentIds: number[];
+    companyId?: string;
+    datasetName: string;
+    type: DatasetType;
+}
+export interface IDatasetApi extends IDatasetFormApi {
+    component_names: string[];
+    company_name: string;
+    dataset_item_count: number;
+    updated_at: string;
+    updated_by: string;
+    created_at: string;
+    created_by: string;
+    id: number;
+}
+export interface IDataset extends IDatasetForm {
+    componentNames: string[];
+    companyName: string;
+    datasetItemCount: number;
+    updatedAt: string;
+    updatedBy: string;
+    createdAt: string;
+    createdBy: string;
+    id: number;
+}
+export interface IDatasetListParam extends IPage {
+    componentIds?: string;
+    createdBy?: string;
+    datasetName?: string;
+    fuzzy?: string;
+    ordering?: string;
+    companyName?: string;
+    type?: DatasetType;
+}
+export interface IDatasetListParamApi extends IPage {
+    component_ids?: string;
+    created_by?: string;
+    dataset_name?: string;
+    fuzzy?: string;
+    ordering?: string;
+    company_name?: string;
+    type?: DatasetType;
+}
+export interface IDatasetDataFileApi extends IFileInfoApi {
+    id: string;
+}
+export interface IDatasetDataFile extends IFileInfo {
+    id: string;
+}
+export interface IDatasetDataForm {
+    data?: Record<string, string>;
+    files?: IDatasetDataFile[];
+    datasetId: number;
+    sourceType: DatasetDataSourceType;
+}
+export interface IDatasetDataFormApi {
+    data?: Record<string, string>;
+    files?: IDatasetDataFileApi[];
+    dataset_id: number;
+    source_type: DatasetDataSourceType;
+}
+export interface IDatasetDataApi extends IDatasetDataFormApi {
+    updated_at: string;
+    updated_by: string;
+    created_at: string;
+    created_by: string;
+    id: number;
+}
+export interface IDatasetData extends IDatasetDataForm {
+    updatedAt: string;
+    updatedBy: string;
+    createdAt: string;
+    createdBy: string;
+    id: number;
+}
+export interface IDatasetDataParam extends IPage {
+    datasetId?: number;
+    createdBy?: string;
+    modelType?: string;
+    ordering?: string;
+    sourceType?: DatasetDataSourceType;
+    [key: string]: string | number;
+}
+export interface IDatasetDataParamApi extends IPage {
+    dataset_id?: number;
+    created_by?: string;
+    model_type?: string;
+    ordering?: string;
+    source_type?: DatasetDataSourceType;
+    [key: string]: string | number;
+}
+export interface IUserInfoFormApi {
+    name: string;
+    company_id: number;
+    phone: string;
+    email: string;
+}
+export interface IUserInfoForm {
+    name: string;
+    companyId: number;
+    phone: string;
+    email: string;
+}
+export interface IUserInfoApi extends Partial<IUserInfoFormApi> {
+    nickname?: string;
+    status: UserStatus;
+    company_name?: string;
+    extra?: {
+        weixin?: {
+            appid: string;
+            scope: string;
+            state: string;
+            redirect_uri: string;
+        };
+        message?: string;
+    };
+}
+export interface IUserInfo extends Partial<IUserInfoForm> {
+    nickname?: string;
+    status: UserStatus;
+    companyName?: string;
+    extra?: {
+        weixin?: {
+            appid: string;
+            scope: string;
+            state: string;
+            redirectUri: string;
+        };
+        message?: string;
+    };
+}
+export interface ISchema {
+    id: string;
+    name: string;
+    schema: Record<string, string>;
+}
+export interface IOperatRecordParam {
+    id?: number;
+    instanceId?: number;
+    parentId?: number;
+    resourceTypeId: 'dataset_item';
+    username?: string;
+    actionId?: DatasetDataOperatRecordActionId;
+    date?: {
+        start: string;
+        end: string;
+    };
+    resultCode?: DatasetDataOperatRecordResultCode;
+    instanceData?: string;
+}
+export interface IOperatRecordParamApi {
+    id?: number;
+    instance_id?: number;
+    parent_id?: number;
+    resource_type_id: 'dataset_item';
+    username?: string;
+    action_id?: DatasetDataOperatRecordActionId;
+    date?: {
+        start: string;
+        end: string;
+    };
+    result_code?: DatasetDataOperatRecordResultCode;
+    instance_data?: string;
+}
+export interface IOperatRecordApi {
+    id: number;
+    username: string;
+    instance_id: number;
+    action_id: DatasetDataOperatRecordActionId;
+    result_code: DatasetDataOperatRecordResultCode;
+    instance_data: Record<string, string>;
+    end_time: string;
+}
+export interface IOperatRecord {
+    id: number;
+    username: string;
+    instanceId: number;
+    actionId: DatasetDataOperatRecordActionId;
+    resultCode: DatasetDataOperatRecordResultCode;
+    instanceData: Record<string, string>;
+    endTime: string;
+}
+export interface ICompanyParticipantApi {
+    category: string;
+    component_name: string;
+    description: string;
+    total_participants: number;
+    participants: string[];
+}
+export interface ICompanyParticipant {
+    category: string;
+    componentName: string;
+    description: string;
+    totalParticipants: number;
+    participants: string[];
+    rowspan: number;
+}
+export interface ICompanyApi {
+    id: number;
+    company_name: string;
+}
+export interface ICompany {
+    id: number;
+    companyName: string;
+}
+export interface IComponent {
+    id: number;
+    name: string;
+    code: string;
+    children: IComponent[];
+}
+export interface ICreataDatasetDataResultApi {
+    create_count: number;
+    duplicate_count: number;
+}
+export interface ICreataDatasetDataResult {
+    createCount: number;
+    duplicateCount: number;
+}

package/dist/types/enum.d.ts

@@ -0,0 +1,127 @@
+export declare enum SessionPromptRole {
+    System = "system",
+    Assistant = "assistant",
+    User = "user",
+    Guide = "guide",
+    Pause = "pause",
+    UserImage = "user-image",
+    Hidden = "hidden",
+    HiddenUser = "hidden-user",
+    HiddenAssistant = "hidden-assistant",
+    HiddenSystem = "hidden-system",
+    HiddenGuide = "hidden-guide",
+    TemplateUser = "template-user",
+    TemplateAssistant = "template-assistant",
+    TemplateSystem = "template-system",
+    TemplateGuide = "template-guide",
+    TemplateHidden = "template-hidden"
+}
+export declare enum SessionContentStatus {
+    Fail = "fail",
+    Loading = "loading",
+    Success = "success"
+}
+export declare enum SessionContentRole {
+    Ai = "ai",
+    User = "user",
+    Time = "time",
+    System = "system",
+    Role = "role",
+    Hidden = "hidden",
+    Guide = "guide",
+    Pause = "pause",
+    TokenExpired = "token-expired",
+    UserImage = "user-image",
+    HiddenUser = "hidden-user",
+    HiddenAi = "hidden-ai",
+    HiddenRole = "hidden-role",
+    HiddenGuide = "hidden-guide",
+    TemplateUser = "template-user",
+    TemplateAi = "template-ai",
+    TemplateRole = "template-role",
+    TemplateGuide = "template-guide",
+    TemplateHidden = "template-hidden",
+    ImageNotSupported = "image-not-supported"
+}
+export declare enum HttpErrorCode {
+    TokenExpired = "80003",
+    ImageNotSupported = "82003",
+    UnAuthorizedPreviewFile = "80401",
+    TagRepeat = "1513405",
+    Aborted = 20,
+    UnLogin = 401,
+    IamNoPermission = "IAM_NO_PERMISSION"
+}
+export declare enum ApiValueType {
+    String = "string",
+    Number = "number",
+    Boolean = "boolean",
+    Array = "array",
+    Object = "object",
+    Integer = "integer"
+}
+export declare enum EnumCharacter {
+    All = "all",
+    System = "system",
+    User = "user",
+    Public = "public",
+    Space = "space"
+}
+export declare enum FileStatus {
+    Init = "init",
+    Uploading = "uploading",
+    Uploaded = "uploaded",
+    Deleting = "deleting",
+    Deleted = "deleted",
+    Failed = "failed"
+}
+export declare enum KnowledgePathType {
+    File = "file",
+    Folder = "folder"
+}
+export declare enum KnowledgeType {
+    File = "file",
+    Manual = "manual",
+    Link = "link"
+}
+export declare enum FileLinkType {
+    External = "external",
+    BkRepo = "bk_repo"
+}
+export declare enum EventType {
+    Error = "error"
+}
+export declare enum LLMSupport {
+    Summary = "summary",
+    ChatCompletion = "chat.completion"
+}
+export declare enum DatasetType {
+    PretrainedText = "pretrained_text",
+    SingleTurnChat = "single_turn_chat",
+    SingleTurnChatWithReasoning = "single_turn_chat_with_reasoning",
+    MultiTurnChat = "multi_turn_chat",
+    MultiTurnChatWithReasoning = "multi_turn_chat_with_reasoning",
+    SingleChoice = "single_choice"
+}
+export declare enum DatasetDataSourceType {
+    UploadFile = "upload_file",
+    ApiReport = "api_report",
+    KnowledgebaseImport = "knowledgebase_import",
+    ManualImport = "manual_import"
+}
+export declare enum UserStatus {
+    Unauthorized = "unauthorized",
+    Unsubmitted = "unsubmitted",
+    Reviewing = "reviewing",
+    Rejected = "rejected",
+    Approved = "approved"
+}
+export declare enum DatasetDataOperatRecordActionId {
+    AddDatasetItem = "add_dataset_item",
+    EditDatasetItem = "edit_dataset_item",
+    DeleteDatasetItem = "delete_dataset_item"
+}
+export declare enum DatasetDataOperatRecordResultCode {
+    Success = 0,
+    Failed = 1
+}

package/dist/types/file.d.ts

@@ -0,0 +1,23 @@
+import { FileLinkType } from './enum';
+export interface ILinkFile {
+    url: string;
+    fileName: string;
+    fileSize: number;
+    fileType: string;
+    linkType: FileLinkType;
+    fileNumber?: number;
+    id?: string;
+    files?: File[];
+    loadingPercentage?: number;
+    headers?: Record<string, string>;
+}
+export interface IFileInfoApi {
+    file_name: string;
+    file_size: number;
+    file_type: string;
+}
+export interface IFileInfo {
+    fileName: string;
+    fileSize: number;
+    fileType: string;
+}

package/dist/types/knowledge.d.ts

@@ -0,0 +1,133 @@
+import { EnumCharacter, FileStatus, KnowledgePathType, KnowledgeType } from './enum';
+import type { ILinkFile } from './file';
+import type { IResourcePermission, IResourcePermissionApi } from './permission';
+export interface IKnowledgeLinkFile extends ILinkFile {
+    name: string;
+    handleType: string[];
+    splitter: string;
+    pathType: KnowledgePathType;
+    csvDelimiter?: string;
+    indexConfig?: IKnowledgeIndexConfig;
+}
+export interface IKnowledgeIndexApi {
+    index_name: string;
+    index_type: string;
+    status?: 'normal' | 'init' | 'deleting';
+    index_config: {
+        type?: 'user' | 'system';
+        data_type?: string;
+        columns: string[];
+    };
+}
+export interface IKnowledgeIndexConfig {
+    vector_indexes: IKnowledgeIndexApi[];
+    scalar_indexes: IKnowledgeIndexApi[];
+    full_text_indexes: IKnowledgeIndexApi[];
+}
+export interface IKnowledge {
+    id?: number;
+    spaceId?: string;
+    url?: string;
+    content?: string;
+    tagNames?: string[];
+    splitter?: string;
+    handleType?: string[];
+    updateFrequency?: number;
+    headers?: Record<string, string>;
+    csvDelimiter?: string;
+    name: string;
+    fileName?: string;
+    fileSize?: number;
+    fileType?: string;
+    filePath?: string;
+    pathType?: KnowledgePathType;
+    createdType?: KnowledgeType;
+    status?: FileStatus;
+    knowledgebaseId?: number;
+    knowledgebaseName?: string;
+    parentAnchorPath?: string;
+    permission?: IResourcePermission;
+    anchorPath?: string;
+    linkFiles?: IKnowledgeLinkFile[];
+    updatedAt?: string;
+    updatedBy?: string;
+    errorMessage?: string;
+    isStructured?: boolean;
+    indexConfig?: IKnowledgeIndexConfig;
+}
+export interface IKnowledgeApi {
+    id?: number;
+    space_id?: string;
+    url?: string;
+    content?: string;
+    tag_names?: string[];
+    config?: {
+        handle_type?: string[];
+        splitter?: string;
+        update_frequency?: number;
+        headers?: Record<string, string>;
+        csv_delimiter?: string;
+    };
+    knowledge_name: string;
+    knowledge_base_name?: string;
+    knowledge_count?: number;
+    folder_num?: number;
+    file_name: string;
+    file_size?: number;
+    file_type?: string;
+    file_path: string;
+    path_type?: KnowledgePathType;
+    anchor_path?: string;
+    parent_anchor_path?: string;
+    permission?: IResourcePermissionApi;
+    created_type?: KnowledgeType;
+    status?: FileStatus;
+    knowledge_base_id?: number;
+    updated_at?: string;
+    updated_by?: string;
+    error_message?: string;
+    is_structured?: boolean;
+    index_config?: IKnowledgeIndexConfig;
+    children?: Array<IKnowledgeApi>;
+}
+export interface IKnowledgebaseApi {
+    id?: number;
+    space_id?: string;
+    anchor_path?: string;
+    config?: {
+        handle_type?: string[];
+    };
+    name: string;
+    description?: string;
+    generate_type?: EnumCharacter;
+    knowledge_count?: number;
+    folder_num?: number;
+    updated_by?: string;
+    index_config?: IKnowledgeIndexConfig;
+    permission?: IResourcePermissionApi;
+    children?: Array<IKnowledgeApi>;
+}
+export interface IKnowledgebase {
+    id?: number;
+    knowledgebaseId?: number;
+    spaceId?: string;
+    anchorPath?: string;
+    parentAnchorPath?: string;
+    filePath: string;
+    fileName?: string;
+    fileType?: string;
+    handleType?: string[];
+    updateFrequency?: number;
+    name: string;
+    generateType?: EnumCharacter;
+    pathType?: KnowledgePathType;
+    createdType?: KnowledgeType;
+    number?: number;
+    description?: string;
+    folderNumber?: number;
+    url?: string;
+    updatedBy?: string;
+    indexConfig?: IKnowledgeIndexConfig;
+    permission?: IResourcePermission;
+    children?: Array<IKnowledgebase>;
+}

package/dist/types/model.d.ts

@@ -0,0 +1,14 @@
+import { LLMSupport } from '@/types/enum';
+export interface IModel {
+    llmCode: string;
+    llmName: string;
+    llmType: LLMSupport;
+    property: {
+        onlyUserAssistant?: boolean;
+        supportTools?: boolean;
+        supportWindow?: boolean;
+        supportVision?: boolean;
+        default?: boolean;
+        isSelfHost?: boolean;
+    };
+}

package/dist/types/permission.d.ts

@@ -0,0 +1,48 @@
+export interface IResourcePermissionApi {
+    access_model?: boolean;
+    access_model_strategy?: boolean;
+    view_space?: boolean;
+    manage_space?: boolean;
+    view_agent?: boolean;
+    create_agent?: boolean;
+    manage_agent?: boolean;
+    view_prompt?: boolean;
+    create_prompt?: boolean;
+    manage_prompt?: boolean;
+    view_collection?: boolean;
+    create_collection?: boolean;
+    manage_collection?: boolean;
+    view_tool?: boolean;
+    create_tool?: boolean;
+    manage_tool?: boolean;
+    view_knowledgebase?: boolean;
+    create_knowledgebase?: boolean;
+    manage_knowledgebase?: boolean;
+    view_query_template?: boolean;
+    create_query_template?: boolean;
+    manage_query_template?: boolean;
+}
+export interface IResourcePermission {
+    accessModel?: boolean;
+    accessModelStrategy?: boolean;
+    viewSpace?: boolean;
+    manageSpace?: boolean;
+    viewAgent?: boolean;
+    createAgent?: boolean;
+    manageAgent?: boolean;
+    viewPrompt?: boolean;
+    createPrompt?: boolean;
+    managePrompt?: boolean;
+    viewCollection?: boolean;
+    createCollection?: boolean;
+    manageCollection?: boolean;
+    viewTool?: boolean;
+    createTool?: boolean;
+    manageTool?: boolean;
+    viewKnowledgebase?: boolean;
+    createKnowledgebase?: boolean;
+    manageKnowledgebase?: boolean;
+    viewQueryTemplate?: boolean;
+    createQueryTemplate?: boolean;
+    manageQueryTemplate?: boolean;
+}