这是本节的多页打印视图。 点击此处打印.

返回本页常规视图.

AISE服务基座

AISE服务基座为企业引入AI大模型能力提供一系列基础能力,包括模多模型适配器、提示词仓库、向量引擎和向量数据库、AI代理(Agent)编排和运行引擎等。通过AISE服务基座,企业可以快速引入AI大模型能力,实现业务场景的智能化升级。

1 - 用户登陆

支持普通的帐号密码登陆和sso等第三方的登陆。企业管理员使用内置管理帐号 aise-admin登陆。

用户登陆

支持普通的帐号密码登陆和sso等第三方的登陆。企业管理员使用内置管理帐号 aise-admin登陆。另外aise还内置了一个普通用户:aise-user, 在刚部署完成后可以使用此帐号登陆。

登录

2 - 用户、部门和角色管理

为了进行更好的权限管理以及分组,可以将企业的组织架构映射到AISE的部门和用户组中,并可以根据用户、部门、用户组配置对应的权限。

1. 创建用户

管理员需要在AISE的管理端创建用户,并分配给用户账号密码。

  1. 点击系统管理 | 用户管理 | 新增 用户管理
  2. 输入用户昵称、用户账号、归属部门以及密码。 创建用户

2. 创建部门

为了进行更好的权限管理以及分组,可以将企业的组织架构映射到AISE的部门中,并可以根据部门配置对应的权限。

  1. 点击系统管理 | 部门管理 | 添加部门 部门管理

  2. 输入上级部门,部门名称

添加部门

3. 用户管理

内置用户和角色管理能力,并支持用户的部门分配和角色分配。

用户管理

4. 用户组管理

为了进行更好的权限管理以及分组,可以将企业的组织架构映射到AISE的用户组中,并可以根据用户组配置对应的权限。

  1. 点击系统管理|用户组管理|新增 用户组管理
  2. 输入用户组名称、Azure用户组Id(Azure Group ID,选输)及备注 新增用户组
  3. 点击系统管理|用户组管理|用户组名称 用户组列表
  4. 选择用户,点击确认按钮,关联用户成功 关联用户组
  5. 用户组访问权限配置
    1. AISE管理|模型适配器|修改 模型适配器
    2. 选择访问范围和用户组 修改模型适配器

用户组除了在AISE系统新增外,用户通过Oatuh2登录时,也会同步用户的组信息到AIS系统中,如果用户已创建过auzre用户组,则直接关联到当前组中。 同步azure用户组必须有Team.ReadBasic.All权限。

3 - 统一身份认证

AISE门户登录页面用作所有AISE应用程序和插件的中央身份验证点,为用户提供熟悉且简化的登录体验,消除了需要为每个单独的应用程序重复输入密码的需求;通过标准化OAuth2集成企业现有身份认证系统。

将AISE门户登录页面用作所有AISE应用程序和插件的中央身份验证点,为用户提供熟悉且简化的登录体验,消除了需要为每个单独的应用程序重复输入密码的需求;通过标准化OAuth2集成企业现有身份认证系统。 统一身份认证

4 - 模型适配器

AISE的模型能力层具备模型训练,微调以及对模型资产进行版本管理和变更管理的能力,确保可以为企业的大模型战略提供完整支撑

1. 基本模型能力

当前市场上的各类大模型层出不穷,企业的大模型战略需要适应市场的快速变化,确保引入到企业的模型可以灵活的适配各种场景,并且可以满足企业内部复杂组织架构、权限、安全性、审计等要求。同时,企业还需要根据内部的个性化需求对模型本身进行适配和调整,因此需要平台具备模型训练,微调以及对模型资产进行版本管理和变更管理的能力。

