AI Coding Assistant Lingma:Konfigurasi filter

• Metode pemrosesan: Konfigurasikan filter menggunakan ekspresi reguler. Tiga mode didukung.

  No action on match	Tidak mengambil tindakan apa pun saat terjadi kecocokan.
  Block on match	Memblokir permintaan dan menghentikan panggilan model saat terjadi kecocokan.
  Replace on match	Mengganti konten sesuai konfigurasi saat terjadi kecocokan.

• Notifikasi: Aktifkan notifikasi untuk mengirim peringatan ke platform pesan pilihan Anda menggunakan webhook.

• Urutan eksekusi: Filter dijalankan sesuai urutan konfigurasi Anda.

• Jumlah maksimum ekspresi reguler: Anda dapat menambahkan hingga 10 ekspresi.

• Standar ekspresi reguler: Ekspresi mengikuti standar ECMAScript. Flag umum seperti i (case-insensitive), g (global), dan s (DOTALL) didukung.

• Contoh konfigurasi:

  Nama aturan	Ekspresi reguler	Pengganti	Teks asli	Teks yang diganti
  ID number	(?<pre>.*)(\d{15})((\d{2})([0-9Xx]))(?<post>.*)	$<pre>***$<post>	ID number: 330204197709022312.	ID number: ***.
  Email address	\w+([-+.]\w+)*@\w+([-.]\w+)*\.\w+([-.]\w+)*	***	My email is lin***@aliyunmail.com	My email is ***
  Password	(.*password=)([\w\d]+)(.*)	$1***$3	{password=1213213}	{password=***}

Langkah 1: Kembangkan skrip

Anda dapat menulis skrip dalam TypeScript. Gunakan contoh kode sebagai referensi. Untuk memulai:

1. Unduh repositori templat: Klik URL repositori: lingma-extension-template. Templat ini mencakup kerangka dasar untuk pengembangan skrip. Baca file README.md dan contoh kode dengan cermat.

2. Implementasikan antarmuka pra-pemrosesan: Implementasikan antarmuka RequestPreHandler. Untuk detail API, lihat Custom Script API. Berikut adalah contoh implementasi dalam SensitiveContentFilter.ts:

   /**
    * Sensitive content filter. Pre-processes data sent to the model.
    */
   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');
         }
       }
       // Handle different actions differently
       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. Jalankan dan debug skrip. Uji dengan menjalankan fungsi main. Ikuti langkah-langkah berikut:

   Langkah 1

   Edit file src/index.ts. Ubah fungsi main untuk menguji skrip Anda. Contoh: 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); }

   Langkah 2

   Buka file skrip di VS Code dan atur breakpoint. Lalu, di tampilan Debug, pilih Launch Program dan klik Run.

Langkah 2: Kompilasi dan Build

Kompilasi file TypeScript yang telah selesai menjadi JavaScript. Misalnya, kompilasi SensitiveContentFilter.ts menjadi SensitiveContentFilter.js. Ikuti langkah-langkah berikut:

1. Buka file konfigurasi src/build.js. Perbarui parameter entryPoints dan outfile. Atur entryPoints ke path file TypeScript Anda. Atur outfile ke path output untuk file JavaScript yang dikompilasi.

2. Jalankan perintah node build.js dari direktori root repositori Anda. Setelah berhasil dieksekusi, file JavaScript akan muncul di path yang ditentukan dalam outfile.

Langkah 3: Uji secara lokal

Sebelum mengunggah skrip Anda ke konsol konfigurasi perusahaan, uji secara lokal. Ini memastikan skrip terintegrasi dengan benar ke ekstensi IDE Lingma dan menerapkan penyaringan keamanan dengan benar untuk skenario penyelesaian kode atau Chat AI. Ikuti langkah-langkah berikut:

1. Salin file JavaScript yang telah dikompilasi ke direktori /extension/local/script/ di bawah path penyimpanan lokal Lingma.

