@satorijs/adapter-lark 3.10.6 → 3.11.0

package/lib/types/aily.d.ts

@@ -1,221 +1,336 @@
-import { AilyKnowledgeAskProcessData, AilyKnowledgeFaq, AilyKnowledgeMessage, AilyMention, AilyMessage, AilyMessageContentType, AilySession, DataAsset, DataAssetTag, Run, Skill, SkillGlobalVariable } from '.';
-import { Pagination } from '../internal';
+import * as Lark from '.';
+import { Paginated, Pagination } from '../internal';
 declare module '../internal' {
     interface Internal {
-        /**
-         * 创建会话
-         * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/aily_session/create
-         */
-        createAilyAilySession(body: CreateAilyAilySessionRequest): Promise<CreateAilyAilySessionResponse>;
-        /**
-         * 更新会话
-         * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/aily_session/update
-         */
-        updateAilyAilySession(aily_session_id: string, body: UpdateAilyAilySessionRequest): Promise<UpdateAilyAilySessionResponse>;
-        /**
-         * 获取会话
-         * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/aily_session/get
-         */
-        getAilyAilySession(aily_session_id: string): Promise<GetAilyAilySessionResponse>;
-        /**
-         * 删除会话
-         * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/aily_session/delete
-         */
-        deleteAilyAilySession(aily_session_id: string): Promise<void>;
-        /**
-         * 发送智能伙伴消息
-         * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/aily_session-aily_message/create
-         */
-        createAilyAilySessionAilyMessage(aily_session_id: string, body: CreateAilyAilySessionAilyMessageRequest): Promise<CreateAilyAilySessionAilyMessageResponse>;
-        /**
-         * 获取智能伙伴消息
-         * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/aily_session-aily_message/get
-         */
-        getAilyAilySessionAilyMessage(aily_session_id: string, aily_message_id: string): Promise<GetAilyAilySessionAilyMessageResponse>;
-        /**
-         * 列出智能伙伴消息
-         * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/aily_session-aily_message/list
-         */
-        listAilyAilySessionAilyMessage(aily_session_id: string, query?: ListAilyAilySessionAilyMessageQuery): Paginated<AilyMessage, 'messages'>;
-        /**
-         * 创建运行
-         * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/aily_session-run/create
-         */
-        createAilyAilySessionRun(aily_session_id: string, body: CreateAilyAilySessionRunRequest): Promise<CreateAilyAilySessionRunResponse>;
-        /**
-         * 获取运行
-         * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/aily_session-run/get
-         */
-        getAilyAilySessionRun(aily_session_id: string, run_id: string): Promise<GetAilyAilySessionRunResponse>;
-        /**
-         * 列出运行
-         * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/aily_session-run/list
-         */
-        listAilyAilySessionRun(aily_session_id: string, query?: Pagination): Paginated<Run, 'runs'>;
-        /**
-         * 取消运行
-         * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/aily_session-run/cancel
-         */
-        cancelAilyAilySessionRun(aily_session_id: string, run_id: string): Promise<CancelAilyAilySessionRunResponse>;
-        /**
-         * 调用技能
-         * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/app-skill/start
-         */
-        startAilyAppSkill(app_id: string, skill_id: string, body: StartAilyAppSkillRequest): Promise<StartAilyAppSkillResponse>;
-        /**
-         * 获取技能信息
-         * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/app-skill/get
-         */
-        getAilyAppSkill(app_id: string, skill_id: string): Promise<GetAilyAppSkillResponse>;
-        /**
-         * 查询技能列表
-         * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/app-skill/list
-         */
-        listAilyAppSkill(app_id: string, query?: Pagination): Paginated<Skill, 'skills'>;
-        /**
-         * 执行数据知识问答
-         * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/app-knowledge/ask
-         */
-        askAilyAppKnowledge(app_id: string, body: AskAilyAppKnowledgeRequest): Promise<AskAilyAppKnowledgeResponse>;
-        /**
-         * 查询数据知识列表
-         * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/app-data_asset/list
-         */
-        listAilyAppDataAsset(app_id: string, query?: ListAilyAppDataAssetQuery): Paginated<DataAsset>;
-        /**
-         * 获取数据知识分类列表
-         * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/app-data_asset_tag/list
-         */
-        listAilyAppDataAssetTag(app_id: string, query?: ListAilyAppDataAssetTagQuery): Paginated<DataAssetTag>;
+        aily: Aily.Methods;
     }
 }
