@tais00/api 0.7.0

package/dist/api/index.d.ts

@@ -0,0 +1,604 @@
+import { IDifyAppItem, IDifyAppSiteSetting } from '@dify-chat/core';
+import { IAgentThought, IRetrieverResource } from './../types';
+import { IFileType } from './../types/file';
+/**
+ * 用户输入表单控件类型
+ */
+export type IUserInputFormItemType = 'text-input' | 'paragraph' | 'select' | 'number' | 'file' | 'file-list';
+/**
+ * 用户输入表单控件对象
+ */
+export interface IUserInputFormItemValueBase {
+    default: string;
+    label: string;
+    required: boolean;
+    hide?: boolean;
+    variable: string;
+    options?: string[];
+    /**
+     * 最大长度
+     */
+    max_length?: number;
+    type: IUserInputFormItemType;
+    allowed_file_types?: IFileType[];
+}
+/**
+ * 应用输入配置
+ */
+export type IUserInputForm = Record<IUserInputFormItemType, IUserInputFormItemValueBase>;
+/**
+ * 获取应用参数-响应体
+ */
+export interface IGetAppParametersResponse {
+    /**
+     * 开场白
+     */
+    opening_statement?: string;
+    /**
+     * 用户输入表单
+     */
+    user_input_form: IUserInputForm[];
+    /**
+     * 开场建议问题
+     */
+    suggested_questions?: string[];
+    /**
+     * 下一轮问题建议
+     */
+    suggested_questions_after_answer: {
+        /**
+         * 是否启用
+         */
+        enabled: boolean;
+    };
+    /**
+     * 文件上传参数
+     */
+    file_upload: {
+        /**
+         * 是否允许上传文件
+         */
+        enabled: boolean;
+        /**
+         * 允许上传的文件后缀名
+         */
+        allowed_file_extensions: string[];
+        /**
+         * 允许上传的文件类型
+         */
+        allowed_file_types: IFileType[];
+        /**
+         * 允许的上传方式 - remote_url-远程地址 local_file-本地文件
+         */
+        allowed_file_upload_methods: Array<'remote_url' | 'local_file'>;
+        /**
+         * 文件上传配置
+         */
+        fileUploadConfig: {
+            /**
+             * 文件大小限制（单位：MB）
+             */
+            file_size_limit: number;
+            /**
+             * 批量上传文件数量限制
+             */
+            batch_count_limit: number;
+            /**
+             * 图片文件大小限制（单位：MB）
+             */
+            image_file_size_limit: number;
+            /**
+             * 视频文件大小限制（单位：MB）
+             */
+            video_file_size_limit: number;
+            /**
+             * 音频文件大小限制（单位：MB）
+             */
+            audio_file_size_limit: number;
+            /**
+             * 工作流文件上传限制（单位：MB）
+             */
+            workflow_file_upload_limit: number;
+        };
+        /**
+         * 图片上传配置
+         */
+        image: {
+            /**
+             * 是否启用图片上传
+             */
+            enabled: false;
+            /**
+             * 允许上传的图片最大数量
+             */
+            number_limits: 3;
+            /**
+             * 允许的上传方式 - remote_url-远程地址 local_file-本地文件
+             */
+            transfer_methods: ['local_file', 'remote_url'];
+        };
+        /**
+         * 允许上传的文件数量
+         */
+        number_limits: number;
+    };
+    /**
+     * 文本转语音配置
+     */
+    text_to_speech: {
+        /**
+         * 是否启用
+         */
+        enabled: boolean;
+        /**
+         * 是否开启自动播放 enabled-启用 disabled-禁用
+         */
+        autoPlay: 'enabled' | 'disabled';
+        /**
+         * 语言
+         */
+        language: string;
+        /**
+         * 音色
+         */
+        voice: string;
+    };
+    /**
+     * 语音转文本配置
+     */
+    speech_to_text: {
+        /**
+         * 是否启用
+         */
+        enabled: boolean;
+    };
+}
+export interface IConversationItem {
+    created_at: number;
+    id: string;
+    inputs: Record<string, unknown>;
+    introduction: string;
+    name: string;
+    status: 'normal';
+    updated_at: number;
+}
+/**
+ * 获取工作流执行结果-响应体
+ */
+export interface IGetWorkflowResultResponse {
+    /** workflow 执行 ID */
+    id: string;
+    /** 关联的 Workflow ID */
+    workflow_id: string;
+    /** 执行状态 running / succeeded / failed / stopped */
+    status: string;
+    /** 任务输入内容 */
+    inputs: object;
+    /** 任务输出内容 */
+    outputs: object;
+    /** 错误原因 */
+    error: string;
+    /** 任务执行总步数 */
+    total_steps: number;
+    /** 任务执行总 tokens */
+    total_tokens: number;
+    /** 任务开始时间 */
+    created_at: number;
+    /** 任务结束时间 */
+    finished_at: number;
+    /** 耗时(s) */
+    elapsed_time: number;
+}
+/**
+ * 获取会话列表-参数
+ */
+interface IListConversationsRequest {
+    /**
+     * 返回条数
+     */
+    limit: number;
+}
+/**
+ * 获取会话列表-响应体
+ */
+interface IGetConversationListResponse {
+    data: IConversationItem[];
+}
+/**
+ * 消息文件所属类型
+ */
+export declare enum MessageFileBelongsToEnum {
+    'user' = "user",// 用户
+    'assistant' = "assistant"
+}
+/**
+ * 消息文件 Item 结构
+ */
+interface IMessageFileItem {
+    id: string;
+    filename: string;
+    type: string;
+    url: string;
+    mime_type: string;
+    size: number;
+    transfer_method: string;
+    belongs_to: MessageFileBelongsToEnum;
+    upload_file_id: string;
+}
+/**
+ * 会话历史 Item 结构
+ */
+interface IMessageItem {
+    /**
+     * 消息 ID
+     */
+    id: string;
+    /**
+     * 对话 ID
+     */
+    conversation_id: string;
+    /**
+     * 输入参数，键值对形式
+     */
+    inputs: Record<string, string>;
+    /**
+     * 问题
+     */
+    query: string;
+    /**
+     * 答案
+     */
+    answer: string;
+    /**
+     * 消息关联的文件列表
+     */
+    message_files?: IMessageFileItem[];
+    /**
+     * 消息反馈信息
+     */
+    feedback?: {
+        /**
+         * 反馈类型，like 表示点赞，dislike 表示点踩
+         */
+        rating: 'like' | 'dislike';
+    };
+    /**
+     * 消息状态，normal 表示正常，error 表示出错
+     */
+    status: 'normal' | 'error';
+    /**
+     * 错误信息，若消息状态为 error 时，该字段包含具体错误信息，否则为 null
+     */
+    error: string | null;
+    /**
+     * 智能体思考过程列表
+     */
+    agent_thoughts?: IAgentThought[];
+    /**
+     * 消息创建时间戳
+     */
+    created_at: number;
+    /**
+     * 知识库引用列表
+     */
+    retriever_resources?: IRetrieverResource[];
+}
+interface IListMessagesResponse {
+    data: IMessageItem[];
+    has_more: boolean;
+    limit: number;
+}
+export interface IDifyApiOptions {
+    /**
+     * 用户
+     */
+    user: string;
+    /**
+     * API 前缀，默认 https://api.dify.ai/v1
+     */
+    apiBase: string;
+    /**
+     * Dify APP API 密钥
+     */
+    apiKey: string;
+}
+export type IGetAppInfoResponse = IDifyAppItem['info'];
+export interface IGetAppMetaResponse {
+    tool_icons: {
+        dalle2: string;
+        api_tool: {
+            background: string;
+            content: string;
+        };
+    };
+}
+export interface IFileBase {
+    /**
+     * 文件类型
+     */
+    type: IFileType;
+}
+export interface IFileRemote extends IFileBase {
+    /**
+     * 传递方式 remote_url-远程地址 local_file-本地文件
+     */
+    transfer_method: 'remote_url';
+    /**
+     * 图片地址（仅当传递方式为 remote_url 时）
+     */
+    url?: string;
+}
+export interface IFileLocal extends IFileBase {
+    /**
+     * 传递方式 remote_url-远程地址 local_file-本地文件
+     */
+    transfer_method: 'local_file';
+    /**
+     * 上传文件 ID（仅当传递方式为 local_file 时）
+     */
+    upload_file_id?: string;
+}
+export type IFile = IFileRemote | IFileLocal;
+/**
+ * 上传文件接口详情
+ */
+export interface IUploadFileResponse {
+    id: string;
+    name: string;
+    size: number;
+    extension: string;
+    mime_type: string;
+    created_by: number;
+    created_at: number;
+}
+/**
+ * 语音转文字的响应
+ */
+export interface IAudio2TextResponse {
+    /**
+     * 生成的文本内容
+     */
+    text: string;
+}
+/**
+ * 创建标注请求参数
+ */
+export interface ICreateAnnotationRequest {
+    /**
+     * 问题
+     */
+    question: string;
+    /**
+     * 答案内容
+     */
+    answer: string;
+}
+/**
+ * 标注响应
+ */
+export interface IAnnotationItem {
+    id: string;
+    question: string;
+    answer: string;
+    hit_count: number;
+    created_at: number;
+}
+/**
+ * 获取标注列表请求参数
+ */
+export interface IGetAnnotationListRequest {
+    page?: number;
+    limit?: number;
+}
+/**
+ * 获取标注列表响应
+ */
+export interface IGetAnnotationListResponse {
+    data: IAnnotationItem[];
+    has_more: boolean;
+    limit: number;
+    total: number;
+    page: number;
+}
+/**
+ * 更新标注请求参数
+ */
+export interface IUpdateAnnotationRequest {
+    question: string;
+    answer: string;
+}
+/**
+ * Dify API 类
+ */
+export declare class DifyApi {
+    constructor(options: IDifyApiOptions);
+    options: IDifyApiOptions;
+    private baseRequest;
+    /**
+     * 更新 API 配置, 一般在切换应用时调用
+     */
+    updateOptions: (options: IDifyApiOptions) => void;
+    /**
+     * 获取应用基本信息
+     */
+    getAppInfo: () => Promise<{
+        name: string;
+        mode?: import("@dify-chat/core").AppModeEnums;
+        description: string;
+        tags: string[];
+    }>;
+    /**
+     * 获取应用 Meta 信息
+     */
+    getAppMeta: () => Promise<IGetAppMetaResponse>;
+    /**
+     * 获取应用参数
+     */
+    getAppParameters: () => Promise<IGetAppParametersResponse>;
+    /**
+     * 获取应用 WebAPP 设置
+     * @Limited Dify v1.4.0 版本开始支持
+     */
+    getAppSiteSetting: () => Promise<IDifyAppSiteSetting>;
+    /**
+     * 获取当前用户的会话列表（默认返回最近20条）
+     */
+    listConversations: (params?: IListConversationsRequest) => Promise<IGetConversationListResponse>;
+    /**
+     * 会话重命名
+     */
+    renameConversation: (params: {
+        /**
+         * 会话 ID
+         */
+        conversation_id: string;
+        /**
+         * 名称，若 auto_generate 为 true 时，该参数可不传。
+         */
+        name?: string;
+        /**
+         * 自动生成标题，默认 false
+         */
+        auto_generate?: boolean;
+    }) => Promise<unknown>;
+    /**
+     * 删除会话
+     */
+    deleteConversation: (conversation_id: string) => Promise<Response>;
+    /**
+     * 获取会话历史消息
+     */
+    listMessages: (conversation_id: string) => Promise<IListMessagesResponse>;
+    /**
+     * 发送对话消息
+     */
+    sendMessage: (params: {
+        /**
+         * 对话 ID
+         */
+        conversation_id?: string;
+        /**
+         * 输入参数
+         */
+        inputs: Record<string, string>;
+        /**
+         * 附件
+         */
+        files: IFile[];
+        /**
+         * 用户
+         */
+        user: string;
+        /**
+         * 响应模式
+         */
+        response_mode: "streaming";
+        /**
+         * 问题
+         */
+        query: string;
+    }) => Promise<Response>;
+    /**
+     * 停止对话流式响应
+     */
+    stopTask: (taskId: string) => Promise<unknown>;
+    /**
+     * 上传文件
+     */
+    uploadFile: (file: File) => Promise<IUploadFileResponse>;
+    /**
+     * 获取下一轮建议问题列表
+     */
+    getNextSuggestions: (params: {
+        /**
+         * 消息 ID
+         */
+        message_id: string;
+    }) => Promise<{
+        data: string[];
+    }>;
+    /**
+     * 消息反馈
+     */
+    createMessageFeedback: (params: {
+        /**
+         * 消息 ID
+         */
+        messageId: string;
+        /**
+         * 反馈类型 like-点赞 dislike-点踩 null-取消
+         */
+        rating: "like" | "dislike" | null;
+        /**
+         * 反馈内容
+         */
+        content: string;
+    }) => Promise<{
+        result: "success";
+    }>;
+    /**
+     * 文字转语音
+     */
+    text2Audio: (params: {
+        /**
+         * 消息 ID，优先级高于 text
+         */
+        message_id: string;
+    } | {
+        /**
+         * 文本内容
+         */
+        text: string;
+    }) => Promise<Response>;
+    /**
+     * 语音转文本
+     * @param file 语音文件。 支持格式：['mp3', 'mp4', 'mpeg', 'mpga', 'm4a', 'wav', 'webm'] 文件大小限制：15MB
+     */
+    audio2Text: (file: File) => Promise<IAudio2TextResponse>;
+    /**
+     * 执行 workflow
+     */
+    runWorkflow: (params: {
+        inputs: Record<string, IFile[] | unknown>;
+    }) => Promise<Response>;
+    /**
+     * 获取 workflow 执行情况
+     */
+    getWorkflowResult: (params: {
+        workflow_run_id: string;
+    }) => Promise<IGetWorkflowResultResponse>;
+    /**
+     * 执行文本生成
+     */
+    completion: (params: {
+        inputs: Record<string, IFile[] | unknown>;
+    }) => Promise<Response>;
+    /**
+     * 创建标注
+     */
+    createAnnotation: (params: ICreateAnnotationRequest) => Promise<IAnnotationItem>;
+    /**
+     * 获取标注列表
+     */
+    getAnnotationList: (params?: IGetAnnotationListRequest) => Promise<IGetAnnotationListResponse>;
+    /**
+     * 更新标注
+     */
+    updateAnnotation: (annotationId: string, params: IUpdateAnnotationRequest) => Promise<IAnnotationItem>;
+    /**
+     * 删除标注
+     */
+    deleteAnnotation: (annotationId: string) => Promise<Response>;
+    /**
+     * 获取文件预览
+     */
+    filePreview: (params: {
+        file_id: string;
+        as_attachment?: boolean;
+    }) => Promise<Response>;
+}
+/**
+ * 创建 Dify API 实例
+ */
+export declare const createDifyApiInstance: (options: IDifyApiOptions) => DifyApi;
+export {};

