AI Coding Assistant Lingma:フィルターの設定

• 処理メソッド：正規表現を使用してフィルターを設定します。3 つのモードがサポートされています。

  一致時にアクションなし	一致が発生した場合、アクションは実行されません。
  一致時にブロック	一致が発生した場合、リクエストをブロックし、モデルの呼び出しを停止します。
  一致時に置換	一致が発生した場合、設定に従ってコンテンツを置換します。

• 通知：通知を有効にして、Webhook を使用して任意のメッセージングプラットフォームにアラートを送信します。

• 実行順序：フィルターは設定した順序で実行されます。

• 正規表現の最大数：最大 10 個の式を追加できます。

• 正規表現の標準：式は ECMAScript 標準に従います。i (大文字と小文字を区別しない)、g (グローバル)、s (DOTALL) などの一般的なフラグがサポートされています。

• 設定例：

  ルール名	正規表現	置換	元のテキスト	置換後のテキスト
  ID 番号	(?<pre>.*)(\d{15})((\d{2})([0-9Xx]))(?<post>.*)	$<pre>***$<post>	ID number: 330204197709022312.	ID number: ***.
  メールアドレス	\w+([-+.]\w+)*@\w+([-.]\w+)*\.\w+([-.]\w+)*	***	My email is lin***@aliyunmail.com	My email is ***
  パスワード	(.*password=)([\w\d]+)(.*)	$1***$3	{password=1213213}	{password=***}

ステップ 1：スクリプトの開発

TypeScript でスクリプトを作成できます。サンプルコードをリファレンスとして使用してください。開始するには：

1. テンプレートリポジトリのダウンロード：リポジトリ URL をクリックします：lingma-extension-template。このテンプレートには、スクリプト開発用のスキャフォールディングが含まれています。README.md ファイルとコード例をよくお読みください。

2. 前処理インターフェイスの実装：RequestPreHandler インターフェイスを実装します。API の詳細については、「カスタムスクリプト 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('Content contains password');
         }
       }
       // さまざまなアクションを異なる方法で処理します
       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 関数を実行してテストします。次の手順に従ってください。

   ステップ 1

   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); }

   ステップ 2

   VS Code でスクリプトファイルを開き、ブレークポイントを設定します。次に、デバッグビューで [プログラムの起動] を選択し、[実行] をクリックします。

ステップ 2：コンパイルとビルド

完成した TypeScript ファイルを JavaScript にコンパイルします。たとえば、SensitiveContentFilter.ts を SensitiveContentFilter.js にコンパイルします。次の手順に従ってください。

1. 設定ファイル src/build.js を開きます。entryPoints と outfile パラメーターを更新します。entryPoints を TypeScript ファイルのパスに設定します。outfile をコンパイルされた JavaScript ファイルの出力パスに設定します。

2. リポジトリのルートディレクトリからコマンド node build.js を実行します。実行が成功すると、outfile で指定されたパスに JavaScript ファイルが表示されます。

ステップ 3：ローカルでのテスト

エンタープライズ構成コンソールにスクリプトをアップロードする前に、ローカルでテストしてください。こうすることで、スクリプトが Lingma IDE 拡張と正しく統合され、コード補完や AI チャットのシナリオでセキュリティフィルタリングが正しく適用されることが保証されます。次の手順に従ってください。

1. コンパイル済みのJavaScriptファイルを、Lingma のローカル記憶域のパスにある /extension/local/script/ ディレクトリにコピーします。