AISE的模型能力层提供以下能力,确保可以为企业的大模型战略提供完整支撑

  • 多厂商适配:内置对市场主流大模型厂商的介入支撑,包括:微软Azure OpenAI, DeepSeek深度求索,Llama,HuggineFace,阿里通义大模型,华为和百川智能 。

  • SaaS服务和私有部署支持:支持通过SaaS API和私有部署方式介入以上厂商的大模型服务。

  • 推理服务通用接口支持:支持通过VLLM,TGI和OpenAI标准接口提供的推理服务 。

  • 英伟达Nvidia GPU支持:用户可以选择Nvidia A100,A800,A10,L20以及4090系列GPU作为私有部署的硬件算力。

  • 国产华为晟腾系列NPU:用户可以选择晟腾系列NPU作为私有部署硬件算力,包括:晟腾910A/B系列,晟腾310系列;并支持多卡并行推理配置。

  • 参数可视化配置:支持对模型常用参数进行可视化配置,用户管理员可以通过模型适配器界面完成模型参数的配置,内置标准化参数支持和个性化参数注入。

  • 多实例负载均衡:用户可以为同一个模型实例添加多个子实例,AISE模型适配器自动针对多个子实例提供流量分配,为用户提供模型实例的横向扩展能力。

  • 模型路由能力:支持按模型类型、按组织单位、按应用场景进行模型路由分配 。

  • 组织架构路由:支持针对不同部门提供不同的模型实例,支持在统一场景下为不同组织单位提供不同的模型路由,比如:同样是代码补全服务,可以为不同开发小组分配不同的代码补全模型。

  • 按场景进行模型路由:针对代码补全、代码对话、通用代码任务,如:代码解释、代码纠错,代码评审、单元测试 生成等不同任务提供不同的模型路由。

  • 增强型模型密钥验证能力:在使用Azure OpenAI的模型服务时,支持通过Service Principle的方式进行服务端身份验证,并动态获取模型密钥(access token),此密钥在一定时间内自动过期,提供更高的安全性和企业可管理性。

  • 支持在固定代码任务中使用FIM模式:FIM(Fill in the Middle)是一种特殊的生成模式,通过对前文和后文的同时推理提供更优化的模型生成控制,一般用户代码生成任务。AISE不仅代码生成任务上提供FIM能力,同时也支持在通用代码任务(代码解释、代码纠错,代码评审、单元测试)上使用FIM能力。

模型支持列表

AISE模型适配器内置对以下厂商和模型提供开箱即用的接入能力。

# 提供商 商用 / 开源 接入方式 模型名称 备注
1 微软 商用 SaaS API GPT 3.5 Turbo
GPT 3.5 Turbo 16K
GPT 3.5 Turbo Instruct
GPT 4.0
GPT 4.0 32K
GPT 4.0 128K
GPT 4o 多模态支持
GPT 4o mini 多模态支持
text-davinci-003
text-embedding-ada-002
text-embedding-3
2 深度求索 商用 SaaS API DeepSeek Coder
DeepSeek Chat
DeepSeek v2 Coder
DeepSeek v2
3 深度求索 开源 私有部署 DeepSeek Coder 6.7 Base 晟腾/英伟达
DeepSeek Chat 6.7 Instruct 晟腾/英伟达
DeepSeek Coder 33B Base 晟腾/英伟达
DeepSeek Chat 33B Instruct 晟腾/英伟达
4 阿里巴巴 开源 私有部署 Qwen1.5 72B 晟腾/英伟达
Qwen1.5 72B 晟腾/英伟达
5 微软 开源 私有部署 WizardCoder15B 英伟达
6 Jinna 开源 私有部署 jina-embeddings-v2-base-zh
jina-embeddings-v2-base-code

2. 模型全局配置

模型配置完成后,需要对AISE进行模型全局配置,来配置智能对话中可以使用的模型,代码补全中可以使用的模型,向量化模型等等。

  1. 点击系统管理 |参数设置 | 找到参数名称为“全局配置-模型” 的参数 全局配置

  2. 修改配置,配置如下: 修改配置

    详细介绍:

      "chat_model_types":[
          "completion_azure_gpt",
          "completion_azure_gpt35_16k",
          "completion_azure_gpt4",
          "completion_azure_gpt4_32k",
          "completion_azure_gpt4_128k",
          "completion_deepseek_chat"
        ],
      "embedding_model_type":   "embedding_azure_text-embedding-ada-002",
      "code_completion_model_types": [
          "codecompletion_azure_text-davinci-003"
        ],
      "task_configuration":{
          "chat_model":{
              "use_current_chat_model":"false",
              "task_method_chat_model_type":"completion_azure_gpt35_16k"
            },
          "completion_model":{
            "task_method_completion_model_type":"completion_azure_text-davinci-003"
            }
        }
    }
    

    参数说明

    参数 说明
    chat_model_types 代码对话可以使用的模型列表
    embedding_model_type 指定向量化模型
    code_completion_model_types 指定代码补全模型
    task_method_chat_model_type 指定提示词模版为对话类型时使用的模型
    task_method_completion_model_type 指定提示词模版为完成类型时使用的模型

3. 添加模型