2. Edit file config.json. File ini terletak di direktori /extension/local/ di bawah path penyimpanan lokal Lingma. Buka config.json dan cari contentHandlerScripts. Tambahkan konfigurasi skrip Anda. Jika contentHandlerScripts tidak ada, buat array baru. Contoh:

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

   Deskripsi parameter:

   Parameter	Deskripsi
   identifier	ID skrip. Harus unik.
   name	Nama skrip.
   version	Versi skrip. Tingkatkan nomor versi setelah mengubah skrip. Jika tidak, skrip tidak akan berlaku.
   scriptPath	Path file skrip. Catatan: Skrip harus ditempatkan di direktori /extension/local/script/ di bawah path penyimpanan lokal. Nama file JavaScript (misalnya, SensitiveContentFilter.js) harus sesuai dengan nilai identifier.
   state	Status skrip. enabled mengaktifkan skrip. disabled menonaktifkannya.
   bizType	Skenario bisnis. completion berlaku untuk inline code generation. chat berlaku untuk AI chat.

Langkah 4: Unggah skrip

Setelah pengujian dan validasi lokal selesai, unggah skrip tersebut. Ikuti langkah-langkah berikut:

1. Buka Lingma console. Pilih Policy Management. Pilih skenario tempat Anda ingin mengaktifkan filter keamanan.

2. Pilih Custom Script sebagai opsi filter.

3. Unggah file JavaScript yang telah dikompilasi.

4. Klik Save Configuration. Konfigurasi akan berlaku pada ekstensi dalam waktu sekitar 5 menit.

Custom Script API

Skrip kustom mendukung tiga metode pemrosesan:

• Block: Menghentikan pemrosesan lebih lanjut. Tidak ada panggilan inferensi ke LLM. Permintaan saat ini diakhiri.

• Filter: Memodifikasi data yang dikirim (misalnya, mengaburkan, menghapus, atau mengganti konten), lalu melanjutkan pemrosesan.

• No operation: Mengembalikan data tanpa perubahan dan melanjutkan pemrosesan.

/**
 * Pre-processing interface for Tongyi Lingma
 */
export interface RequestPreHandler {
  // Process the request
  handle: (request: RawRequest, SDKTool: LingmaSDKTool) => Promise<HandlerResponse>;
}

/**
 * Request object. Includes the action and raw data sent to the LLM.
 */
export interface RawRequest {
  // Unique identifier for the request. Used for tracing.
  action: ActionEnum;
  // Enum for the action that triggered the request.
  payload: ContentPayload;
  // Payload containing raw data.
  requestId: string;
}

// Value type for ContentPayload.data
export type PayloadDataValueType = string | number | string[];
/**
 * Payload containing raw data sent to the LLM.
 */
export class ContentPayload {
  // Collection of data to process. Keys are defined in ContextValueKeyEnum.
  data: Map<PayloadDataKeyEnum, PayloadDataValueType>;
  // Context associated with the processing.
  associatedContexts: ContextItem[];

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

/**
 * Keys for ContentPayload.data
 */
export enum PayloadDataKeyEnum {
  // Selected code snippet
  SELECTED_CODE ='lingma:code',
  // User input text
  USER_INPUT = 'lingma:text',
  // Error messages
  ERROR_MESSAGES = 'lingma:error_messages',
  // Terminal log output
  TERMINAL_CONTENT = 'lingma:terminal_content',
  // Code before cursor for code completion
  PREFIX_CODE = 'lingma:code_prefix',
  // Code after cursor for code completion
  SUFFIX_CODE = 'lingma:code_suffix',
  // Similar code snippets
  SIMILAR_CODE = 'lingma:similar_code',
}

/**
 * Enum for request actions
 */
export enum ActionEnum {
    // Unit test
    GENERATE_TESTCASE           = 'GENERATE_TESTCASE',
    // Generate comments
    CODE_GENERATE_COMMENT       = 'CODE_GENERATE_COMMENT',
    // Explain code
    EXPLAIN_CODE                = 'EXPLAIN_CODE',
    // Optimize code
    OPTIMIZE_CODE               = 'OPTIMIZE_CODE',
    // Free input (direct text entry in the chat box)
    FREE_INPUT                  = 'FREE_INPUT',
    // Quick fix for code issues
    CODE_PROBLEM_SOLVE          = 'CODE_PROBLEM_SOLVE',
    // Generate shell commands
    TERMINAL_COMMAND_GENERATION = 'TERMINAL_COMMAND_GENERATION',
    // Fix terminal errors
    TERMINAL_EXPLAIN_FIX        = 'TERMINAL_EXPLAIN_FIX',
    // Code completion
    COMPLETION                  = 'COMPLETION',
}

/**
 * Pre-processing result
 */
export class HandlerResponse {
  // Processing policy. Controls subsequent logic.
  handlePolicy: HandlePolicy;
  // Reason description
  reason?: string;
  // Required when handlePolicy=FILTER. Contains filtered data. Must match ContentRequest.payload structure.
  payload?: ContentPayload;
  constructor() {
    // Default values
    // eslint-disable-next-line @typescript-eslint/no-use-before-define
    this.handlePolicy = HandlePolicy.NO_OPS;
    this.reason = '';
    this.payload = new ContentPayload();
  }
}

/**
 * Processing policy enum
 */
export enum HandlePolicy {
  // Block the request
  BLOCK = 'BLOCK',
  // Filter the request and modify the payload
  FILTER = 'FILTER',
  // Take no action
  NO_OPS = 'NO_OPS',
}

• Metode pemrosesan: Konfigurasikan filter menggunakan ekspresi reguler. Hanya satu mode yang didukung:

