Skip to content

Commit ba91138

Browse files
RicbetRicbet
authored
chore: update ai module doc (#149)
1 parent ce387ad commit ba91138

File tree

2 files changed

+253
-75
lines changed

2 files changed

+253
-75
lines changed

‎docs/integrate/module-usage/ai-native-module.en.md

+126-34
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ Complete example code can be found in ai.back.service.ts.
7979

8080
```typescript
8181
@Injectable()
82-
export class AiBackService extends BaseAIBackService implements IAIBackService {
82+
export class AiBackService implements IAIBackService<ReqeustResponse, ChatReadableStream> {
8383
// Here you can interact with any large model API interface
8484
}
8585
```
@@ -144,45 +144,15 @@ Other capabilities' Provider API documentation is as follows:
144144
145145
| Method Name | Description | Parameter Type | Return Type |
146146
| ------------------------------ | ------------------------------------------------------------------- | --------------------------------- | ----------- |
147-
| middleware | Provides middleware to extend some AI capabilities | IAIMiddleware | void |
148147
| registerInlineChatFeature | Registers inline chat related features | IInlineChatFeatureRegistry | void |
149148
| registerChatFeature | Registers chat panel related features | IChatFeatureRegistry | void |
150149
| registerChatRender | Registers chat panel related rendering layers, can customize render | IChatRenderRegistry | void |
151150
| registerResolveConflictFeature | Registers intelligent conflict resolution related features | IResolveConflictRegistry | void |
152151
| registerRenameProvider | Registers intelligent renaming related features | IRenameCandidatesProviderRegistry | void |
152+
| registerProblemFixFeature |
153+
Register smart repair related functions | IProblemFixProviderRegistry | void |
154+
| registerIntelligentCompletionFeature | Register for smart code completion related functions | IIntelligentCompletionsRegistry | void |
153155

154-
#### IAIMiddleware
155-
156-
| Method Name | Description | Parameter Type | Return Type |
157-
| --------------------------------- | -------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |
158-
| language.provideInlineCompletions | Extends inline completion capabilities | (model: ITextModel, position: Position, token: CancellationToken, next: (reqBean: CompletionRequestBean) => MaybePromise, completionRequestBean: CompletionRequestBean) => MaybePromise | void |
159-
160-
Example:
161-
162-
```typescript
163-
middleware: IAIMiddleware = {
164-
language: {
165-
provideInlineCompletions: async (
166-
model: ITextModel,
167-
position: Position,
168-
token: CancellationToken,
169-
next: (reqBean: CompletionRequestBean) => MaybePromise,
170-
completionRequestBean: CompletionRequestBean
171-
) => {
172-
// Custom logic based on parameter information to alter the code completion results
173-
// For example
174-
return {
175-
sessionId: completionRequestBean.sessionId,
176-
codeModelList: [
177-
{
178-
content: 'Hello OpenSumi!'
179-
}
180-
]
181-
};
182-
}
183-
}
184-
};
185-
```
186156

187157
#### IInlineChatFeatureRegistry
188158

@@ -381,6 +351,127 @@ registerRenameProvider(registry: IRenameCandidatesProviderRegistry): void {
381351
}
382352
```
383353

354+
#### IProblemFixProviderRegistry
355+
356+
| Method Name | Description | Parameter Type | Return Type |
357+
| --------------------------------- | ---------------------- | ------------------------ | -------- |
358+
| registerHoverFixProvider | Register a provider for problem diagnosis | IHoverFixHandler | void |
359+
360+
Example:
361+
362+
```typescript
363+
registerProblemFixFeature(registry: IProblemFixProviderRegistry): void {
364+
registry.registerHoverFixProvider({
365+
provideFix: async (
366+
editor: ICodeEditor,
367+
context: IProblemFixContext,
368+
token: CancellationToken,
369+
): Promise<ChatResponse | InlineChatController> => {
370+
const { marker, editRange } = context;
371+
const prompt = 'Self-assembled prompts for problem diagnosis';
372+
373+
const controller = new InlineChatController({ enableCodeblockRender: true });
374+
const stream = await this.aiBackService.requestStream(prompt, {}, token);
375+
controller.mountReadable(stream);
376+
377+
return controller;
378+
},
379+
});
380+
}
381+
```
382+
383+
#### IIntelligentCompletionsRegistry
384+
385+
| Method Name | Description | Parameter Type | Return Type |
386+
| --------------------------------- | ---------------------- | ------------------------ | -------- |
387+
| registerIntelligentCompletionProvider | Register a smart completion provider | IIntelligentCompletionProvider | void |
388+
389+
Note: Configuring the `enableMultiLine` field in the returned completion list can enable multi-line completion.
390+
391+
Example:
392+
393+
```typescript
394+
registerIntelligentCompletionFeature(registry: IIntelligentCompletionsRegistry): void {
395+
registry.registerIntelligentCompletionProvider(async (editor, position, bean, token) => {
396+
const model = editor.getModel()!;
397+
const value = model.getValueInRange({
398+
startLineNumber: position.lineNumber,
399+
startColumn: 1,
400+
endLineNumber: position.lineNumber + 3,
401+
endColumn: model?.getLineMaxColumn(position.lineNumber + 3),
402+
});
403+
404+
const cancelController = new AbortController();
405+
const { signal } = cancelController;
406+
407+
token.onCancellationRequested(() => {
408+
cancelController.abort();
409+
});
410+
411+
const getRandomString = (length) => {
412+
const characters = 'opensumi';
413+
let result = '';
414+
for (let i = 0; i < length; i++) {
415+
result += characters.charAt(Math.floor(Math.random() * characters.length));
416+
}
417+
return result;
418+
};
419+
420+
/**
421+
* 随机增删字符
422+
*/
423+
const insertRandomStrings = (originalString) => {
424+
const minChanges = 2;
425+
const maxChanges = 5;
426+
const changesCount = Math.floor(Math.random() * (maxChanges - minChanges + 1)) + minChanges;
427+
let modifiedString = originalString;
428+
for (let i = 0; i < changesCount; i++) {
429+
const randomIndex = Math.floor(Math.random() * originalString.length);
430+
const operation = Math.random() < 0.5 ? 'delete' : 'insert';
431+
if (operation === 'delete') {
432+
modifiedString = modifiedString.slice(0, randomIndex) + modifiedString.slice(randomIndex + 1);
433+
} else {
434+
const randomChar = getRandomString(1);
435+
modifiedString = modifiedString.slice(0, randomIndex) + randomChar + modifiedString.slice(randomIndex);
436+
}
437+
}
438+
return modifiedString;
439+
};
440+
441+
try {
442+
await new Promise((resolve, reject) => {
443+
const timeout = setTimeout(resolve, 1000);
444+
445+
signal.addEventListener('abort', () => {
446+
clearTimeout(timeout);
447+
reject(new DOMException('Aborted', 'AbortError'));
448+
});
449+
});
450+
451+
return {
452+
items: [
453+
{
454+
insertText: insertRandomStrings(value),
455+
range: {
456+
startLineNumber: position.lineNumber,
457+
startColumn: 1,
458+
endLineNumber: position.lineNumber + 3,
459+
endColumn: model?.getLineMaxColumn(position.lineNumber + 3),
460+
},
461+
},
462+
],
463+
// Whether to enable multi-line completion
464+
enableMultiLine: true,
465+
};
466+
} catch (error) {
467+
if (error.name === 'AbortError') {
468+
return { items: [] };
469+
}
470+
throw error;
471+
}
472+
});
473+
}
474+
384475
**Complete example code can be found in [ai-native.contribution.ts](https://github.com/opensumi/core/blob/main/packages/startup/entry/sample-modules/ai-native/ai-native.contribution.ts).**
385476

386477
## Related Configuration
@@ -406,6 +497,7 @@ The AI Native Config-related configuration parameters can control the on/off sta
406497
| supportsInlineCompletion | boolean | Whether to enable the code intelligent completion feature |
407498
| supportsConflictResolve | boolean | Whether to enable the AI intelligent conflict resolution feature |
408499
| supportsRenameSuggestions | boolean | Whether to enable the AI to provide renaming suggestions feature |
500+
| supportsProblemFix | boolean | Whether to enable AI problem diagnosis capability |
409501
| supportsTerminalDetection | boolean | Whether to enable the AI terminal detection feature |
410502
| supportsTerminalCommandSuggest | boolean | Whether to enable the AI terminal command suggestion feature |
411503

‎docs/integrate/module-usage/ai-native-module.zh.md

+127-41
Original file line numberDiff line numberDiff line change
@@ -74,12 +74,11 @@ const app = new ClientApp(opts);
7474

7575
> 完整示例代码见 [ai.back.service.ts](https://github.com/opensumi/core/blob/main/packages/startup/entry/sample-modules/ai-native/ai.back.service.ts)
7676
77-
**1. 新建一个后端 service 文件，并继承 BaseAIBackService 服务**
77+
**1. 新建一个后端 service 文件**
7878

7979
```typescript
8080
@Injectable()
81-
export class AiBackService extends BaseAIBackService
82-
implements IAIBackService<ReqeustResponse, ChatReadableStream> {
81+
export class AiBackService implements IAIBackService<ReqeustResponse, ChatReadableStream> {
8382
// 在这里可以跟任何的大模型 API 做接口交互
8483

8584
// 例如 request 可以一次性返回大模型的返回结果
@@ -203,50 +202,14 @@ export class AiNativeContribution implements AINativeCoreContribution {
203202
204203
| 方法名 | 描述 | 参数类型 | 返回类型 |
205204
| ------------------------------ | ------------------------------------------- | --------------------------------- | -------- |
206-
| middleware | 提供中间件来扩展部分 AI 能力 | IAIMiddleware | void |
207205
| registerInlineChatFeature | 注册 inline chat 相关功能 | IInlineChatFeatureRegistry | void |
208206
| registerChatFeature | 注册 chat 面板相关功能 | IChatFeatureRegistry | void |
209207
| registerChatRender | 注册 chat 面板相关渲染层，可以自定义 render | IChatRenderRegistry | void |
210208
| registerResolveConflictFeature | 注册智能解决冲突相关功能 | IResolveConflictRegistry | void |
211209
| registerRenameProvider | 注册智能重命名相关功能 | IRenameCandidatesProviderRegistry | void |
210+
| registerProblemFixFeature | 注册智能修复相关功能 | IProblemFixProviderRegistry | void |
211+
| registerIntelligentCompletionFeature | 注册智能代码补全相关功能 | IIntelligentCompletionsRegistry | void |
212212

213-
#### IAIMiddleware
214-
215-
| 方法名 | 描述 | 参数类型 | 返回类型 |
216-
| --------------------------------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
217-
| language.provideInlineCompletions | 扩展内联补全能力 | (model: ITextModel, position: Position, token: CancellationToken, next: (reqBean: CompletionRequestBean) => MaybePromise<IAICompletionResultModel | null>, completionRequestBean: CompletionRequestBean) => MaybePromise<IAICompletionResultModel | null> | void |
218-
219-
用例：
220-
221-
```typescript
222-
middleware: IAIMiddleware = {
223-
language: {
224-
provideInlineCompletions: async (
225-
model: ITextModel,
226-
position: Position,
227-
token: CancellationToken,
228-
next: (
229-
reqBean: CompletionRequestBean
230-
) => MaybePromise<IAICompletionResultModel>,
231-
completionRequestBean: CompletionRequestBean
232-
) => {
233-
// 在这里可以根据参数信息做一些自定义逻辑，来改变代码补全返回的结果
234-
// 例如
235-
return {
236-
sessionId: completionRequestBean.sessionId,
237-
codeModelList: [
238-
{
239-
content: 'Hello OpenSumi!'
240-
}
241-
]
242-
};
243-
244-
// 当然也可以直接返回原始的代码补全结果（该结果会直接请求 back service 后端服务的 requestCompletion 方法）
245-
return next(completionRequestBean);
246-
}
247-
}
248-
};
249-
```
250213

251214
#### IInlineChatFeatureRegistry
252215

@@ -457,6 +420,128 @@ registerRenameProvider(registry: IRenameCandidatesProviderRegistry): void {
457420
}
458421
```
459422

423+
#### IProblemFixProviderRegistry
424+
425+
| 方法名 | 描述 | 参数类型 | 返回类型 |
426+
| --------------------------------- | ---------------------- | ------------------------ | -------- |
427+
| registerHoverFixProvider | 注册问题诊断的提供者 | IHoverFixHandler | void |
428+
429+
用例:
430+
431+
```typescript
432+
registerProblemFixFeature(registry: IProblemFixProviderRegistry): void {
433+
registry.registerHoverFixProvider({
434+
provideFix: async (
435+
editor: ICodeEditor,
436+
context: IProblemFixContext,
437+
token: CancellationToken,
438+
): Promise<ChatResponse | InlineChatController> => {
439+
const { marker, editRange } = context;
440+
const prompt = '可自行组装问题诊断的 prompt';
441+
442+
const controller = new InlineChatController({ enableCodeblockRender: true });
443+
const stream = await this.aiBackService.requestStream(prompt, {}, token);
444+
controller.mountReadable(stream);
445+
446+
return controller;
447+
},
448+
});
449+
}
450+
```
451+
452+
#### IIntelligentCompletionsRegistry
453+
454+
| 方法名 | 描述 | 参数类型 | 返回类型 |
455+
| --------------------------------- | ---------------------- | ------------------------ | -------- |
456+
| registerIntelligentCompletionProvider | 注册智能补全的提供者 | IIntelligentCompletionProvider | void |
457+
458+
说明: 在返回的补全列表当中配置 `enableMultiLine` 字段可开启多行补全的能力
459+
460+
用例:
461+
462+
```typescript
463+
registerIntelligentCompletionFeature(registry: IIntelligentCompletionsRegistry): void {
464+
registry.registerIntelligentCompletionProvider(async (editor, position, bean, token) => {
465+
const model = editor.getModel()!;
466+
const value = model.getValueInRange({
467+
startLineNumber: position.lineNumber,
468+
startColumn: 1,
469+
endLineNumber: position.lineNumber + 3,
470+
endColumn: model?.getLineMaxColumn(position.lineNumber + 3),
471+
});
472+
473+
const cancelController = new AbortController();
474+
const { signal } = cancelController;
475+
476+
token.onCancellationRequested(() => {
477+
cancelController.abort();
478+
});
479+
480+
const getRandomString = (length) => {
481+
const characters = 'opensumi';
482+
let result = '';
483+
for (let i = 0; i < length; i++) {
484+
result += characters.charAt(Math.floor(Math.random() * characters.length));
485+
}
486+
return result;
487+
};
488+
489+
/**
490+
* 随机增删字符
491+
*/
492+
const insertRandomStrings = (originalString) => {
493+
const minChanges = 2;
494+
const maxChanges = 5;
495+
const changesCount = Math.floor(Math.random() * (maxChanges - minChanges + 1)) + minChanges;
496+
let modifiedString = originalString;
497+
for (let i = 0; i < changesCount; i++) {
498+
const randomIndex = Math.floor(Math.random() * originalString.length);
499+
const operation = Math.random() < 0.5 ? 'delete' : 'insert';
500+
if (operation === 'delete') {
501+
modifiedString = modifiedString.slice(0, randomIndex) + modifiedString.slice(randomIndex + 1);
502+
} else {
503+
const randomChar = getRandomString(1);
504+
modifiedString = modifiedString.slice(0, randomIndex) + randomChar + modifiedString.slice(randomIndex);
505+
}
506+
}
507+
return modifiedString;
508+
};
509+
510+
try {
511+
await new Promise((resolve, reject) => {
512+
const timeout = setTimeout(resolve, 1000);
513+
514+
signal.addEventListener('abort', () => {
515+
clearTimeout(timeout);
516+
reject(new DOMException('Aborted', 'AbortError'));
517+
});
518+
});
519+
520+
return {
521+
items: [
522+
{
523+
insertText: insertRandomStrings(value),
524+
range: {
525+
startLineNumber: position.lineNumber,
526+
startColumn: 1,
527+
endLineNumber: position.lineNumber + 3,
528+
endColumn: model?.getLineMaxColumn(position.lineNumber + 3),
529+
},
530+
},
531+
],
532+
// 是否启动多行补全
533+
enableMultiLine: true,
534+
};
535+
} catch (error) {
536+
if (error.name === 'AbortError') {
537+
return { items: [] };
538+
}
539+
throw error;
540+
}
541+
});
542+
}
543+
```
544+
460545
**完整示例代码见 [ai-native.contribution.ts](https://github.com/opensumi/core/blob/main/packages/startup/entry/sample-modules/ai-native/ai-native.contribution.ts)**
461546

462547
## 相关配置
@@ -482,6 +567,7 @@ AI Native Config 相关的配置参数可以控制所有 AI 能力的开关
482567
| supportsInlineCompletion | boolean | 是否开启代码智能补全功能 |
483568
| supportsConflictResolve | boolean | 是否开启 AI 智能解决冲突的功能 |
484569
| supportsRenameSuggestions | boolean | 是否开启 AI 提供重命名建议的功能 |
570+
| supportsProblemFix | boolean | 是否开启 AI 问题诊断能力 |
485571
| supportsTerminalDetection | boolean | 是否开启 AI 终端检测功能 |
486572
| supportsTerminalCommandSuggest | boolean | 是否开启 AI 终端命令建议功能 |
487573

0 commit comments

Comments
 (0)