2. 「config.json」ファイルを編集します。このファイルは、Lingma のローカル記憶域のパスにある「/extension/local/」ディレクトリにあります。「config.json」を開き、「contentHandlerScripts」を探します。スクリプトの構成を追加します。「contentHandlerScripts」が存在しない場合は、新しい配列を作成します。例：

   {
     "contentHandlerScripts": [
       {
         "identifier": "SensitiveContentFilter", 
         "name": "Sensitive Content Filter",
         "version": "1.0.0",
         "scriptPath": "~/.lingma/extension/local/script/SensitiveContentFilter.js",
         "state": "enabled",
         "bizType": "completion"
       }
     ]
   }

   パラメーターの説明：

   パラメーター	説明
   identifier	スクリプト ID。一意である必要があります。
   name	スクリプト名。
   version	スクリプトのバージョン。スクリプトを変更した後は、バージョン番号をインクリメントしてください。そうしないと、スクリプトは有効になりません。
   scriptPath	スクリプトファイルのパス。注意： スクリプトは、ローカルストレージパスの下の /extension/local/script/ ディレクトリに配置する必要があります。 JavaScript ファイル名 (例：SensitiveContentFilter.js) は、identifier の値と一致する必要があります。
   state	スクリプトの状態。enabled はスクリプトを有効にします。disabled は無効にします。
   bizType	ビジネスシナリオ。completion はインラインコード生成に適用されます。chat は AI チャットに適用されます。

ステップ 4：スクリプトのアップロード

ローカルでのテストと検証の後、スクリプトをアップロードします。次の手順に従ってください。

1. Lingma コンソールに移動します。ポリシー管理を選択します。セキュリティフィルターを有効にするシナリオを選択します。

2. フィルターオプションとしてカスタムスクリプトを選択します。

3. コンパイルされた JavaScript ファイルをアップロードします。

4. [設定を保存] をクリックします。設定は、約 5 分以内に拡張機能で有効になります。

カスタムスクリプト API

カスタムスクリプトは、3 つの処理メソッドをサポートしています。

• ブロック：それ以上の処理を停止します。LLM への推論呼び出しは行われません。現在のリクエストは終了します。

• フィルター：送信されるデータを変更し (たとえば、難読化、削除、または置換)、処理を続行します。

• 操作なし：データを変更せずに返し、処理を続行します。

/**
 * Tongyi Lingma の前処理インターフェイス
 */
export interface RequestPreHandler {
  // リクエストを処理します
  handle: (request: RawRequest, SDKTool: LingmaSDKTool) => Promise<HandlerResponse>;
}

/**
 * リクエストオブジェクト。LLM に送信されるアクションと生データを含みます。
 */
export interface RawRequest {
  // リクエストの一意の識別子。トレースに使用されます。
  action: ActionEnum;
  // リクエストをトリガーしたアクションの Enum。
  payload: ContentPayload;
  // 生データを含むペイロード。
  requestId: string;
}

// ContentPayload.data の値の型
export type PayloadDataValueType = string | number | string[];
/**
 * LLM に送信される生データを含むペイロード。
 */
export class ContentPayload {
  // 処理するデータのコレクション。キーは ContextValueKeyEnum で定義されます。
  data: Map<PayloadDataKeyEnum, PayloadDataValueType>;
  // 処理に関連付けられたコンテキスト。
  associatedContexts: ContextItem[];

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

/**
 * ContentPayload.data のキー
 */
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',
}

/**
 * リクエストアクションの Enum
 */
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',
    // シェルコマンドの生成
    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();
  }
}

/**
 * 処理ポリシーの Enum
 */
export enum HandlePolicy {
  // リクエストをブロック
  BLOCK = 'BLOCK',
  // リクエストをフィルターし、ペイロードを変更
  FILTER = 'FILTER',
  // アクションなし
  NO_OPS = 'NO_OPS',
}

• 処理メソッド：正規表現を使用してフィルターを設定します。サポートされているモードは 1 つだけです：

  一致時にアクションなし

  一致が発生した場合、アクションは実行されません。

• 通知：通知を有効にすると、Webhook を使用して任意のメッセージングプラットフォームにアラートを送信できます。

• 実行順序：フィルターは設定した順序で実行されます。

• 正規表現の最大数：最大 10 個の式を追加できます。

• 正規表現の標準：式は ECMAScript 標準に準拠しており、i (大文字と小文字を区別しない)、g (グローバル)、s (DOTALL) などの一般的なフラグがサポートされています。