-export interface CreateAilyAilySessionRequest {
-    /** 渠道上下文 */
-    channel_context?: string;
-    /** 其他透传信息 */
-    metadata?: string;
-}
-export interface CreateAilyAilySessionResponse {
-    /** 创建的会话信息 */
-    session?: AilySession;
-}
-export interface UpdateAilyAilySessionRequest {
-    /** 渠道上下文 */
-    channel_context?: string;
-    /** 其他透传信息 */
-    metadata?: string;
-}
-export interface UpdateAilyAilySessionResponse {
-    /** 会话信息 */
-    session?: AilySession;
-}
-export interface GetAilyAilySessionResponse {
-    /** 会话信息 */
-    session?: AilySession;
-}
-export interface CreateAilyAilySessionAilyMessageRequest {
-    /** 幂等id，同一 session 下相同的幂等 id 算一条消息，有效期72h */
-    idempotent_id: string;
-    /** 消息内容类型 */
-    content_type: AilyMessageContentType;
-    /** 消息内容 */
-    content: string;
-    /** 消息中包含的文件 ID 列表 */
-    file_ids?: string[];
-    /** 引用的消息 ID */
-    quote_message_id?: string;
-    /** 被@的实体 */
-    mentions?: AilyMention[];
-}
-export interface CreateAilyAilySessionAilyMessageResponse {
-    /** 消息信息 */
-    message?: AilyMessage;
-}
-export interface GetAilyAilySessionAilyMessageResponse {
-    /** 消息信息 */
-    message?: AilyMessage;
-}
-export interface ListAilyAilySessionAilyMessageQuery extends Pagination {
-    /** 运行 ID */
-    run_id?: string;
-    /** 返回生成中的消息 */
-    with_partial_message?: boolean;
-}
-export interface CreateAilyAilySessionRunRequest {
-    /** 应用 ID */
-    app_id: string;
-    /** 技能 ID */
-    skill_id?: string;
-    /** 指定技能 ID 时可以同时指定技能输入 */
-    skill_input?: string;
-    /** 其他透传信息 */
-    metadata?: string;
-}
-export interface CreateAilyAilySessionRunResponse {
-    /** 运行信息 */
-    run?: Run;
-}
-export interface GetAilyAilySessionRunResponse {
-    /** 运行信息 */
-    run?: Run;
-}
-export interface CancelAilyAilySessionRunResponse {
-    /** 运行信息 */
-    run?: Run;
-}
-export interface StartAilyAppSkillRequest {
-    /** 技能的全局变量 */
-    global_variable?: SkillGlobalVariable;
-    /** 技能的自定义变量 */
-    input?: string;
-}
-export interface StartAilyAppSkillResponse {
-    /** 技能的输出 */
-    output?: string;
-    /** 技能的执行状态 */
-    status?: string;
-}
-export interface GetAilyAppSkillResponse {
-    /** 技能信息 */
-    skill?: Skill;
-}
-export interface AskAilyAppKnowledgeRequest {
-    /** 输入消息（当前仅支持纯文本输入） */
-    message: AilyKnowledgeMessage;
-    /** 控制知识问答所依据的数据知识范围 */
-    data_asset_ids?: string[];
-    /** 控制知识问答所依据的数据知识分类范围 */
-    data_asset_tag_ids?: string[];
-}
-export interface AskAilyAppKnowledgeResponse {
-    /** 响应状态，枚举值 */
-    status?: 'processing' | 'finished';
-    /** 结束类型，枚举值 */
-    finish_type?: 'qa' | 'faq';
-    /** 响应消息 */
-    message?: AilyKnowledgeMessage;
-    /** 知识问答运行过程结构化数据，status=finished 且 finish_type=qa 时返回 */
-    process_data?: AilyKnowledgeAskProcessData;
-    /** 匹配标准问答对结果，status=finished 且 finish_type=faq时返回 */
-    faq_result?: AilyKnowledgeFaq;
-    /** 是否有结果，true 则 代表 message 中的内容是通过配置知识而生成的 */
-    has_answer?: boolean;
-}
-export interface ListAilyAppDataAssetQuery extends Pagination {
-    /** 模糊匹配关键词 */
-    keyword?: string;
-    /** 根据数据知识 ID 进行过滤 */
-    data_asset_ids?: string[];
-    /** 根据数据知识分类 ID 进行过滤 */
-    data_asset_tag_ids?: string[];
-    /** 结果是否包含数据与知识项目 */
-    with_data_asset_item?: boolean;
-    /** 结果是否包含数据连接状态 */
-    with_connect_status?: boolean;
-}
-export interface ListAilyAppDataAssetTagQuery extends Pagination {
-    /** 模糊匹配分类名称 */
-    keyword?: string;
-    /** 模糊匹配分类名称 */
-    data_asset_tag_ids?: string[];
+export declare namespace Aily {
+    interface Methods {
+        ailySession: AilySession.Methods;
+        app: App.Methods;
+    }
+    namespace AilySession {
+        interface Methods {
+            ailyMessage: AilyMessage.Methods;
+            run: Run.Methods;
+            /**
+             * 创建会话
+             * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/aily_session/create
+             */
+            create(body: CreateRequest): Promise<CreateResponse>;
+            /**
+             * 更新会话
+             * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/aily_session/update
+             */
+            update(aily_session_id: string, body: UpdateRequest): Promise<UpdateResponse>;
+            /**
+             * 获取会话
+             * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/aily_session/get
+             */
+            get(aily_session_id: string): Promise<GetResponse>;
+            /**
+             * 删除会话
+             * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/aily_session/delete
+             */
+            delete(aily_session_id: string): Promise<void>;
+        }
+        interface CreateRequest {
+            /** 渠道上下文 */
+            channel_context?: string;
+            /** 其他透传信息 */
+            metadata?: string;
+        }
+        interface CreateResponse {
+            /** 创建的会话信息 */
+            session?: Lark.AilySession;
+        }
+        interface UpdateRequest {
+            /** 渠道上下文 */
+            channel_context?: string;
+            /** 其他透传信息 */
+            metadata?: string;
+        }
+        interface UpdateResponse {
+            /** 会话信息 */
+            session?: Lark.AilySession;
+        }
+        interface GetResponse {
+            /** 会话信息 */
+            session?: Lark.AilySession;
+        }
+        namespace AilyMessage {
+            interface Methods {
+                /**
+                 * 发送智能伙伴消息
+                 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/aily_session-aily_message/create
+                 */
+                create(aily_session_id: string, body: CreateRequest): Promise<CreateResponse>;
+                /**
+                 * 获取智能伙伴消息
+                 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/aily_session-aily_message/get
+                 */
+                get(aily_session_id: string, aily_message_id: string): Promise<GetResponse>;
+                /**
+                 * 列出智能伙伴消息
+                 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/aily_session-aily_message/list
+                 */
+                list(aily_session_id: string, query?: ListQuery): Paginated<Lark.AilyMessage, 'messages'>;
+            }
+            interface CreateRequest {
+                /** 幂等id，同一 session 下相同的幂等 id 算一条消息，有效期72h */
+                idempotent_id: string;
+                /** 消息内容类型 */
+                content_type: Lark.AilyMessageContentType;
+                /** 消息内容 */
+                content: string;
+                /** 消息中包含的文件 ID 列表 */
+                file_ids?: string[];
+                /** 引用的消息 ID */
+                quote_message_id?: string;
+                /** 被@的实体 */
+                mentions?: Lark.AilyMention[];
+            }
+            interface CreateResponse {
+                /** 消息信息 */
+                message?: Lark.AilyMessage;
+            }
+            interface GetResponse {
+                /** 消息信息 */
+                message?: Lark.AilyMessage;
+            }
+            interface ListQuery extends Pagination {
+                /** 运行 ID */
+                run_id?: string;
+                /** 返回生成中的消息 */
+                with_partial_message?: boolean;
+            }
+        }
+        namespace Run {
+            interface Methods {
+                /**
+                 * 创建运行
+                 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/aily_session-run/create
+                 */
+                create(aily_session_id: string, body: CreateRequest): Promise<CreateResponse>;
+                /**
+                 * 获取运行
+                 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/aily_session-run/get
+                 */
+                get(aily_session_id: string, run_id: string): Promise<GetResponse>;
+                /**
+                 * 列出运行
+                 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/aily_session-run/list
+                 */
+                list(aily_session_id: string, query?: Pagination): Paginated<Lark.Run, 'runs'>;
+                /**
+                 * 取消运行
+                 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/aily_session-run/cancel
+                 */
+                cancel(aily_session_id: string, run_id: string): Promise<CancelResponse>;
+            }
+            interface CreateRequest {
+                /** 应用 ID */
+                app_id: string;
+                /** 技能 ID */
+                skill_id?: string;
+                /** 指定技能 ID 时可以同时指定技能输入 */
+                skill_input?: string;
+                /** 其他透传信息 */
+                metadata?: string;
+            }
+            interface CreateResponse {
+                /** 运行信息 */
+                run?: Lark.Run;
+            }
+            interface GetResponse {
+                /** 运行信息 */
+                run?: Lark.Run;
+            }
+            interface CancelResponse {
+                /** 运行信息 */
+                run?: Lark.Run;
+            }
+        }
+    }
+    namespace App {
+        interface Methods {
+            skill: Skill.Methods;
+            knowledge: Knowledge.Methods;
+            dataAsset: DataAsset.Methods;
+            dataAssetTag: DataAssetTag.Methods;
+        }
+        namespace Skill {
+            interface Methods {
+                /**
+                 * 调用技能
+                 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/app-skill/start
+                 */
+                start(app_id: string, skill_id: string, body: StartRequest): Promise<StartResponse>;
+                /**
+                 * 获取技能信息
+                 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/app-skill/get
+                 */
+                get(app_id: string, skill_id: string): Promise<GetResponse>;
+                /**
+                 * 查询技能列表
+                 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/app-skill/list
+                 */
+                list(app_id: string, query?: Pagination): Paginated<Lark.Skill, 'skills'>;
+            }
+            interface StartRequest {
+                /** 技能的全局变量 */
+                global_variable?: Lark.SkillGlobalVariable;
+                /** 技能的自定义变量 */
+                input?: string;
+            }
+            interface StartResponse {
+                /** 技能的输出 */
+                output?: string;
+                /** 技能的执行状态 */
+                status?: string;
+            }
+            interface GetResponse {
+                /** 技能信息 */
+                skill?: Lark.Skill;
+            }
+        }
+        namespace Knowledge {
+            interface Methods {
+                /**
+                 * 执行数据知识问答
+                 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/app-knowledge/ask
+                 */
+                ask(app_id: string, body: AskRequest): Promise<AskResponse>;
+            }
+            interface AskRequest {
+                /** 输入消息（当前仅支持纯文本输入） */
+                message: Lark.AilyKnowledgeMessage;
+                /** 控制知识问答所依据的数据知识范围 */
+                data_asset_ids?: string[];
+                /** 控制知识问答所依据的数据知识分类范围 */
+                data_asset_tag_ids?: string[];
+            }
+            interface AskResponse {
+                /** 响应状态，枚举值 */
+                status?: 'processing' | 'finished';
+                /** 结束类型，枚举值 */
+                finish_type?: 'qa' | 'faq';
+                /** 响应消息 */
+                message?: Lark.AilyKnowledgeMessage;
+                /** 知识问答运行过程结构化数据，status=finished 且 finish_type=qa 时返回 */
+                process_data?: Lark.AilyKnowledgeAskProcessData;
+                /** 匹配标准问答对结果，status=finished 且 finish_type=faq时返回 */
+                faq_result?: Lark.AilyKnowledgeFaq;
+                /** 是否有结果，true 则 代表 message 中的内容是通过配置知识而生成的 */
+                has_answer?: boolean;
+            }
+        }
+        namespace DataAsset {
+            interface Methods {
+                /**
+                 * 上传文件用于数据知识管理
+                 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/app-data_asset/upload_file
+                 */
+                uploadFile(app_id: string, form: UploadFileForm, query?: UploadFileQuery): Promise<UploadFileResponse>;
+                /**
+                 * 创建数据知识
+                 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/app-data_asset/create
+                 */
+                create(app_id: string, body: CreateRequest, query?: CreateQuery): Promise<CreateResponse>;
+                /**
+                 * 获取数据知识
+                 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/app-data_asset/get
+                 */
+                get(app_id: string, data_asset_id: string, query?: GetQuery): Promise<GetResponse>;
+                /**
+                 * 删除数据知识
+                 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/app-data_asset/delete
+                 */
+                delete(app_id: string, data_asset_id: string, query?: DeleteQuery): Promise<DeleteResponse>;
+                /**
+                 * 查询数据知识列表
+                 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/app-data_asset/list
+                 */
+                list(app_id: string, query?: ListQuery): Paginated<Lark.DataAsset>;
+            }
+            interface UploadFileForm {
+                /** 需要上传的文件 */
+                file: Blob;
+            }
+            interface UploadFileQuery {
+                /** 应用环境，默认为线上环境，dev代表开发环境，只支持dev */
+                tenant_type?: string;
+            }
+            interface UploadFileResponse {
+                /** 数据知识文件 */
+                file_info?: Lark.DataAssetFile;
+            }
+            interface CreateRequest {
+                /** 连接类型 */
+                connect_type: 'import' | 'direct';
+                /** 数据源类型 */
+                source_type: 'file' | 'lark_wiki_space' | 'lark_doc' | 'lark_helpdesk';
+                /** 知识导入配置 */
+                import_knowledge_setting?: Lark.DataAssetImportKnowledgeSetting;
+                /** 数据知识描述信息 */
+                description?: Record<string, string>;
+            }
+            interface CreateQuery {
+                /** 应用环境，默认为线上环境，dev代表开发环境，只支持dev */
+                tenant_type?: string;
+            }
+            interface CreateResponse {
+                /** 数据知识 */
+                data_asset?: Lark.DataAsset;
+            }
+            interface GetQuery {
+                /** 结果是否包含数据与知识项 */
+                with_data_asset_item?: boolean;
+                /** 结果是否包含数据知识连接状态 */
+                with_connect_status?: boolean;
+                /** 应用环境，默认为线上环境，dev代表开发环境 */
+                tenant_type?: string;
+            }
+            interface GetResponse {
+                /** 数据知识 */
+                data_asset?: Lark.DataAsset;
+            }
+            interface DeleteQuery {
+                /** 应用环境，默认为线上环境，dev代表开发环境，只支持dev */
+                tenant_type?: string;
+            }
+            interface DeleteResponse {
+                /** 数据知识 */
+                data_asset?: Lark.DataAsset;
+            }
+            interface ListQuery extends Pagination {
+                /** 模糊匹配关键词 */
+                keyword?: string;
+                /** 根据数据知识 ID 进行过滤 */
+                data_asset_ids?: string[];
+                /** 根据数据知识分类 ID 进行过滤 */
+                data_asset_tag_ids?: string[];
+                /** 结果是否包含数据与知识项目 */
+                with_data_asset_item?: boolean;
+                /** 结果是否包含数据连接状态 */
+                with_connect_status?: boolean;
+            }
+        }
+        namespace DataAssetTag {
+            interface Methods {
+                /**
+                 * 获取数据知识分类列表
+                 * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/app-data_asset_tag/list
+                 */
+                list(app_id: string, query?: ListQuery): Paginated<Lark.DataAssetTag>;
+            }
+            interface ListQuery extends Pagination {
+                /** 模糊匹配分类名称 */
+                keyword?: string;
+                /** 模糊匹配分类名称 */
+                data_asset_tag_ids?: string[];
+            }
+        }
+    }
 }