将企业内选型的模型通过模型适配器,添加到AISE中,并在具体的AI应用场景中使用这些模型。添加方式如下:

  1. 点击AISE管理 | 模型适配器  模型适配器

  2. 输入模型标识 | 模型类型 | 模型参数 | 配置项 添加模型

    参数
    模型类型 下拉列表选择
    模型参数 {“temperature”:“0.7”,“max_tokens”:“800”,“top_p”:“0.95”,“frequency_penalty”:“0”,“presence_penalty”:“0”,“stop”:"",“chunk_size”:""}
    配置项 {“API_KEY”: “”,“ServiceEndPoint”: “”,“ApiVersion”: “2023-03-15-preview”,“deploymentName”: “”}

4. 启用多实例

通过启用多实例的方式来对流量进行不同模型实例的分发,适用于用户量比较大的企业

  1. 启用 “是否有实例” 启用实例
  2. 点击添加配置项 添加配置项
  3. 输入其他实例配置项信息 输入配置项信息

5. 模型权限配置

对模型进行访问权限控制,支持公开模型,以及按部门划分模型访问权限。

访问权限控制

部门权限

4.1 - Qwen2.5模型适配

Qwen2.5模型适配

特性说明

orch服务增加对Qwen2.5模型的适配,适配后,通过配置,可用Qwen2.5模型进行chat对话,代码补全,提示词。

操作指引

新增模型类型 用途说明

  1. completion_qwen_chat

    用途:适用于提供对话能力的模型 适用模型:qwen2.5-14b、qwen2.5-72b-instruct、Qwen2.5_Coder_32B_Instruct
  2. codecompletion_qwen_coder

    用途:适用于提供代码补全能力的模型 适用模型:qwen2.5-14b、qwen2.5-72b-instruct、Qwen2.5_Coder_32B_Instruct
  3. completion_qwen_completion

    用途:适用于对完成模式提示词进行解释的模型 适用模型:qwen2.5-14b、qwen2.5-72b-instruct、Qwen2.5_Coder_32B_Instruct

配置模型适配器

  1. 新增模型适配器时的参数说明:

1.1 模型适配器参数说明
参数名称 示例数据 取值范围 说明
模型标识 Qwen2.5_72B_Chat_Saas 任意字符串 模型唯一标识
模型名称 Qwen2.5 72B Saas 任意字符串 模型对外展示的名称
模型关键字 Chat Chat/Completion 标记模型是对话能力还是补全能力
模型版本 2.5 任意字符串 部署模型的版本
模型类型 completion_qwen_chat 模型类型列表数据 参照 新增模型类型用途说明
状态 有效 有效/无效 模型是否可用
访问范围 公开 公开/部门 模型设置访问权限
模型参数 {“repetition_penalty”:1, “temperature”:0.2, “max_tokens”:800, “top_p”:0.95, “token_limit”:8192, “token_limit_safebuffer”:200} JSON格式 详见 1.2 模型参数说明,模型的默认参数配置。
配置项 { “API_KEY”: “sk-123456”, “ServiceEndPoint”: “”, “ApiVersion”: “”, “deploymentName”:“qwen2.5-14b”} JSON格式 详见 1.3 配置项参数说明,模型的基本信息配置
1.2 模型参数说明
参数名称 默认取值 取值范围 说明
temperature 0.2 [0, 2) 用于控制模型回复的随机性和多样性。
max_tokens 800 小于模型输出最大长度 指定模型可生成的最大token个数。
presence_penalty 0 [-2.0, 2.0] 用于控制模型生成时整个序列中的重复度。
top_p 0.95 (0,1.0) 生成过程中的核采样方法概率阈值。
token_limit 10240 与模型相关 配置最大token数,一般与模型相关。
token_limit_safebuffer 200 200 token最大安全缓冲区。
stop - - stop参数用于实现内容生成过程的精确控制,在模型生成的内容即将包含指定的字符串或token_id时自动停止。
1.3 配置项参数说明
参数名称 示例数据 说明
API_KEY sk-123456 apikey,用于访问接口的权限验证。
ServiceEndPoint https://ip:port/compatible-mode/v1/chat/completions 模型请求地址
API_TYPE TGI N卡环境默认为VLLM,昇腾为TGI,不配置默认为VLLM。
ApiVersion - VLLM
deploymentName qwen2.5-14b 模型名称
  1. 新增对话模型。

    需要在模型适配器中增加Qwen2.5_14B_Chat(N卡环境)/Qwen2.5_32B_Chat_TGI(昇腾环境)/Qwen2.5_72B_Chat_Saas(SaaS版)模型,并确保模型类型指定为:completion_qwen_chat image image
  2. 新增代码补全模型。

    需要在模型适配器中增加Qwen2.5_14B_Coder(N卡)/Qwen2.5_32B_Coder_TGI(昇腾)模型,并确保模型类型指定为:codecompletion_qwen_coder image image
  3. 新增提示词推理模型。

    需要在模型适配器中增加Qwen2.5_14B_Completion(N卡)/Qwen2.5_32B_Completion_TGI(昇腾)模型,并确保模型类型指定为:completion_qwen_completion image image

