Skip to content

Commit 1de8e41

Browse files
committed
optimize FEL javadoc and pom
1 parent 920e7d6 commit 1de8e41

25 files changed

Lines changed: 326 additions & 189 deletions

File tree

framework/dependency/pom.xml

Lines changed: 33 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@
5656
<druid.version>1.2.20</druid.version>
5757
<fastjson.version>1.2.83</fastjson.version>
5858
<guava.version>32.0.1-jre</guava.version>
59-
<h2.version>2.3.232</h2.version>
59+
<hanlp.version>portable-1.8.4</hanlp.version>
6060
<lombok.version>1.18.36</lombok.version>
6161
<jackson.version>2.18.2</jackson.version>
6262
<mybatis.version>3.5.13</mybatis.version>
@@ -415,6 +415,33 @@
415415
<version>${fit.version}</version>
416416
</dependency>
417417

418+
<!-- FEL -->
419+
<dependency>
420+
<groupId>org.fitframework.fel</groupId>
421+
<artifactId>fel-core</artifactId>
422+
<version>${fit.version}</version>
423+
</dependency>
424+
<dependency>
425+
<groupId>org.fitframework.fel</groupId>
426+
<artifactId>tool-service</artifactId>
427+
<version>${fit.version}</version>
428+
</dependency>
429+
<dependency>
430+
<groupId>org.fitframework.fel</groupId>
431+
<artifactId>tool-info</artifactId>
432+
<version>${fit.version}</version>
433+
</dependency>
434+
<dependency>
435+
<groupId>org.fitframework.fel</groupId>
436+
<artifactId>tool-mcp-common</artifactId>
437+
<version>${fit.version}</version>
438+
</dependency>
439+
<dependency>
440+
<groupId>org.fitframework.fel</groupId>
441+
<artifactId>tool-mcp-client-service</artifactId>
442+
<version>${fit.version}</version>
443+
</dependency>
444+
418445
<!-- Ohscript -->
419446
<dependency>
420447
<groupId>org.fitframework.ohscript</groupId>
@@ -453,6 +480,11 @@
453480
<artifactId>guava</artifactId>
454481
<version>${guava.version}</version>
455482
</dependency>
483+
<dependency>
484+
<groupId>com.hankcs</groupId>
485+
<artifactId>hanlp</artifactId>
486+
<version>${hanlp.version}</version>
487+
</dependency>
456488
<dependency>
457489
<groupId>net.bytebuddy</groupId>
458490
<artifactId>byte-buddy</artifactId>

framework/fel/java/fel-flow/src/main/java/modelengine/fel/engine/activities/AiActivity.java

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,11 @@ protected AiActivity(F flow) {
3232
this.flow = Validation.notNull(flow, "Flow cannot be null.");
3333
}
3434

35+
/**
36+
* 获取 AI 节点所对应的流程对象。
37+
*
38+
* @return AI 节点所对应的流程对象。
39+
*/
3540
public F flow() {
3641
return this.flow;
3742
}

framework/fel/java/fel-flow/src/main/java/modelengine/fel/engine/activities/AiMatchHappen.java

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,12 @@ public class AiMatchHappen<O, D, I, RF extends Flow<D>, F extends AiFlow<D, RF>>
3030

3131
private final F flow;
3232

