@dxpos/knowledge 0.3.0

package/dist/generated/types.gen.d.ts

@@ -0,0 +1,927 @@
+export type ClientOptions = {
+    baseUrl: `${string}://${string}` | (string & {});
+};
+export type ErrorResponse = {
+    /**
+     * 业务码，成功为 0
+     */
+    code: number;
+    message: string;
+    data: {
+        [key: string]: unknown;
+    } | Array<unknown> | null;
+};
+export type FileStatus = 'pending' | 'ready' | 'failed';
+export type FileScope = 'general' | 'knowledge';
+export type StoredFile = {
+    id: string;
+    objectKey: string;
+    filename: string;
+    size: number;
+    mimeType: string;
+    status: 'pending' | 'ready' | 'failed';
+    scope: 'general' | 'knowledge';
+    createdBy: string | null;
+    updatedBy: string | null;
+    createdAt: string;
+    updatedAt: string;
+};
+export type FileListItem = {
+    id: string;
+    objectKey: string;
+    filename: string;
+    size: number;
+    mimeType: string;
+    status: 'pending' | 'ready' | 'failed';
+    scope: 'general' | 'knowledge';
+    createdBy: string | null;
+    updatedBy: string | null;
+    createdAt: string;
+    updatedAt: string;
+    filenameSnippet: string;
+};
+export type BackendUploadResult = {
+    filename: string;
+    status: 'ok' | 'error';
+    file?: {
+        id: string;
+        objectKey: string;
+        filename: string;
+        size: number;
+        mimeType: string;
+        status: 'pending' | 'ready' | 'failed';
+        scope: 'general' | 'knowledge';
+        createdBy: string | null;
+        updatedBy: string | null;
+        createdAt: string;
+        updatedAt: string;
+    };
+    error?: string;
+};
+export type PrepareUploadResult = {
+    filename: string;
+    status: 'ok' | 'error';
+    id?: string;
+    objectKey?: string;
+    uploadUrl?: string;
+    error?: string;
+};
+export type CompleteUploadResult = {
+    id: string;
+    status: 'ok' | 'error';
+    file?: {
+        id: string;
+        objectKey: string;
+        filename: string;
+        size: number;
+        mimeType: string;
+        status: 'pending' | 'ready' | 'failed';
+        scope: 'general' | 'knowledge';
+        createdBy: string | null;
+        updatedBy: string | null;
+        createdAt: string;
+        updatedAt: string;
+    };
+    publicUrl?: string;
+    error?: string;
+};
+export type MessageRole = 'user' | 'assistant';
+export type Message = {
+    id: string;
+    conversationId: string;
+    role: 'user' | 'assistant';
+    content: string;
+    createdBy: string | null;
+    createdAt: string;
+};
+export type Conversation = {
+    id: string;
+    title: string;
+    systemPrompt: string | null;
+    splitPrompt: string | null;
+    splitQuery: boolean | null;
+    scoreThreshold: number | null;
+    lowScoreReply: string | null;
+    createdBy: string | null;
+    updatedBy: string | null;
+    createdAt: string;
+};
+export type ChatEvent = {
+    type: 'token';
+    content: string;
+} | {
+    type: 'node';
+    name: string;
+    status: 'end';
+} | {
+    type: 'references';
+    documents: Array<{
+        id: string;
+        filename: string;
+        chunkCount: number;
+        score: number;
+    }>;
+} | {
+    type: 'done';
+} | {
+    type: 'error';
+    message: string;
+};
+export type ChatAnswer = {
+    answer: string;
+    references: Array<{
+        id: string;
+        filename: string;
+        chunkCount: number;
+        score: number;
+    }>;
+};
+export type ChatModuleSettings = {
+    systemPrompt: string | null;
+    splitPrompt: string | null;
+    splitQuery: boolean | null;
+    scoreThreshold: number | null;
+    lowScoreReply: string | null;
+    updatedBy: string | null;
+    updatedAt: string;
+};
+export type SearchHit = {
+    documentId: string;
+    filename: string;
+    chunkIndex: number;
+    content: string;
+    headingPath: string;
+    snippet: string;
+    filenameSnippet: string;
+    headingSnippet: string;
+};
+export type GetApiFilesData = {
+    body?: never;
+    path?: never;
+    query?: {
+        scope?: FileScope;
+        /**
+         * 文件名关键词
+         */
+        q?: string;
+    };
+    url: '/api/files';
+};
+export type GetApiFilesErrors = {
+    /**
+     * 请求参数无效
+     */
+    400: ErrorResponse;
+    /**
+     * 未登录
+     */
+    401: ErrorResponse;
+    /**
+     * 服务器内部错误
+     */
+    500: ErrorResponse;
+};
+export type GetApiFilesError = GetApiFilesErrors[keyof GetApiFilesErrors];
+export type GetApiFilesResponses = {
+    /**
+     * 成功
+     */
+    200: {
+        /**
+         * 业务码，成功为 0
+         */
+        code: number;
+        message: string;
+        data: Array<FileListItem>;
+    };
+};
+export type GetApiFilesResponse = GetApiFilesResponses[keyof GetApiFilesResponses];
+export type PostApiFilesData = {
+    body: {
+        files: Array<Blob | File>;
+        scope: FileScope;
+    };
+    path?: never;
+    query?: never;
+    url: '/api/files';
+};
+export type PostApiFilesErrors = {
+    /**
+     * 请求参数无效
+     */
+    400: ErrorResponse;
+    /**
+     * 未登录
+     */
+    401: ErrorResponse;
+    /**
+     * 无权限
+     */
+    403: ErrorResponse;
+    /**
+     * 资源不存在
+     */
+    404: ErrorResponse;
+    /**
+     * 服务器内部错误
+     */
+    500: ErrorResponse;
+};
+export type PostApiFilesError = PostApiFilesErrors[keyof PostApiFilesErrors];
+export type PostApiFilesResponses = {
+    /**
+     * 部分或全部成功
+     */
+    201: {
+        /**
+         * 业务码，成功为 0
+         */
+        code: number;
+        message: string;
+        data: {
+            results?: Array<BackendUploadResult>;
+        };
+    };
+};
+export type PostApiFilesResponse = PostApiFilesResponses[keyof PostApiFilesResponses];
+export type PostApiFilesPresignData = {
+    body: {
+        items: Array<{
+            filename: string;
+            size: number;
+            mimeType: string;
+            scope: FileScope;
+        }>;
+    };
+    path?: never;
+    query?: never;
+    url: '/api/files/presign';
+};
+export type PostApiFilesPresignErrors = {
+    /**
+     * 请求参数无效
+     */
+    400: ErrorResponse;
+    /**
+     * 未登录
+     */
+    401: ErrorResponse;
+    /**
+     * 无权限
+     */
+    403: ErrorResponse;
+    /**
+     * 资源不存在
+     */
+    404: ErrorResponse;
+    /**
+     * 服务器内部错误
+     */
+    500: ErrorResponse;
+};
+export type PostApiFilesPresignError = PostApiFilesPresignErrors[keyof PostApiFilesPresignErrors];
+export type PostApiFilesPresignResponses = {
+    /**
+     * 成功
+     */
+    201: {
+        /**
+         * 业务码，成功为 0
+         */
+        code: number;
+        message: string;
+        data: {
+            results?: Array<PrepareUploadResult>;
+        };
+    };
+};
+export type PostApiFilesPresignResponse = PostApiFilesPresignResponses[keyof PostApiFilesPresignResponses];
+export type PostApiFilesCompleteData = {
+    body: {
+        ids: Array<string>;
+    };
+    path?: never;
+    query?: never;
+    url: '/api/files/complete';
+};
+export type PostApiFilesCompleteErrors = {
+    /**
+     * 请求参数无效
+     */
+    400: ErrorResponse;
+    /**
+     * 未登录
+     */
+    401: ErrorResponse;
+    /**
+     * 无权限
+     */
+    403: ErrorResponse;
+    /**
+     * 资源不存在
+     */
+    404: ErrorResponse;
+    /**
+     * 服务器内部错误
+     */
+    500: ErrorResponse;
+};
+export type PostApiFilesCompleteError = PostApiFilesCompleteErrors[keyof PostApiFilesCompleteErrors];
+export type PostApiFilesCompleteResponses = {
+    /**
+     * 成功
+     */
+    200: {
+        /**
+         * 业务码，成功为 0
+         */
+        code: number;
+        message: string;
+        data: {
+            results?: Array<CompleteUploadResult>;
+        };
+    };
+};
+export type PostApiFilesCompleteResponse = PostApiFilesCompleteResponses[keyof PostApiFilesCompleteResponses];
+export type DeleteApiFilesByIdData = {
+    body?: never;
+    path: {
+        id: string;
+    };
+    query?: never;
+    url: '/api/files/{id}';
+};
+export type DeleteApiFilesByIdErrors = {
+    /**
+     * 请求参数无效
+     */
+    400: ErrorResponse;
+    /**
+     * 未登录
+     */
+    401: ErrorResponse;
+    /**
+     * 无权限
+     */
+    403: ErrorResponse;
+    /**
+     * 资源不存在
+     */
+    404: ErrorResponse;
+    /**
+     * 服务器内部错误
+     */
+    500: ErrorResponse;
+};
+export type DeleteApiFilesByIdError = DeleteApiFilesByIdErrors[keyof DeleteApiFilesByIdErrors];
+export type DeleteApiFilesByIdResponses = {
+    /**
+     * 成功
+     */
+    200: {
+        /**
+         * 业务码，成功为 0
+         */
+        code: number;
+        message: string;
+        data: null;
+    };
+};
+export type DeleteApiFilesByIdResponse = DeleteApiFilesByIdResponses[keyof DeleteApiFilesByIdResponses];
+export type GetApiFilesByIdData = {
+    body?: never;
+    path: {
+        id: string;
+    };
+    query?: never;
+    url: '/api/files/{id}';
+};
+export type GetApiFilesByIdErrors = {
+    /**
+     * 请求参数无效
+     */
+    400: ErrorResponse;
+    /**
+     * 未登录
+     */
+    401: ErrorResponse;
+    /**
+     * 无权限
+     */
+    403: ErrorResponse;
+    /**
+     * 资源不存在
+     */
+    404: ErrorResponse;
+    /**
+     * 服务器内部错误
+     */
+    500: ErrorResponse;
+};
+export type GetApiFilesByIdError = GetApiFilesByIdErrors[keyof GetApiFilesByIdErrors];
+export type GetApiFilesByIdResponses = {
+    /**
+     * 成功
+     */
+    200: {
+        /**
+         * 业务码，成功为 0
+         */
+        code: number;
+        message: string;
+        data: StoredFile;
+    };
+};
+export type GetApiFilesByIdResponse = GetApiFilesByIdResponses[keyof GetApiFilesByIdResponses];
+export type GetApiFilesByIdRawData = {
+    body?: never;
+    path: {
+        id: string;
+    };
+    query?: never;
+    url: '/api/files/{id}/raw';
+};
+export type GetApiFilesByIdRawErrors = {
+    /**
+     * 请求参数无效
+     */
+    400: ErrorResponse;
+    /**
+     * 未登录
+     */
+    401: ErrorResponse;
+    /**
+     * 无权限
+     */
+    403: ErrorResponse;
+    /**
+     * 资源不存在
+     */
+    404: ErrorResponse;
+    /**
+     * 服务器内部错误
+     */
+    500: ErrorResponse;
+};
+export type GetApiFilesByIdRawError = GetApiFilesByIdRawErrors[keyof GetApiFilesByIdRawErrors];
+export type GetApiFilesByIdRawResponses = {
+    /**
+     * 文件二进制流，Content-Type 为文件 MIME
+     */
+    200: Blob | File;
+};
+export type GetApiFilesByIdRawResponse = GetApiFilesByIdRawResponses[keyof GetApiFilesByIdRawResponses];
+export type GetApiFilesByIdUrlData = {
+    body?: never;
+    path: {
+        id: string;
+    };
+    query?: never;
+    url: '/api/files/{id}/url';
+};
+export type GetApiFilesByIdUrlErrors = {
+    /**
+     * 请求参数无效
+     */
+    400: ErrorResponse;
+    /**
+     * 未登录
+     */
+    401: ErrorResponse;
+    /**
+     * 无权限
+     */
+    403: ErrorResponse;
+    /**
+     * 资源不存在
+     */
+    404: ErrorResponse;
+    /**
+     * 服务器内部错误
+     */
+    500: ErrorResponse;
+};
+export type GetApiFilesByIdUrlError = GetApiFilesByIdUrlErrors[keyof GetApiFilesByIdUrlErrors];
+export type GetApiFilesByIdUrlResponses = {
+    /**
+     * 成功
+     */
+    200: {
+        /**
+         * 业务码，成功为 0
+         */
+        code: number;
+        message: string;
+        data: {
+            url: string;
+        };
+    };
+};
+export type GetApiFilesByIdUrlResponse = GetApiFilesByIdUrlResponses[keyof GetApiFilesByIdUrlResponses];
+export type PostApiChatData = {
+    body: {
+        conversationId: string;
+        content: string;
+        stream?: boolean;
+    };
+    path?: never;
+    query?: never;
+    url: '/api/chat';
+};
+export type PostApiChatErrors = {
+    /**
+     * 请求参数无效
+     */
+    400: ErrorResponse;
+    /**
+     * 未登录
+     */
+    401: ErrorResponse;
+    /**
+     * 无权限
+     */
+    403: ErrorResponse;
+    /**
+     * 资源不存在
+     */
+    404: ErrorResponse;
+    /**
+     * 服务器内部错误
+     */
+    500: ErrorResponse;
+};
+export type PostApiChatError = PostApiChatErrors[keyof PostApiChatErrors];
+export type PostApiChatResponses = {
+    /**
+     * stream=true 为 NDJSON 事件；stream=false 为 JSON 信封
+     */
+    200: {
+        /**
+         * 业务码，成功为 0
+         */
+        code: number;
+        message: string;
+        data: ChatAnswer;
+    };
+};
+export type PostApiChatResponse = PostApiChatResponses[keyof PostApiChatResponses];
+export type GetApiChatSettingsData = {
+    body?: never;
+    path?: never;
+    query?: never;
+    url: '/api/chat/settings';
+};
+export type GetApiChatSettingsErrors = {
+    /**
+     * 未登录
+     */
+    401: ErrorResponse;
+    /**
+     * 无权限
+     */
+    403: ErrorResponse;
+    /**
+     * 服务器内部错误
+     */
+    500: ErrorResponse;
+};
+export type GetApiChatSettingsError = GetApiChatSettingsErrors[keyof GetApiChatSettingsErrors];
+export type GetApiChatSettingsResponses = {
+    /**
+     * 成功
+     */
+    200: {
+        /**
+         * 业务码，成功为 0
+         */
+        code: number;
+        message: string;
+        data: ChatModuleSettings;
+    };
+};
+export type GetApiChatSettingsResponse = GetApiChatSettingsResponses[keyof GetApiChatSettingsResponses];
+export type PutApiChatSettingsData = {
+    body: {
+        systemPrompt?: string | null;
+        splitPrompt?: string | null;
+        splitQuery?: boolean | null;
+        scoreThreshold?: number | null;
+        lowScoreReply?: string | null;
+    };
+    path?: never;
+    query?: never;
+    url: '/api/chat/settings';
+};
+export type PutApiChatSettingsErrors = {
+    /**
+     * 请求参数无效
+     */
+    400: ErrorResponse;
+    /**
+     * 未登录
+     */
+    401: ErrorResponse;
+    /**
+     * 无权限
+     */
+    403: ErrorResponse;
+    /**
+     * 资源不存在
+     */
+    404: ErrorResponse;
+    /**
+     * 服务器内部错误
+     */
+    500: ErrorResponse;
+};
+export type PutApiChatSettingsError = PutApiChatSettingsErrors[keyof PutApiChatSettingsErrors];
+export type PutApiChatSettingsResponses = {
+    /**
+     * 成功
+     */
+    200: {
+        /**
+         * 业务码，成功为 0
+         */
+        code: number;
+        message: string;
+        data: ChatModuleSettings;
+    };
+};
+export type PutApiChatSettingsResponse = PutApiChatSettingsResponses[keyof PutApiChatSettingsResponses];
+export type GetApiChatConversationsData = {
+    body?: never;
+    path?: never;
+    query?: never;
+    url: '/api/chat/conversations';
+};
+export type GetApiChatConversationsErrors = {
+    /**
+     * 未登录
+     */
+    401: ErrorResponse;
+    /**
+     * 服务器内部错误
+     */
+    500: ErrorResponse;
+};
+export type GetApiChatConversationsError = GetApiChatConversationsErrors[keyof GetApiChatConversationsErrors];
+export type GetApiChatConversationsResponses = {
+    /**
+     * 成功
+     */
+    200: {
+        /**
+         * 业务码，成功为 0
+         */
+        code: number;
+        message: string;
+        data: Array<Conversation>;
+    };
+};
+export type GetApiChatConversationsResponse = GetApiChatConversationsResponses[keyof GetApiChatConversationsResponses];
+export type PostApiChatConversationsData = {
+    body?: {
+        title?: string;
+        systemPrompt?: string | null;
+        splitPrompt?: string | null;
+        splitQuery?: boolean | null;
+        scoreThreshold?: number | null;
+        lowScoreReply?: string | null;
+    };
+    path?: never;
+    query?: never;
+    url: '/api/chat/conversations';
+};
+export type PostApiChatConversationsErrors = {
+    /**
+     * 请求参数无效
+     */
+    400: ErrorResponse;
+    /**
+     * 未登录
+     */
+    401: ErrorResponse;
+    /**
+     * 无权限
+     */
+    403: ErrorResponse;
+    /**
+     * 资源不存在
+     */
+    404: ErrorResponse;
+    /**
+     * 服务器内部错误
+     */
+    500: ErrorResponse;
+};
+export type PostApiChatConversationsError = PostApiChatConversationsErrors[keyof PostApiChatConversationsErrors];
+export type PostApiChatConversationsResponses = {
+    /**
+     * 成功
+     */
+    201: {
+        /**
+         * 业务码，成功为 0
+         */
+        code: number;
+        message: string;
+        data: Conversation;
+    };
+};
+export type PostApiChatConversationsResponse = PostApiChatConversationsResponses[keyof PostApiChatConversationsResponses];
+export type DeleteApiChatConversationsByIdData = {
+    body?: never;
+    path: {
+        id: string;
+    };
+    query?: never;
+    url: '/api/chat/conversations/{id}';
+};
+export type DeleteApiChatConversationsByIdErrors = {
+    /**
+     * 请求参数无效
+     */
+    400: ErrorResponse;
+    /**
+     * 未登录
+     */
+    401: ErrorResponse;
+    /**
+     * 无权限
+     */
+    403: ErrorResponse;
+    /**
+     * 资源不存在
+     */
+    404: ErrorResponse;
+    /**
+     * 服务器内部错误
+     */
+    500: ErrorResponse;
+};
+export type DeleteApiChatConversationsByIdError = DeleteApiChatConversationsByIdErrors[keyof DeleteApiChatConversationsByIdErrors];
+export type DeleteApiChatConversationsByIdResponses = {
+    /**
+     * 成功
+     */
+    200: {
+        /**
+         * 业务码，成功为 0
+         */
+        code: number;
+        message: string;
+        data: null;
+    };
+};
+export type DeleteApiChatConversationsByIdResponse = DeleteApiChatConversationsByIdResponses[keyof DeleteApiChatConversationsByIdResponses];
+export type GetApiChatConversationsByIdData = {
+    body?: never;
+    path: {
+        id: string;
+    };
+    query?: never;
+    url: '/api/chat/conversations/{id}';
+};
+export type GetApiChatConversationsByIdErrors = {
+    /**
+     * 请求参数无效
+     */
+    400: ErrorResponse;
+    /**
+     * 未登录
+     */
+    401: ErrorResponse;
+    /**
+     * 无权限
+     */
+    403: ErrorResponse;
+    /**
+     * 资源不存在
+     */
+    404: ErrorResponse;
+    /**
+     * 服务器内部错误
+     */
+    500: ErrorResponse;
+};
+export type GetApiChatConversationsByIdError = GetApiChatConversationsByIdErrors[keyof GetApiChatConversationsByIdErrors];
+export type GetApiChatConversationsByIdResponses = {
+    /**
+     * 成功
+     */
+    200: {
+        /**
+         * 业务码，成功为 0
+         */
+        code: number;
+        message: string;
+        data: {
+            conversation: Conversation;
+            messages: Array<Message>;
+        };
+    };
+};
+export type GetApiChatConversationsByIdResponse = GetApiChatConversationsByIdResponses[keyof GetApiChatConversationsByIdResponses];
+export type PatchApiChatConversationsByIdData = {
+    body: {
+        title?: string;
+        systemPrompt?: string | null;
+        splitPrompt?: string | null;
+        splitQuery?: boolean | null;
+        scoreThreshold?: number | null;
+        lowScoreReply?: string | null;
+    };
+    path: {
+        id: string;
+    };
+    query?: never;
+    url: '/api/chat/conversations/{id}';
+};
+export type PatchApiChatConversationsByIdErrors = {
+    /**
+     * 请求参数无效
+     */
+    400: ErrorResponse;
+    /**
+     * 未登录
+     */
+    401: ErrorResponse;
+    /**
+     * 无权限
+     */
+    403: ErrorResponse;
+    /**
+     * 资源不存在
+     */
+    404: ErrorResponse;
+    /**
+     * 服务器内部错误
+     */
+    500: ErrorResponse;
+};
+export type PatchApiChatConversationsByIdError = PatchApiChatConversationsByIdErrors[keyof PatchApiChatConversationsByIdErrors];
+export type PatchApiChatConversationsByIdResponses = {
+    /**
+     * 成功
+     */
+    200: {
+        /**
+         * 业务码，成功为 0
+         */
+        code: number;
+        message: string;
+        data: Conversation;
+    };
+};
+export type PatchApiChatConversationsByIdResponse = PatchApiChatConversationsByIdResponses[keyof PatchApiChatConversationsByIdResponses];
+export type GetApiSearchData = {
+    body?: never;
+    path?: never;
+    query: {
+        /**
+         * 关键词
+         */
+        q: string;
+        limit?: number;
+    };
+    url: '/api/search';
+};
+export type GetApiSearchErrors = {
+    /**
+     * 请求参数无效
+     */
+    400: ErrorResponse;
+    /**
+     * 未登录
+     */
+    401: ErrorResponse;
+    /**
+     * 无权限
+     */
+    403: ErrorResponse;
+    /**
+     * 资源不存在
+     */
+    404: ErrorResponse;
+    /**
+     * 服务器内部错误
+     */
+    500: ErrorResponse;
+};
+export type GetApiSearchError = GetApiSearchErrors[keyof GetApiSearchErrors];
+export type GetApiSearchResponses = {
+    /**
+     * 成功
+     */
+    200: {
+        /**
+         * 业务码，成功为 0
+         */
+        code: number;
+        message: string;
+        data: Array<SearchHit>;
+    };
+};
+export type GetApiSearchResponse = GetApiSearchResponses[keyof GetApiSearchResponses];
+//# sourceMappingURL=types.gen.d.ts.map