配置 全局配置-模型

  1. 配置全局配置-模型

    点击系统管理/参数设置 菜单,找到全局配置-模型 image
  2. chat对话配置Qwen2.5

    点击修改,在 “chat_model_types”:配置内容增加"completion_qwen_chat" 。此时在对话时的对话模型选择时就可以选择Qwen2.5模型进行对话。 image image
  3. 代码补全配置Qwen2.5

    点击修改, “code_completion_model_types”:配置内容修改为"codecompletion_qwen_coder" 。此时使用SmartCode插件进行代码补全时,就会使用Qwen2.5来完成。 image
  4. 提示词配置Qwen2.5

    1. 点击修改, “task_method_completion_model_type”:配置内容修改为"completion_qwen_completion" 。此时使用完成模式的提示词时,就会使用Qwen2.5 模型来完成。 image
    2. 点击修改, “task_method_completion_model_type”:配置内容修改为"completion_qwen_completion" 。此时使用完成模式的提示词时,就会使用Qwen2.5模型来完成。 image

5 - 提示词仓库

提示工程是企业构建AI应用的核心实践,提示词是AI驱动下企业的核心资产。

1. 多级提示词库

提示工程是企业构建AI应用的核心实践,提示词是AI驱动下企业的核心资产。

提示词库 提示词库 提示词工厂 提示词工厂

AISE提供了统一的提示词仓库,具备三层提示词结构,包括:

提示词工厂

  • 系统内置提示词:提供系统内置的高频AI任务相关的提示词版本管理,AISE系统所提供的代码解释,代码评审,注释生成,单元测试生成等内置通用代码任务即通过系统内置提示词提供。系统内置提示词的修改权限不对用户开放,由产品团队根据模型适配和提示工程的迭代随产品版本进行更新。

  • 系统基础提示词:系统基础提示词为用户管理员事先配置好并对所有用户开放的提示词,普通用户可以使用此类提示词但是不能对其进行修改。系统基础提示词为企业提供了为用户推送标准化提示词的能力;并且支持按组织单位进行分配。

  • 用户提示词:用户可以创建自己的提示词模板,并可以共享给其他用户使用。用户提示词为用户提供了重用提示词的便捷方式,鼓励用户探索AI应用场景并在内部进行共享。

AISE的提示词仓库提供模型适配能力,用户可以针对不同的模型提供不同版本的提示词,系统根据用户调用过程中所使用的模型进行动态匹配,以便确保最佳的提示词生成效果。 AISE所提供的提示词仓库可以通过AISE所提供的标准化接口进行调用,在AISE内置的核心AI应用场景中打通使用,用户可以在SmartCode,SmartChat等不同客户端使用同样的提示词仓库管理体验。 提示词仓库提供内容版本管理,用户对提示词的修改会被记录并允许用户比较和回滚到特定版本。

2. 系统/组织级提示词

管理员可以根据实际的需求创建组织级的的提示词模版,通过创建提示词模版来扩展AI使用场景。

  1. 点击AISE管理 | 提示词库 | 新增 提示词库

  2. 输入提示词标识、简称 、全称 、自然语言、关键词类型、系统目录、用户角色、状态、模版内容等信息。 新增提示词库

3. 用户提示词

自定义提示词说明

支持通过模型角色提示词对模型行为进行控制,为不同的用户和应用场景设定不同的大模型行为方式。

提示词工厂

自定义提示词示例

提示词工厂

在提示词工厂定义提示词斜杠指令为:value2field / 在SmartCode插件中通过斜杠指令调用

创建提示词

  1. 点击应用 | 提示词工厂 提示词工厂

  2. 点击我的提示词旁边的“创建”按钮 创建

  3. 这里假设我们创建一个YAMLToJSON的提示词 创建提示词

  4. 保存后效果如下: 保存

  5. 回到客户端,输入“/” 召唤出自定义提示词模版,如下图所示: 调用

  6. 提供一个YAML内容,测试: 测试

  7. 转换后效果如下: 效果