  No action on match

  Tidak mengambil tindakan apa pun saat terjadi kecocokan.

• Notifikasi: Aktifkan notifikasi untuk mengirim peringatan ke platform pesan pilihan Anda menggunakan webhook.

• Urutan eksekusi: Filter dijalankan sesuai urutan konfigurasi Anda.

• Jumlah maksimum ekspresi reguler: Anda dapat menambahkan hingga 10 ekspresi.

• Standar ekspresi reguler: Ekspresi mengikuti standar ECMAScript. Flag umum seperti i (case-insensitive), g (global), dan s (DOTALL) didukung.

• Contoh konfigurasi:

  Nama aturan	Ekspresi reguler	Teks asli
  ID number	(?<pre>.*)(\d{15})((\d{2})([0-9Xx]))(?<post>.*)	ID number: 330204197709022312.
  Email address	\w+([-+.]\w+)*@\w+([-.]\w+)*\.\w+([-.]\w+)*	My email is lin***@aliyunmail.com
  Password	(.*password=)([\w\d]+)(.*)	{password=1213213}

Langkah 1: Kembangkan skrip

Anda dapat menulis skrip dalam TypeScript. Gunakan contoh kode sebagai referensi. Untuk memulai:

1. Unduh repositori templat: Klik URL repositori: lingma-extension-template. Templat ini mencakup kerangka dasar untuk pengembangan skrip. Baca file README.md dan contoh kode dengan cermat.

2. Implementasikan antarmuka pasca-pemrosesan: Implementasikan antarmuka RequestPostHandler. Untuk API-nya, lihat Custom Script API. Berikut adalah contoh implementasi dari potongan kode LLMChatAuditHandler.ts, yang melakukan audit operasi AIChat Lingma dan melaporkan konten audit ke 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';
   
   /**
    * Custom post-filter script. Sends request content to a remote server for processing (such as code scanning or content auditing).
    */
   export const llmResultAuditHandler: RequestPostHandler = {
     handle: async (request: RawRequest, response: AIResponse,SDKTool: LingmaSDKTool) => {
        // Operator name
        let userName = SDKTool.user.name;
        // Operator ID
        let userId = SDKTool.user.uid;
        // IDE
        let ide = SDKTool.idePlatform;
        // IDE version
        let ideVersion = SDKTool.ideVersion;     
        // Operation time
        let operationTime = moment().format("YYYY-MM-DD HH:mm:ss");
        // Operation IP
        let opeartionIp = getIpAddress();
        // Business scenario (completion or chat)
        let bizType = "chat";
        // Request ID
        let requestId = request.requestId;
        // Action
        let action = request.action;
        // Operation content (select fields based on your audit needs. Avoid large payloads over 16 KB.)
        let inferredResult = response.inferredResult.text;
       
        // Report to SLS
        // SLS project name
        let slsProject = "xxx";
        // SLS LogStore name
        let slsLogStore = "xxx";
        // SLS endpoint
        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 filter result
       return ResultUtil.buildPostHandlerResponse(HandlePolicy.NO_OPS, response.inferredResult,'No action required');
     },
   };
   
