策略配置

步骤一：脚本开发

目前支持使用 TypeScript 语言进行脚本开发，可以参考样例进行代码开发，操作步骤如下：

1. 下载模板代码库：单击仓库地址：lingma-extension-template，该模板仓库集成了开发脚本所需的脚手架，请仔细阅读README.md文件和代码示例。

2. 实现“前置处理”接口：实现接口RequestPreHandler，API 可参考见下文，以下为一个示例片段SensitiveContentFilter.ts的实现。

   /**
    * 敏感内容过滤器，通过该过滤器可以实现对发送给模型的数据进行敏感信息预处理
    */
   export const sensitiveContentFilter: RequestPreHandler = {
     handle: async (request: RawRequest, SDKTool: LingmaSDKTool) => {
       const dataMap = PayloadUtil.getPayloadData(request.payload);
       for (const [key, value] of dataMap.entries()) {
         if (value.includes('password')) {
           return ResultUtil.buildBlockResult('内容包含password');
         }
       }
       // 如果需要针对不同的 action 做差异化处理，则参考如下实现
       switch (request.action) {
         case ActionEnum.COMPLETION:
           // do something
           break;
         case ActionEnum.CODE_PROBLEM_SOLVE:
           // do something
           break;
         default:
           return ResultUtil.buildNoOpsResult();
       }
       return ResultUtil.buildNoOpsResult();
     },
   };

3. 运行调试代码，通过运行main方法来测试脚本是否符合预期，操作步骤如下：

   步骤一

   编辑src/index.ts文件，修改main函数，调整实际需要被调试代码，如下示例： async function main() { const value1 = ['password=123', 'abc']; const value2 = 'hello world'; const dataMap = new Map<PayloadDataKeyEnum, PayloadDataValueType>(); dataMap.set(PayloadDataKeyEnum.SELECTED_CODE, value1); dataMap.set(PayloadDataKeyEnum.USER_INPUT, value2); const mockRequest: RawRequest = { action: ActionEnum.CODE_GENERATE_COMMENT, payload: { associatedContexts: [], data: dataMap, }, requestId: '123', }; const response = await sensitiveContentFilter.handle(mockRequest, SDKTool); console.log(response); }

   步骤二

   在 VS Code 中打开想要调试的代码文件并设置断点，然后从调试视图中选择“启动程序”并单击运行按钮即可；

步骤二：编译构建

将运行调试完成的 ts 文件编译为 js 文件，如将SensitiveContentFilter.ts文件编译为SensitiveContentFilter.js文件，编译构建步骤如下：

1. 打开配置文件src/build.js，修改entryPoints和outfile两个配置参数，并在entryPoints参数中指定需要编译构建的 ts 文件路径，在outfile中指定构建后的产物输出路径。

2. 在代码库根目录下执行命令node build.js，执行成功后对应的 js 文件将输出到outfile指定的产物输出路径。

步骤三：本地测试

在脚本上传企业配置后台之前，可在本地完成调试，以确保脚本能够与通义灵码的 IDE 插件集成，并对补全或问答场景的行为进行正确的安全过滤处理。具体调试步骤如下：

1. 将构建好的 js 文件拷贝到通义灵码本地存储路径的/extension/local/script/目录下。

2. 修改config.json文件：该文件所在目录为通义灵码本地存储路径的/extension/local/，打开config.json文件，并找到contentHandlerScripts，并在对应的内容里增加该脚本的配置信息，如果没有contentHandlerScripts，可以新增一个数组类型的配置，参考示例如下：

   {
     "contentHandlerScripts": [
       {
         "identifier": "SensitiveContentFilter", 
         "name": "敏感内容过滤",
         "version": "1.0.0",
         "scriptPath": "~/.lingma/extension/local/script/SensitiveContentFilter.js",
         "state": "enabled",
         "bizType": "completion"
       }
     ]
   }

   配置参数说明：

   参数	说明
   identifier	脚本 ID，需确保唯一性。
   name	脚本名称。
   version	脚本的版本号，如果修改了脚本内容，需要升级版本号，否则脚本无法生效。
   scriptPath	脚本存放的路径，请注意： 脚本一定要存放在本地存储路径的/extension/local/script/目录下。 脚本的 js 文件名称（如：SensitiveContentFilter.js）一定要与identifier的值保持一致。
   state	脚本状态，enabled表示启用、disabled表示禁用。
   bizType	脚本应用的业务场景，completion表示行间代码生成补全、chat表示智能问答。