6 - 特性开关

为了能够动态控制某个特性是否对用户开放,允许管理员进行配置。 特性开关也可以帮助我们对大规模的特性重构进行有效的质量控制,在重构过程中保持新特性关闭,如果需要在生产环境测试可以打开开关进行验证。 特性相关代码也使用开关进行分离,避免新特性/重构影响现有的也许逻辑。

6.1 - 知识库对话-特性开关

为了能够动态控制某个特性是否对用户开放,允许管理员进行配置。 特性开关也可以帮助我们对大规模的特性重构进行有效的质量控制,在重构过程中保持新特性关闭,如果需要在生产环境测试可以打开开关进行验证。 特性相关代码也使用开关进行分离,避免新特性/重构影响现有的也许逻辑。

特性说明

SmartChat知识库对话功能,需要开启特性开关才能对话。

特性指引

SmartChat知识库对话功能特性开关,开启步骤如下:

  1. 点击系统管理/参数设置菜单,找到特性开关-chat_library点击修改按钮,弹出参数设置修改窗口,确认特性开关是否开启,若未开启,SmartChat知识库对话功能无法生效。

image

image

6.2 - 应用-特性开关

应用市场管理菜单中的应用和参数设置菜单中的特性开关进行关联,可实现应用的灰度发布。现有应用市场中应用只能设置打开或关闭应用,无法对某个用户或者某个部门单独发布,在应用市场管理菜单中新增和特性开关功能(特性开关在系统管理/参数设置菜单中进行配置)进行关联后,可对指定用户或部门单独发布应用。

特性说明

应用市场管理菜单中的应用和参数设置菜单中的特性开关进行关联,可实现应用的灰度发布。现有应用市场中应用只能设置打开或关闭应用,无法对某个用户或者某个部门单独发布,在应用市场管理菜单中新增和特性开关功能(特性开关在系统管理/参数设置菜单中进行配置)进行关联后,可对指定用户部门单独发布应用。

操作指引

  1. 点击系统管理/参数设置菜单,然后点击新增按钮。 image
  2. 然后弹出新增系统参数对话框,输入相关参数,点击确定按钮,保存特性开关成功。
    1. 对所有用户生效 image
    2. 对指定用户生效,此时无法再指定部门 image
    3. 对指定部门生效,此时无法再指定用户 image
  3. 点击AISE管理/应用市场管理菜单,选择要关联特性开关的应用,点击修改按钮,显示修改应用列表对话框 image
  4. 点击特性开关下拉菜单,弹出特性开关选择窗口。 image
  5. 选择已创建的特性开关,点击确定按钮关联成功,再点击确定按钮保存成功。
  6. 关联成功后可通过修改特性开关中的相关参数控制应用市场中的应用是否显示。

7 - 知识库支撑系统

将多种类型和来源的文档、数据源、代码库组装成知识库,通过数据训练构建出可以直接进行知识检索和问答的知识库。

7.1 - 知识库权限管理

新增知识库管理员角色和知识库用户角色,点击应用/应用市场菜单,拥有拥有知识库管理员角色的用户,可以在知识库助手中新增,修改,查询,删除知识库,而拥有拥有知识库用户角色的用户,只能查询知识库。

特性说明

新增知识库管理员角色和知识库用户角色,点击应用/应用市场菜单,拥有知识库管理员角色的用户,可以在知识库助手中新增,修改,查询,删除知识库,而拥有知识库用户角色的用户,只能查询知识库。

操作指引

新增 知识库管理员/知识库用户 角色

  1. 使用具有管理员角色的用户登录AISE 管理系统,点击系统管理/用户管理菜单,点击以下新增用户按钮;

    image

  2. 然后系统会弹出新增用户对话框,找到角色下拉菜单;

    a.角色下拉菜单选择普通用户和知识库管理员,点击确定,新增成功;

    image

    b.角色下拉菜单选择普通用户和知识库用户,点击确定,新增成功;

    image

    c.知识库管理员或知识库用户角色不能单独使用,该用户必须具有管理员普通用户角色

角色的权限展示

知识库用户(查询)

1.从应用市场页面找到知识库助手入口,点击“启用”进入知识库页面。
“知识库用户”角色,只能查询知识库列表,没有对知识库的新增,编辑,删除等权限。

image

image

  1. “知识库用户”角色,有查询知识库详情的权限,但不能编辑和修改。
    1. 普通知识库 kb16.jpg
    2. workspace知识库 kb17.jpg