package/dist/base-request.d.ts

@@ -0,0 +1,22 @@
+/**
+ * 未授权错误类
+ */
+export declare class UnauthorizedError extends Error {
+    constructor(message: string);
+}
+export declare class XRequest {
+    constructor(options: {
+        baseURL: string;
+        apiKey: string;
+    });
+    options: {
+        baseURL: string;
+        apiKey: string;
+    };
+    baseRequest(url: string, options: RequestInit): Promise<Response>;
+    jsonRequest(url: string, options: RequestInit): Promise<unknown>;
+    get(url: string, params?: Record<string, string>, headers?: Record<string, string>): Promise<unknown>;
+    post(url: string, params?: Record<string, unknown>, headers?: Record<string, string>): Promise<unknown>;
+    delete(url: string, params?: Record<string, unknown>, headers?: Record<string, string>): Promise<Response>;
+}
+export default XRequest;

package/dist/enums/index.d.ts

@@ -0,0 +1,61 @@
+/**
+ * 对话接口流式输出事件类型列表
+ */
+export declare enum EventEnum {
+    /**
+     * 消息事件，代表普通消息的发送或接收
+     */
+    MESSAGE = "message",
+    /**
+     * 代理消息事件，代表代理发送的消息
+     */
+    AGENT_MESSAGE = "agent_message",
+    /**
+     * 代理思考事件，代表代理在处理过程中的思考信息
+     */
+    AGENT_THOUGHT = "agent_thought",
+    /**
+     * 消息文件事件，代表与消息相关的文件信息
+     */
+    MESSAGE_FILE = "message_file",
+    /**
+     * 消息结束事件，代表一条消息的处理结束
+     */
+    MESSAGE_END = "message_end",
+    /**
+     * TTS 消息事件，代表文本转语音的消息
+     */
+    TTS_MESSAGE = "tts_message",
+    /**
+     * TTS 消息结束事件，代表文本转语音消息的处理结束
+     */
+    TTS_MESSAGE_END = "tts_message_end",
+    /**
+     * 消息替换事件，代表对已有消息的替换操作
+     */
+    MESSAGE_REPLACE = "message_replace",
+    /**
+     * 错误事件，代表系统出现错误的情况
+     */
+    ERROR = "error",
+    /**
+     * 心跳事件，用于保持连接或检测服务状态
+     */
+    PING = "ping",
+    /**
+     * 工作流开始事件，代表工作流开始执行
+     */
+    WORKFLOW_STARTED = "workflow_started",
+    /**
+     * 工作流结束事件，代表工作流执行完成
+     */
+    WORKFLOW_FINISHED = "workflow_finished",
+    /**
+     * 工作流节点开始事件，代表工作流中的某个节点开始执行
+     */
+    WORKFLOW_NODE_STARTED = "node_started",
+    /**
+     * 工作流节点结束事件，代表工作流中的某个节点执行完成
+     */
+    WORKFLOW_NODE_FINISHED = "node_finished"
+}