步骤四：脚本上传

经过本地调试并通过验证后，可进行脚本上传，操作步骤如下：

1. 前往通义灵码控制台-策略管理，选择需要开通安全过滤器的场景。

2. 选择过滤器选项为：自定义脚本。

3. 将构建后的 js文件上传。

4. 上传后单击保存配置，约5分钟内会下发到插件端生效。

接口定义

/**
 * 通义灵码编程助手前置处理接口
 */
export interface RequestPreHandler {
  // 处理请求
  handle: (request: RawRequest, SDKTool: LingmaSDKTool) => Promise<HandlerResponse>;
}

入参定义

/**
 * 请求对象定义，请求包括触发的行为和待发送给 LLM 的原始数据
 */
export interface RawRequest {
  // 当前请求唯一标识，可用于追踪请求执行
  action: ActionEnum;
  // 触发请求的行为枚举
  payload: ContentPayload;
  // 封装原始数据内容的payload
  requestId: string;
}

// ContentPayload.data 中 value 类型
export type PayloadDataValueType = string | number | string[];
/**
 * 封装发送给 LLM 的原始数据内容
 */
export class ContentPayload {
  // 待处理的数据集合，对应的 key 参考 ContextValueKeyEnum 定义
  data: Map<PayloadDataKeyEnum, PayloadDataValueType>;
  // 与处理关联的上下文
  associatedContexts: ContextItem[];

  constructor() {
    this.data = new Map<PayloadDataKeyEnum, PayloadDataValueType>();
    this.associatedContexts = [];
  }
}

/**
 * ContentPayload.data 中 key 枚举
 */
export enum PayloadDataKeyEnum {
  // 用户圈选的代码片段
  SELECTED_CODE ='lingma:code',
  // 用户输入的文本
  USER_INPUT = 'lingma:text',
  // 报错信息
  ERROR_MESSAGES = 'lingma:error_messages',
  // 终端打印的日志信息
  TERMINAL_CONTENT = 'lingma:terminal_content',
  // 代码补全时，当前光标所在行的前文代码片段
  PREFIX_CODE = 'lingma:code_prefix',
  // 代码补全时，当前光标所在行的后文代码片段
  SUFFIX_CODE = 'lingma:code_suffix',
  // 相似代码片段
  SIMILAR_CODE = 'lingma:similar_code',
}

/**
 * 触发请求的行为枚举
 */
export enum ActionEnum {
    // 单元测试
    GENERATE_TESTCASE           = 'GENERATE_TESTCASE',
    // 生成注释
    CODE_GENERATE_COMMENT       = 'CODE_GENERATE_COMMENT',
    // 代码解释
    EXPLAIN_CODE                = 'EXPLAIN_CODE',
    // 代码优化
    OPTIMIZE_CODE               = 'OPTIMIZE_CODE',
    // 自由问答（即在问答输入框中直接输入文本的行为）
    FREE_INPUT                  = 'FREE_INPUT',
    // 代码问题快捷修复
    CODE_PROBLEM_SOLVE          = 'CODE_PROBLEM_SOLVE',
    // shell命令生成
    TERMINAL_COMMAND_GENERATION = 'TERMINAL_COMMAND_GENERATION',
    // 终端报错修复
    TERMINAL_EXPLAIN_FIX        = 'TERMINAL_EXPLAIN_FIX',
    // 代码补全
    COMPLETION                  = 'COMPLETION',
}

出参定义

/**
 * 预处理结果
 */
export class HandlerResponse {
  // 处理策略，通过该策略可以控制后续的处理逻辑
  handlePolicy: HandlePolicy;
  // 原因描述
  reason?: string;
  // 当handlePolicy=FILTER时，需要设置该属性，其值为经过过滤后的数据（必须与ContentRequest.payload的内容保持一致）
  payload?: ContentPayload;
  constructor() {
    // 默认值
    // eslint-disable-next-line @typescript-eslint/no-use-before-define
    this.handlePolicy = HandlePolicy.NO_OPS;
    this.reason = '';
    this.payload = new ContentPayload();
  }
}