知识库管理员(增删改查)

  1. “知识库管理员”角色,有知识库相关的所有权限,如列表查询 知识库创建 知识库删除

    image

  2. 新增普通知识库或workspace知识库 image

  3. 普通知识库

    1. 知识库详情 kb12.jpg
    2. 新增普通知识库 kb13.jpg
  4. workspace知识库

    1. workspace知识库详情 kb14.jpg
    2. workspace知识库新增数据源 kb15.jpg

7.2 - 知识库文档对话

知识库助手增加上传文件,训练文件,根据文件进行文档对话功能

特性说明

知识库助手增加上传文件,训练文件,根据文件进行文档对话功能。知识库对话支持的场景有两种: 场景1: 从AI服务基座应用市场的知识库助手选择一个知识库(有训练完成的文档),点击开始对话进入SmartChat开始对话 场景2: 在SmartChat页面自主选择知识库下拉列表开始对话

操作指引

1. 知识库上传文档,点击“开始对话”对该知识库进行问答

a.点击应用/应用市场菜单,打开知识库助手

image

b.进入知识库详情页面,点击添加数据源

image

c.类型选择文档类型,点击上传按钮上传文件

image

d.文件上传成功后,点击确定按钮会将已成功上传的文件保存到该知识库并在后台进行训练

image

e.文件保存成功后回到知识库详情页面,查看数据源列表的训练状态,只有训练状态为completed的文档才可以进行对话,点击列表右上角的刷新图标可以刷新训练状态

image

f.点击知识库的开始对话按钮,跳转到smartChat开始对话

image

g.跳转到smartChat页面后可以基于该知识库文档进行问答

image

image

2. 在SmartChat页面自主选择知识库进行问答

a.用户在SmartChat页面新建会话时可以自主选择相关知识库,下拉选数据默认为空。

image

b.知识库选择完毕之后,用户可以针对当前选中知识库进行文档对话。

8 - 应用市场

插件市场是每个AISE部署实例独立可配置,私有部署的实例和公开部署的,不同客户部署的都不相同。 私有部署的插件下载地址也不一样。 允许每个部署的管理员自行配置自己的插件市场。

为承载企业多样的AI应用并为这些应用提供基础的版本分发、升级和场景化管理,AISE内置了应用市场管理。 应用市场

应用市场通过为每个AI应用分配唯一的app_key的方式,为AISE的其他服务提供针对不同应用提供个性化场景的能力。 应用详情

1. 创建应用

说明:组织可以在AISE应用市场维护已经开发好的AISE扩展。包括对版本进行维护。方便用户快速获取相关应用。

  1. 点击AISE管理 | 应用市场管理 | 新增 新增
  2. 输入应用键、名称、包类型、类型、提供者、标签、选择图标、说明、描述等信息 新增应用弹窗

2. 维护版本

用户可以针对smartcode插件维护版本信息。 修改

  1. 点击添加 添加

  2. 输入发布日期、版本号、版本描述、发布者等信息 alt text

3. 启用强制更新

为了保障用户可以使用最新的代码补全以及代码聊天插件,AISE管理员可以在后台启用强制更新策略,配置如下。 启用强制更新

8.1 - 插件上传文件名校验

aise管理 - 应用市场管理页面,在进行插件安装包上传时,增加文件名校验功能

特性说明

aise管理 - 应用市场管理页面,在进行插件安装包上传时,增加文件名校验功能, 规则如下:

  • 开头使用英文,可以用 _ 或 - 作为连接符,不能使用空格
  • 开头后面紧跟一个主版本号(数字),必须用 _ 或 - 作为连接符
  • 主版本号后有一个小数点,再加上次版本号(数字)
  • 紧接着一个点加上构建号(数字)
  • 最后文件扩展名为 zip / vsi

操作指引

场景标题

上传文件smartcode_vscode(2),这种带括号的文件会导致报错无法下载

场景说明

日常操作中,同一文件多次下载或者保存后会出现带括号的这种文件名,上传这种文件,会导致插件在应用市场无法下载,报错

操作步骤

1.增加文件名校验后,aise管理 - 应用市场管理页面上传符合格式要求的文件

image

2.可以成功下载,不会产生报错。

image

9 - 系统运维

系统运维的主要职责是确保AISE系统的稳定、安全和高效运行。它包括系统安装和配置、日志清理、数据库备份、域登录等。

9.1 - Oauth2代理