• 設定例：

  ルール名	正規表現	元のテキスト
  ID 番号	(?<pre>.*)(\d{15})((\d{2})([0-9Xx]))(?<post>.*)	ID number: 330204197709022312.
  メールアドレス	\w+([-+.]\w+)*@\w+([-.]\w+)*\.\w+([-.]\w+)*	My email is lin***@aliyunmail.com
  パスワード	(.*password=)([\w\d]+)(.*)	{password=1213213}

ステップ1：スクリプトの開発

スクリプトは TypeScript で記述できます。サンプルコードをリファレンスとして使用してください。開始するには：

1. テンプレートリポジトリをダウンロードします: リポジトリの URL をクリックします: lingma-extension-template。このテンプレートには、スクリプト開発のためのスキャフォールディングが含まれています。「README.md」ファイルおよびコード例をよく読みます。

2. 後処理インターフェイスを実装する: RequestPostHandler インターフェイスを実装します。API については、「Custom Script API」をご参照ください。以下は、コードスニペット LLMChatAuditHandler.ts からの実装例です。このコードスニペットは、 Lingma の AIChat 操作を監査し、監査内容を Alibaba Cloud SLS にレポートします。

   import {ResultUtil} from '../common/HandlerRespUtil';
   import { JsonUtil } from '../common/JsonUtil';
   import {PayloadUtil} from '../common/PayloadUtil';
   import {Config} from '../sdk/ConfigManager';
   import {LingmaSDKTool} from '../sdk/LingmaSDKTool';
   import axios from "axios";
   import moment from "moment";
   import os from "os";
   import {
     ActionEnum, AIResponse,
     HandlePolicy,
     RawRequest,
     RequestPostHandler,
     RequestPreHandler
   } from '../sdk/RequestHandleSDK';
   
   /**
    * カスタム後処理フィルタースクリプト。リクエストコンテンツをリモートサーバーに送信して処理します (コードスキャンやコンテンツ監査など)。
    */
   export const llmResultAuditHandler: RequestPostHandler = {
     handle: async (request: RawRequest, response: AIResponse,SDKTool: LingmaSDKTool) => {
        // オペレーター名
        let userName = SDKTool.user.name;
        // オペレーター ID
        let userId = SDKTool.user.uid;
        // IDE
        let ide = SDKTool.idePlatform;
        // IDE バージョン
        let ideVersion = SDKTool.ideVersion;     
        // 操作時間
        let operationTime = moment().format("YYYY-MM-DD HH:mm:ss");
        // 操作 IP
        let opeartionIp = getIpAddress();
        // ビジネスシナリオ (補完またはチャット)
        let bizType = "chat";
        // リクエスト ID
        let requestId = request.requestId;
        // アクション
        let action = request.action;
        // 操作内容 (監査ニーズに基づいてフィールドを選択します。16 KB を超える大きなペイロードは避けてください。)
        let inferredResult = response.inferredResult.text;
       
        // SLS にレポート
        // SLS プロジェクト名
        let slsProject = "xxx";
        // SLS LogStore 名
        let slsLogStore = "xxx";
        // SLS エンドポイント
        let endPoint = "cn-hangzhou.log.aliyuncs.com";
        let slsWebTrackingUrl = `http://${slsProject}.${endPoint}/logstores/${slsLogStore}/track?APIVersion=0.6.0&request_id=${requestId}&action=${action}&biz_type=${bizType}&user_name=${userName}&user_id=${userId}&ide=${ide}&ide_version=${ideVersion}&operation_time=${operationTime}&opeartion_ip=${opeartionIp}&inferredResult=${inferredResult}`;
        axios.get(slsWebTrackingUrl).catch((error) => {
          console.error(error);
        });
   
        // フィルター結果を返す
       return ResultUtil.buildPostHandlerResponse(HandlePolicy.NO_OPS, response.inferredResult,'No action required');
     },
   };
   
   /**
    * カスタムスクリプトフィルターを構成に追加します
    * @param config LingmaExtensionSDK によって提供される Config オブジェクト
    */
   export function modifyConfig(config: Config) {
     config.postContentHandlers.push(llmResultAuditHandler);
     return config;
   }
   
   function getIpAddress() {
     const interfaces = os.networkInterfaces();
     for (let devName in interfaces) {
       let iface = interfaces[devName];
   
       for (let i = 0; i < iface.length; i++) {
         let alias = iface[i];
         if (
           alias.family === "IPv4" &&
           alias.address !== "127.0.0.1" &&
           !alias.internal
         )
           return alias.address;
       }
     }
   
     return "No IP address found";
   }