   /**
    * Add the custom script filter to the configuration
    * @param config Config object provided by LingmaExtensionSDK
    */
   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. Jalankan dan debug skrip. Uji dengan menjalankan fungsi main. Ikuti langkah-langkah berikut:

   Langkah 1

   Edit file src/index.ts. Ubah fungsi main untuk menguji skrip Anda. Contoh: 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); }

   Langkah 2

   Buka file skrip di VS Code dan atur breakpoint. Lalu, di tampilan Debug, pilih Launch Program dan klik Run.

Langkah 2: Kompilasi dan Build

Kompilasi file TypeScript yang telah selesai menjadi JavaScript. Misalnya, kompilasi LLMChatAuditHandler.ts menjadi LLMChatAuditHandler.js. Ikuti langkah-langkah berikut:

1. Buka file konfigurasi src/build.js. Perbarui parameter entryPoints dan outfile. Atur entryPoints ke path file TypeScript Anda. Atur outfile ke path output untuk file JavaScript yang dikompilasi.

2. Jalankan perintah node build.js dari direktori root repositori Anda. Setelah berhasil dieksekusi, file JavaScript akan muncul di path yang ditentukan dalam outfile.

Langkah 3: Uji secara lokal

Sebelum mengunggah skrip Anda ke konsol konfigurasi perusahaan, uji secara lokal. Ini memastikan skrip terintegrasi dengan benar ke ekstensi IDE Lingma dan menerapkan penyaringan keamanan dengan benar untuk skenario penyelesaian kode atau Chat AI. Ikuti langkah-langkah berikut:

1. Salin file JavaScript yang telah dikompilasi ke direktori /extension/local/script/ di bawah path penyimpanan lokal Lingma.

2. Edit file config.json. File ini terletak di direktori /extension/local/ di bawah path penyimpanan lokal Lingma. Buka config.json dan cari contentHandlerScripts. Tambahkan konfigurasi skrip Anda. Jika contentHandlerScripts tidak ada, buat array baru. Contoh:

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

   Deskripsi parameter:

   Parameter	Deskripsi
   identifier	ID skrip. Harus unik.
   name	Nama skrip.
   version	Versi skrip. Tingkatkan nomor versi setelah mengubah skrip. Jika tidak, skrip tidak akan berlaku.
   scriptPath	Path file skrip. Catatan: Skrip harus ditempatkan di direktori /extension/local/script/ di bawah path penyimpanan lokal. Nama file JavaScript (misalnya, LLMChatAuditHandler.js) harus sesuai dengan nilai identifier.
   state	Status skrip. enabled mengaktifkan skrip. disabled menonaktifkannya.
   stage	Tahap pemrosesan. post berarti post-filter. pre berarti pre-filter. Nilai default adalah pre.
   bizType	Skenario bisnis. completion berlaku untuk inline code generation. chat berlaku untuk AI chat.

Langkah 4: Unggah skrip

Setelah pengujian dan validasi lokal selesai, unggah skrip tersebut. Ikuti langkah-langkah berikut:

1. Buka Lingma console. Pilih Policy Management. Pilih skenario tempat Anda ingin mengaktifkan filter keamanan.

2. Pilih Custom Script sebagai opsi filter.

3. Unggah file JavaScript yang telah dikompilasi.

4. Klik Save Configuration. Konfigurasi akan berlaku pada ekstensi dalam waktu sekitar 5 menit.

Custom Script API

Skrip kustom hanya mendukung satu metode pemrosesan:

• No operation: Mengembalikan data tanpa perubahan dan melanjutkan pemrosesan.