AISE (AI Powered Software Engineering)系统如果部署在内网,无法直接外网,而Azure oauth2必须通过外网才能进行验证,可以通过新增的Oauth2代理,使Azure oauth2通过代理访问外网。

操作指引

AISE系统Oauth2代理配置

默认情况下Auzre oauth2代理是关闭状态,如果需要开启按照如下步骤进行操作:

  1. 登录部署服务器,切换到安装目录; cd /home/aise/aise-system-core-deploy
  2. 修改docker-compose-allinone.yml文件中有关代理的参数
    1. AISE_PROXY_FLAG:默认为false,true为开启Oauth2代理
    2. AISE_PROXY_HOST:IP为代理IP地址
    3. AISE_PROXY_PORT:Port为代理端口
    4. AISE_PROXY_USER_NAME:username为代理用户名,如果不校验可不填
    5. AISE_PROXY_PASSWORD:password为代理用户名,如果不校验可不填 20241225-1.png
  3. 最后重新部署aise-modules-system;
    docker rm -f aise-modules-system
    docker-compose -f docker-compose-allinone.yml up -d aise-modules-system
    

9.2 - 服务检测

AISE管理系统支持对docker应用进行健康检测。

特性说明

服务检测功能主要检测docker应用的运行状态,如果运行异常需要提示客户具体哪个docker应用异常,除了aise-mysql和aise-redis服务,其他服务都可以灵活配置启用或关闭。

服务检测-页面:通过页面查询服务检测结果,用户可以直观的查询所有服务的运行状态,可以通过详情查询历史异常信息。

服务检测-接口:通过接口查询服务检测结果,第三方通过调用该接口查询服务运行状态。

操作指引

服务检测字典设置

用户可以自由设置哪些服务需要需要检测,aise-mysql和aise-redis为默认服务,不需要另外配置

  1. 用户登录AISE管理系统,点击左侧菜单的 系统管理 | 字典管理 ,即可进入如下界面 image

  2. 查找名称为服务检测-URL的字典项,点击字典类型,进入字典数据列表页面 image image

  3. 新增检测服务

    1. 点击新增按钮,弹出添加字典键值窗口 image
    2. 输入必选项信息,字典标签填写服务名称,字典键值填写检测URL,字典排序填写展示顺序,状态默认正常,点击确定按钮,新增成功 image image
  4. 修改检测服务

    1. 点击修改按钮,弹出添加字典键值窗口 image
    2. 修改字典键值、字典排序、状态(状态如果是停用,就不用再检测),点击确定按钮,修改成功 image
  5. 删除检测服务

    1. 选择所要删除字典项,点击删除按钮,确定后删除字典,删除后不会再检测该服务 image image

服务检查查询

  1. 用户登录AISE管理系统,点击左侧菜单的 系统监控 | 服务检测 ,即可进入如下界面,默认5分钟检测一次 image
  2. 输入容器名称或选择状态可以查询过滤指定容器 image
  3. 点击服务详情,可查询该服务历史失败信息 image image

服务检测接口调用

服务检测提供单独的接口供第三方调用,检测时间间隔为5分钟

  1. 接口地址:https://AISE服务地址/core-api/system/operlog/health_check?refresh=false ,其中AISE服务地址需要根据生产实际情况替换
  2. 正常报文信息,status状态为1,代表服务正常
    {"msg":"查询成功","data":[],"status":"1"}
    
  3. 异常报文信息,status状态为0,代表服务异常,data数组显示所有检测异常的服务
    {
    "msg": "查询成功",
    "data": [{
    "containerName": "aise-chatui",
    "title": "aise-chatui服务未启动成功",
    "errorMsg": "",
    "recordTime": "2024-11-26 14:39:28"
    }],
    "status": "0"
    }
    

9.3 - 数据库备份

AISE系统管理支持数据库自动备份。

特性说明

数据库备份支持全量和增量备份

全量备份:每天凌晨3点备份一次,默认最多保留7天

增量备份:暂不支持

操作指引