/**
 * 处理策略枚举
 */
export enum HandlePolicy {
  // 阻断策略，直接阻断请求
  BLOCK = 'BLOCK',
  // 过滤策略，拦截请求并对payload内容进行修改
  FILTER = 'FILTER',
  // 忽略策略，不处理请求
  NO_OPS = 'NO_OPS',
}

步骤一：开启并编辑知识库过滤器

1. 在左侧导航栏，单击策略配置，在右侧页面，单击知识库过滤器页签。

2. 在知识库过滤器配置页面，您可以打开开关开启/关闭知识库上传前置过滤器，进行参数配置编辑。

   URL 地址	必填	企业提供的第三方扫描服务的接口地址。要求此接口必须使用 POST 请求。
   Token 字段名	必填	指定请求头中用于存放 Token 的字段名。
   Secret 密钥	必填	生成访问 Token 所需的密钥。Token 会被放入指定的请求头字段中，用于验证请求的合法性。详情请参考“安全 Token”章节。

   

步骤二：测试过滤器连通性

1. 填写正确后，进行连通性测试，单击测试连接按钮。当第三方过滤接口返回2xx状态码时，测试成功，如图所示：

2. 如果返回其它状态码，测试则会失败，您需要检查填写信息后再重现测试连接。如下所示：

步骤三：保存知识库过滤器

单击保存配置按钮，保存您的过滤器配置。保存成功后，过滤器将立即生效。

请求头

• 安全Token：是阿里云设计的一种安全签名，旨在防止恶意攻击者盗用您的云服务权限。生成 Token 需要以下要素：Secret 密钥、当前时间、其他信息 和 加密算法。

• Token生成：通义灵码调用第三方扫描服务接口时，将在请求头内携带安全Token 用于身份鉴权验证。 根据如下参数计算生成 Token 值：

  token = sha256Hex(method + url + timestamp + tokenSecret) + timestampHex

  method	为 POST 方法。
  url	为 配置知识库过滤器填写的扫描服务接口 URL 地址。
  timestamp	为 当前时间。
  tokenSecret	为配置知识库过滤器时填写的 Secret 密钥。
  timestampHex	将时间戳转换成十六进制。

• Token验证：您的第三方扫描服务在验证请求的Token鉴权时，可以参考以下代码进行合法性校验。

  重要

  • 时间戳：确保客户端和服务端的时间同步，避免因时间偏差导致Token验证失败。

  • 密钥管理：妥善保管tokenSecret，不要泄露给未经授权的用户。

  • 过期时间：根据业务需求调整 Token 的有效时间，示例中设置为60秒，可根据实际情况调整。

  /*
   *  方法参数说明：
   *  receivedHash：接收到的哈希值，包含了时间戳信息。
   *  tokenSecret：用于生成哈希的密钥。
   *  url：请求的URL。
   */
  public boolean validateAuthRaw(String receivedHash, String tokenSecret, String url) {
      final String method = "POST";
      
      // 从 receivedHash 中提取时间戳部分
      String tsHex = receivedHash.substring(receivedHash.length() - 8);
      long tsSec = Long.parseLong(tsHex, 16);
      
      // 计算当前时间与接收时间的差异，假设允许的最大时间差为60秒
      long now = System.currentTimeMillis() / 1000L;
      if (Math.abs(now - tsSec) > 60) {
          return false; // 超过允许的时间范围
      }
      
      // 构建待签名的字符串
      String plain = method + url + tsSec + tokenSecret;
      
      // 生成预期的哈希值
      String expectedHash = org.apache.commons.codec.digest.DigestUtils.sha256Hex(plain);
      
      // 比较接收到的哈希值与预期的哈希值
      return expectedHash.equals(receivedHash.substring(0, receivedHash.length() - 8));
  }

请求参数

请求示例。

Content-Type: multipart/form-data; boundary=${bound}
--${bound}

Content-Disposition: form-data; name="metadata"

Content-Type: application/json
{
"user":"user0000001",
"queryID":"cd2fd109-c4d4-489f-9b27-53752f7827d6"
}

--${bound}
Content-Disposition: form-data; name="file"; filename="test-file.pdf"

Content-Type: application/pdf

%binary-file-content-here%

响应结构

接口应返回 HTTP 状态码 200，并包含以下格式的响应体。