/**
 * Post-processing interface for Tongyi Lingma
 * @param request User request
 * @param response Inference result from the LLM
 * @param SDKTool SDK utility class. Provides IDE and plugin information.
 * @returns Result after post-processing
 */
export interface RequestPostHandler {
  // Post-processing method
  handle: (request: RawRequest, response: AIResponse, SDKTool: LingmaSDKTool) => Promise<PostHandlerResponse>;
}

/**
 * Request object. Includes the action and raw data sent to the LLM.
 */
export interface RawRequest {
  // Unique identifier for the request. Used for tracing.
  action: ActionEnum;
  // Enum for the action that triggered the request.
  payload: ContentPayload;
  // Payload containing raw data.
  requestId: string;
}

/**
 * Inference result from the model
 */
export class InferredResult {
  // Text generated by the LLM
  text: string;
  constructor() {
    this.text = '';
  }
}

// Value type for ContentPayload.data
export type PayloadDataValueType = string | number | string[];
/**
 * Payload containing raw data sent to the LLM.
 */
export class ContentPayload {
  // Collection of data to process. Keys are defined in ContextValueKeyEnum.
  data: Map<PayloadDataKeyEnum, PayloadDataValueType>;
  // Context associated with the processing.
  associatedContexts: ContextItem[];

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

/**
 * Keys for ContentPayload.data
 */
export enum PayloadDataKeyEnum {
  // Selected code snippet
  SELECTED_CODE ='lingma:code',
  // User input text
  USER_INPUT = 'lingma:text',
  // Error messages
  ERROR_MESSAGES = 'lingma:error_messages',
  // Terminal log output
  TERMINAL_CONTENT = 'lingma:terminal_content',
  // Code before cursor for code completion
  PREFIX_CODE = 'lingma:code_prefix',
  // Code after cursor for code completion
  SUFFIX_CODE = 'lingma:code_suffix',
  // Similar code snippets
  SIMILAR_CODE = 'lingma:similar_code',
  // File path for code completion
  FILE_PATH = 'lingma:file_path',
}

/**
 * Enum for request actions
 */
export enum ActionEnum {
    // Unit test
    GENERATE_TESTCASE           = 'GENERATE_TESTCASE',
    // Generate comments
    CODE_GENERATE_COMMENT       = 'CODE_GENERATE_COMMENT',
    // Explain code
    EXPLAIN_CODE                = 'EXPLAIN_CODE',
    // Optimize code
    OPTIMIZE_CODE               = 'OPTIMIZE_CODE',
    // Free input (direct text entry in the chat box)
    FREE_INPUT                  = 'FREE_INPUT',
    // Quick fix for code issues
    CODE_PROBLEM_SOLVE          = 'CODE_PROBLEM_SOLVE',
    // Generate shell commands
    TERMINAL_COMMAND_GENERATION = 'TERMINAL_COMMAND_GENERATION',
    // Fix terminal errors
    TERMINAL_EXPLAIN_FIX        = 'TERMINAL_EXPLAIN_FIX',
    // Code completion
    COMPLETION                  = 'COMPLETION',
}

/**
 * Post-processing result
 */
export class PostHandlerResponse {
  // Processing policy. Controls subsequent logic.
  handlePolicy: HandlePolicy;
  // Reason description
  reason?: string;
  // Processed inference result
  processedResult: InferredResult;
  constructor() {
    // Default values
    this.handlePolicy = HandlePolicy.NO_OPS;
    this.reason = '';
    this.processedResult = new InferredResult();
  }
}

/**
 * Encapsulates the LLM response
 */
export class AIResponse {
  // Inference result
  inferredResult: InferredResult;
  constructor() {
    this.inferredResult = new InferredResult();
  }
}

/**
 * Inference result from the model
 */
export class InferredResult {
  // Text generated by the LLM
  text: string;
  constructor() {
    this.text = '';
  }
}

/**
 * Processing policy enum (post-filters support only NO_OPS)
 */
export enum HandlePolicy {
  // Block the request
  BLOCK = 'BLOCK',
  // Filter the request and modify the payload
  FILTER = 'FILTER',
  // Take no action
  NO_OPS = 'NO_OPS',
}