全量备份参数修改

  1. 点击系统监控/定时任务菜单,选择任务数据库备份-全量,点击修改按钮,弹出定时任务修改窗口 image image image

  2. 调用方法参数 MysqlBackupTask.work(“full”,“7”,“AISE服务地址”,“13306”,"./mysql-backup")

    1. full: 全量标志,默认值
    2. 7:备份保留天数,默认保留7天以内的备份数据,可按需修改
    3. AISE服务地址:mysql数据库域名地址,可以是IP地址,需要根据生产实际情况修改 若为多机部署,建议使用IP指向mysql数据库部署服务器IP
    4. 13306:mysql数据库端口(默认为13306) 若部署时有指定过其他端口,则此处需要修改为您指定的端口
    5. ./mysql-backup:数据库备份存储目录,默认为.表示当前目录(当前目录为部署目录的1.mysql/backup文件夹下) 可以更改为其他目录(路径可使用相对或绝对路径)
  3. cron执行参数:每天凌晨3点执行备份 image

  4. 备份文件默认地址:/home/aise/aise-system-core-deploy/1.mysql/backup,可通过修改任务详情页面中调整调用方法参数 image

9.4 - 系统激活

AISE (AI Powered Software Engineering) 系统试用期结束后,为了继续使用,需要通过激活码来解锁全部功能,激活码由软件开发商提供。

操作指引

AISE系统激活指南

首次部署时,系统带有默认激活码。如激活码过期或者临时修改,则按照如下步骤进行操作:

  1. 从软件开发商或销售人员获取新的激活码;
  2. 登录部署服务器,切换到安装目录;
    cd /home/aise/aise-system-core-deploy
    
  3. 修改docker-compose-allinone.yml文件中AISE_ACTIVATION_CODE激活码参数 20241212-1.jpg
  4. 最后重新部署aise-gateway;
    docker rm -f aise-gateway
    docker-compose -f docker-compose-allinone.yml up -d aise-gateway
    

9.5 - 系统日志清理机制

AISE管理系统支持变更日志保留天数。

特性说明

AISE 后台管理系统,之前是日志默认保留60天,超过60天的日志会被删除,现修改成默认保留7天,且在docker-compose-allinone.yml中的服务aise-manager、aise-auth、aise-modules-system、aise-modules-job、aise-modules-file、aise-gateway新增环境变量AISE_LOG_MAX_HISTORY,部署时可以通过修改环境变量修改日期默认保留天数。

操作指引

单应用日志保留天数修改:

  1. 部署全部应用时,可以修改multihost.env文件中AISE_LOG_MAX_HISTORY参数,然后执行start.sh脚本

  2. 部署单个应用,修改docker-compose-allinone.yml文件中所属应用参数,例如:${AISE_LOG_MAX_HISTORY:-10}

  3. 执行以下命令:

    cd /home/aise/aise-system-core-deploy
    docker-compose -f docker-compose-allinone.yml stop aise-manager
    docker-compose -f docker-compose-allinone.yml rm -f aise-manager
    docker-compose -f docker-compose-allinone.yml up -d aise-manager
    
  4. 示例说明:默认保留7天,如果当天是11月27日,会删除11月20日之前的日志 image

9.6 - 域登录

AISE (AI Powered Software Engineering)系统集成Windows Server Active Directory (AD) 域登录,现在用户可以通过域账号进行身份验证登录。

操作指引

AISE系统域登录配置

默认情况下AISE系统域登录配置为关闭状态,如果需要开启按照如下步骤进行操作:

  1. 登录AISE系统,点击左侧导航栏“系统管理”->“域登录”->“域配置”菜单,如下图所示: 20250506-1.png
  2. 默认关闭状态,点击“启用”按钮,如下图所示: 20250506-2.png
  3. 各个参数的详细说明如下:
    1. 域服务器地址:AD服务器地址,默认格式为: ldap://example.com:389,example.com为域服务器名称或IP地址,389为端口
    2. 账号:管理员账号,使用DN格式:CN=admin,CN=Users,DC=example,DC=com
    3. 密码:管理员密码
    4. 域名称:域名称,格式为example.com,确保该域名可以正常访问域服务器
    5. 基础DN:域服务器的根目录,格式为:DC=example,DC=com
    6. 跟随引用:默认值
    7. AISE账号:选中后,已登录验证过的域账号将不能使用普通登录窗口登录,必须使用域账号登录窗口登录
    8. 默认部门:域账号登录成功后,默认选择的部门
    9. 默认角色:域账号登录成功后,默认选择的角色
  4. 点击“保存”按钮,配置成功
  5. 只有启用时登录页面才会显示域账号登录窗口,如下图所示: 20250506-4.png
  6. 已登录过域账号可以在“系统管理”->“域登录”->“用户管理”菜单中查看域账号信息,如下图所示: 20250506-3.png
注意事项:
1、如果已在AISE系统创建过用户,且用户名称和域账号名称相同,则使用域账号登录时,不会重新创建和修改用户信息,只是绑定该账号为域账号