3. スクリプトを実行およびデバッグします。main 関数を実行してテストします。次の手順に従います：

   ステップ1

   src/index.ts ファイルを編集します。main 関数を修正して、スクリプトをテストします。例: async function main() { const value2 = 'hello world'; const dataMap = new Map<PayloadDataKeyEnum, PayloadDataValueType>(); dataMap.set(PayloadDataKeyEnum.USER_INPUT, value2); const request: RawRequest = { action: ActionEnum.CODE_GENERATE_COMMENT, payload: { associatedContexts: [], data: dataMap, }, requestId: 'test-request-id', }; const aiResponse: AIResponse = { inferredResult: { text: 'reply hello world', }, }; const response = await llmResultAuditHandler.handle(request, aiResponse, SDKTool); console.log(response); }

   ステップ2

   VS Code でスクリプトファイルを開き、ブレークポイントを設定します。次に、デバッグビューで [Launch Program] を選択し、[Run] をクリックします。

ステップ2：コンパイルとビルド

完成した TypeScript ファイルを JavaScript にコンパイルします。たとえば、LLMChatAuditHandler.ts を LLMChatAuditHandler.js にコンパイルします。次のステップに従います。

1. 構成ファイル src/build.js を開きます。 entryPoints と outfile パラメーターを更新します。 entryPoints を TypeScript ファイルのパスに設定します。 outfile をコンパイルされた JavaScript ファイルの出力パスに設定します。

2. コマンド node build.js を、リポジトリのルートディレクトリから実行します。正常に実行されると、JavaScript ファイルが outfile で指定されたパスに表示されます。

ステップ3：ローカルでのテスト

スクリプトを企業向け設定コンソールにアップロードする前に、ローカルでテストしてください。これにより、スクリプトがLingma IDE 拡張機能と正しく統合され、コード補完または AI チャットのシナリオでセキュリティフィルターが正しく適用されることを確認できます。次の手順に従ってください：

1. コンパイル済みの JavaScript ファイルを、Lingma のローカル記憶域のパス配下にある /extension/local/script/ ディレクトリにコピーします。

2. config.json ファイルを編集します。このファイルは、Lingma のローカル記憶域パスの下にある /extension/local/ ディレクトリにあります。config.json を開いて、contentHandlerScripts を見つけてください。スクリプトの構成を追加します。contentHandlerScripts が存在しない場合は、新しい配列を作成します。例:

   {
     "contentHandlerScripts": [
       {
         "identifier": "LLMChatAuditHandler", 
         "name": "AI Chat Audit",
         "version": "1.0.0",
         "scriptPath": "~/.lingma/extension/local/script/LLMChatAuditHandler.js",
         "state": "enabled",
         "stage":"post",
         "bizType": "completion"
       }
     ]
   }

   パラメーターの説明：

   パラメーター	説明
   identifier	スクリプト ID。一意である必要があります。
   name	スクリプト名。
   version	スクリプトのバージョン。スクリプトを変更した後は、バージョン番号をインクリメントしてください。そうしないと、スクリプトは有効になりません。
   scriptPath	スクリプトファイルパス。注意： スクリプトは、ローカル記憶域パスの下にある/extension/local/script/ディレクトリに配置する必要があります。 JavaScript ファイル名 (たとえば、LLMChatAuditHandler.js) は、identifier の値と一致する必要があります。
   state	スクリプトの状態です。 enabled はスクリプトを有効にし、disabled は無効にします。
   stage	処理ステージ。post はポストフィルターを意味します。pre はプレフィルターを意味します。デフォルトは pre です。
   bizType	ビジネスシナリオ。completion はインラインコード生成に、chat は AI チャットに適用されます。