33+
/**
34+
* 创建一个 AI 流程匹配发生器。
35+
*
36+
* @param matchHappen 匹配发生器。
37+
* @param flow AI 流程。
38+
*/
3339
public AiMatchHappen(MatchHappen<O, D, I, RF> matchHappen, F flow) {
3440
this.matchHappen = Validation.notNull(matchHappen, "MatchHappen cannot be null.");
3541
this.flow = Validation.notNull(flow, "Flow cannot be null.");

framework/fel/java/fel-flow/src/main/java/modelengine/fel/engine/activities/AiMatchToHappen.java

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,12 @@ public class AiMatchToHappen<D, I, RF extends Flow<D>, F extends AiFlow<D, RF>>
3131

3232
private final F flow;
3333

34+
/**
35+
* 创建一个 {@link AiMatchToHappen} 对象。
36+
*
37+
* @param matchToHappen 匹配条件。
38+
* @param flow AI 流程。
39+
*/
3440
public AiMatchToHappen(MatchToHappen<D, I, RF> matchToHappen, F flow) {
3541
this.matchToHappen = Validation.notNull(matchToHappen, "matchToHappen cannot be null.");
3642
this.flow = Validation.notNull(flow, "Flow cannot be null.");
@@ -75,8 +81,8 @@ public <O> AiMatchHappen<O, D, I, RF, F> match(Operators.Whether<I> whether,
7581
/**
7682
* 提供一个默认的处理逻辑,并结束条件节点。
7783
*
78-
* @param processor 表示分支处理器的 {@link AiBranchProcessor}{@code <}{@link O}{@code , }{@link D}{@code ,
79-
* }{@link ?}{@code , }{@link RF}{@code , }{@link F}{@code >}。
84+
* @param processor 表示分支处理器的 {@link AiBranchProcessor}{@code <}{@link O}{@code , }{@link D}{@code ,?,
85+
* }{@link RF}{@code , }{@link F}{@code >}。
8086
* @param <O> 表示第一个条件分支指定的返回类型。
8187
* @return 表示条件节点的 {@link AiState}{@code <}{@link O}{@code , }{@link D}{@code , }{@link O}{@code ,
8288
* }{@link RF}{@code , }{@link F}{@code >}。

framework/fel/java/fel-flow/src/main/java/modelengine/fel/engine/activities/AiParallel.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@ public AiParallel(Parallel<D, I, RF> parallel, F flow) {
4040
/**
4141
* 生成平行节点的子分支。
4242
*
43+
* @param <O> 表示分支处理器的输入参数的类型。
4344
* @param processor 表示分支处理器的 {@link AiBranchProcessor}{@code <}{@link O}{@code , }{@link D}{@code ,
4445
* }{@link I}{@code , }{@link RF}{@code , }{@link F}{@code >}。
4546
* @return 表示平行节点子分支的 {@link AiFork}{@code <}{@link O}{@code , }{@link D}{@code , }{@link I}{@code ,

framework/fel/java/fel-flow/src/main/java/modelengine/fel/engine/activities/AiStart.java

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -397,6 +397,7 @@ public AiState<Content, D, O, RF, F> synthesize(Synthesizer<O> synthesizer) {
397397
/**
398398
* 将模型处理返回值的格式化解析。
399399
*
400+
* @param <R> 表示解析器的返回值类型。
400401
* @param parser 表示格式化解析器的 {@link Parser}{@code <}{@link R}{@code >}。
401402
* @return 表示格式化解析节点的 {@link AiState}{@code <}{@link O}{@code , }{@link D}{@code , }{@link O}{@code ,
402403
* }{@link RF}{@code , }{@link F}{@code >}。
@@ -505,8 +506,8 @@ public <R> AiState<R, D, O, RF, F> delegate(AiProcessFlow<O, R> aiFlow) {
505506
* @return 表示委托节点的 {@link AiState}{@code <}{@link R}{@code , }{@link D}{@code , }{@link O}{@code ,
506507
* }{@link RF}{@code , }{@link F}{@code >}。
507508
* @throws IllegalArgumentException <ul>
508-
* <li>当 {@code aiFlow} 为 {@code null}时。</il>
509-
* <li>当 {@code nodeId} 为 {@code null} 、空字符串或只有空白字符的字符串时。</il>
509+
* <li>当 {@code aiFlow} 为 {@code null}时。</li>
510+
* <li>当 {@code nodeId} 为 {@code null} 、空字符串或只有空白字符的字符串时。</li>
510511
* </ul>
511512
*/
512513
public <R> AiState<R, D, O, RF, F> delegate(AiProcessFlow<O, R> aiFlow, String nodeId) {

framework/fel/java/fel-flow/src/main/java/modelengine/fel/engine/flows/AiFlow.java

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,11 @@
2323
public class AiFlow<D, F extends Flow<D>> extends IdGenerator {
2424
private final F flow;
2525

26+
/**
27+
* 创建一个 AI 流程。
28+
*
29+
* @param flow 流程。
30+
*/
2631
public AiFlow(F flow) {
2732
this.flow = Validation.notNull(flow, "Flow cannot be null.");
2833
}

framework/fel/java/fel-flow/src/main/java/modelengine/fel/engine/flows/AiProcessFlow.java

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,11 @@ public class AiProcessFlow<D, R> extends AiFlow<D, ProcessFlow<D>>
3232
private final Map<EmitterListener<R, FlowSession>, EmitterListener<Object, FlowSession>> listeners =
3333
new ConcurrentHashMap<>();
3434

35+
/**
36+
* 创建一个流程。
37+
*
38+
* @param flow 表示流程。
39+
*/
3540
public AiProcessFlow(ProcessFlow<D> flow) {
3641
super(flow);
3742
}

framework/fel/java/fel-flow/src/main/java/modelengine/fel/engine/flows/ConverseLatch.java

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,22 +73,47 @@ public T await() {
7373
return this.data;
7474
}
7575

76+
/**
77+
* Returns the data.
78+
*
79+
* @return The data.
80+
*/
7681
public T data() {
7782
return this.data;
7883
}
7984

85+
/**
86+
* Sets the data.
87+
*
88+
* @param data The data.
89+
*/
8090
public void data(T data) {
8191
this.data = data;
8292
}
8393

94+
/**
95+
* Returns the throwable.
96+
*
97+
* @return The throwable.
98+
*/
8499
public Throwable throwable() {
85100
return this.throwable;
86101
}
87102

103+
/**
104+
* Sets the throwable.
105+
*
106+
* @param throwable The throwable.
107+
*/
88108
public void throwable(Throwable throwable) {
89109
this.throwable = throwable;
90110
}
91111

112+
/**
113+
* Returns the count-down latch.
114+
*
115+
* @return The count-down latch.
116+
*/
92117
public CountDownLatch countDownLatch() {
93118
return this.countDownLatch;
94119
}

framework/fel/java/fel-flow/src/main/java/modelengine/fel/engine/operators/models/ChatBlockModel.java

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,11 @@
77
package modelengine.fel.engine.operators.models;
88

99
import modelengine.fel.core.chat.ChatMessage;
10+
import modelengine.fel.core.chat.ChatModel;
1011
import modelengine.fel.core.chat.ChatOption;
1112
import modelengine.fel.core.chat.MessageType;
1213
import modelengine.fel.core.chat.Prompt;
1314
import modelengine.fel.core.chat.support.AiMessage;
14-
import modelengine.fel.core.chat.ChatModel;
1515
import modelengine.fel.core.memory.Memory;
1616
import modelengine.fel.core.model.BlockModel;
1717
import modelengine.fel.engine.util.AiFlowSession;
@@ -32,10 +32,21 @@ public class ChatBlockModel implements BlockModel<Prompt, ChatMessage> {
3232
private final ChatModel provider;
3333
private final ChatOption option;
3434

35+
/**
36+
* 创建一个阻塞对话模型。
37+
*
38+
* @param provider 聊天模型提供者。
39+
*/
3540
public ChatBlockModel(ChatModel provider) {
3641
this(provider, ChatOption.custom().build());
3742
}
3843

44+
/**
45+
* 创建一个阻塞对话模型。
46+
*
47+
* @param provider 聊天模型提供者。
48+
* @param option 聊天模型选项。
49+
*/
3950
public ChatBlockModel(ChatModel provider, ChatOption option) {
4051
this.provider = Validation.notNull(provider, "The model provider cannot be null.");
4152
this.option = Validation.notNull(option, "The chat options cannot be null.");

0 commit comments

Comments
 (0)