ステップ4：スクリプトのアップロード

ローカルでのテストと検証が完了したら、スクリプトをアップロードします。次の手順に従ってください：

1. Tongyi Lingma Lingma コンソールに移動します。［ポリシー管理］を選択します。セキュリティフィルターを有効にするシナリオを選択します。

2. フィルターオプションとして [カスタムスクリプト] を選択します。

3. コンパイルされた JavaScript ファイルをアップロードします。

4. [構成の保存] をクリックします。構成は約 5 分で拡張機能に反映されます。

カスタムスクリプト API

カスタムスクリプトは、1 つの処理メソッドのみをサポートします：

• 操作なし：データを変更せずに返し、処理を続行します。

/**
 * Lingma の後処理インターフェイス
 * @param request ユーザーリクエスト
 * @param response 大規模言語モデル (LLM) からの推論結果
 * @param SDKTool SDK ユーティリティクラス。IDE とプラグイン情報を提供します。
 * @returns 後処理後の結果
 */
export interface RequestPostHandler {
  // 後処理メソッド
  handle: (request: RawRequest, response: AIResponse, SDKTool: LingmaSDKTool) => Promise<PostHandlerResponse>;
}

/**
 * リクエストオブジェクト。アクションと LLM に送信される生データを含みます。
 */
export interface RawRequest {
  // リクエストの一意の識別子。トレースに使用されます。
  action: ActionEnum;
  // リクエストをトリガーしたアクションの Enum。
  payload: ContentPayload;
  // 生データを含むペイロード。
  requestId: string;
}

/**
 * モデルからの推論結果
 */
export class InferredResult {
  // LLM によって生成されたテキスト
  text: string;
  constructor() {
    this.text = '';
  }
}

// ContentPayload.data の値の型
export type PayloadDataValueType = string | number | string[];
/**
 * LLM に送信される生データを含むペイロード。
 */
export class ContentPayload {
  // 処理するデータのコレクション。キーは ContextValueKeyEnum で定義されます。
  data: Map<PayloadDataKeyEnum, PayloadDataValueType>;
  // 処理に関連するコンテキスト。
  associatedContexts: ContextItem[];

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

/**
 * ContentPayload.data のキー
 */
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',
  // コード補完のためのファイルパス
  FILE_PATH = 'lingma:file_path',
}

/**
 * リクエストアクションの Enum
 */
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',
    // シェルコマンドの生成
    TERMINAL_COMMAND_GENERATION = 'TERMINAL_COMMAND_GENERATION',
    // ターミナルエラーの修正
    TERMINAL_EXPLAIN_FIX        = 'TERMINAL_EXPLAIN_FIX',
    // コード補完
    COMPLETION                  = 'COMPLETION',
}

/**
 * 後処理結果
 */
export class PostHandlerResponse {
  // 処理ポリシー。後続のロジックを制御します。
  handlePolicy: HandlePolicy;
  // 理由の説明
  reason?: string;
  // 処理された推論結果
  processedResult: InferredResult;
  constructor() {
    // デフォルト値
    this.handlePolicy = HandlePolicy.NO_OPS;
    this.reason = '';
    this.processedResult = new InferredResult();
  }
}

/**
 * LLM の応答をカプセル化します
 */
export class AIResponse {
  // 推論結果
  inferredResult: InferredResult;
  constructor() {
    this.inferredResult = new InferredResult();
  }
}

/**
 * モデルからの推論結果
 */
export class InferredResult {
  // LLM によって生成されたテキスト
  text: string;
  constructor() {
    this.text = '';
  }
}

/**
 * 処理ポリシーの Enum (後処理フィルターは NO_OPS のみをサポート)
 */
export enum HandlePolicy {
  // リクエストをブロックする
  BLOCK = 'BLOCK',
  // リクエストをフィルター処理し、ペイロードを変更する
  FILTER = 'FILTER',
  // アクションを実行しない
  NO_OPS = 'NO_OPS',
}