Skip to content

Commit

Permalink
Merge pull request #33 from raullese/master
Browse files Browse the repository at this point in the history
update usage example for MRC component
  • Loading branch information
seiriosPlus authored Jan 2, 2024
2 parents a880f95 + c67fdb9 commit 4756483
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions appbuilder/core/components/llms/mrc/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,11 +43,11 @@ print(result)

- `msg (obj:Message)`: 输入消息,包含用户提出的问题。这是一个必需的参数。
- `context_list (obj:Message)`: 用户输入的问题对应的段落文本列表。这是一个必需的参数。
- `reject (bool, 可选)`: 拒绝开关,如果为 True,则启用拒绝能力。默认为 False。
- `clarify (bool, 可选)`: 澄清开关,如果为 True,则启用澄清能力。默认为 False。
- `highlight (bool, 可选)`: 重点强调开关,如果为 True,则启用重点强调能力。默认为 False。
- `friendly (bool, 可选)`: 友好性提升开关,如果为 True,则启用友好性提升能力。默认为 False。
- `cite (bool, 可选)`: 溯源开关,如果为 True,则启用溯源能力。默认为 False。
- `reject (bool, 可选)`: 拒绝开关,如果为 True,则启用该能力。默认为 False。当输入的问题在context_list中没有找到答案时,开关开启时,模型会用特定话术("当前文档库找不到对应的答案,我可以尝试用我的常识来回答你。")做回复的开头,并后接自有知识做回复内容
- `clarify (bool, 可选)`: 澄清开关,如果为 True,则启用该能力。默认为 False。 当输入的问题比较模糊、或者主体指代不清晰,且context_list中包含有可以回答该模糊问题的多种潜在备选答案时,开启该开关,大模型会以特定的话术做澄清反问,引导用户继续补充问题发问。举例子,query:发电机的续航时间? Answer: 根据搜索结果得到了xx和xx两种型号的发电机,您的问题具体涉及到哪一个?请补充关键信息,作为完整的问题重新发问
- `highlight (bool, 可选)`: 重点强调开关,如果为 True,则启用该能力。默认为 False。开启该功能时,回复结果中会高亮显示关键部分的内容
- `friendly (bool, 可选)`: 友好性提升开关,如果为 True,则启用该能力。默认为 False。开关开启时,部分回复的开头会加礼貌用语。且如果回答涉及到大段的信息,会倾向于以<总-分>或者<总-分-总>的形式做分点论述,使得答案的格式更规整,可读性更强
- `cite (bool, 可选)`: 溯源开关,如果为 True,则启用该能力。默认为 False。开关开启时,回复内容后会接形如(^[1]^)的标记来表示回答内容在原文(context_list)中的来源索引。例如:按照当地公安机关出入境管理部门规定的其他材料办理^[2]^
- `stream (bool, 可选)`: 指定是否以流式形式返回响应。默认为 False。
- `temperature (float, 可选)`: 模型配置的温度参数,用于调整模型的生成概率。取值范围为 0.0 到 1.0,其中较低的值使生成更确定性,较高的值使生成更多样性。默认值为 1e-10。

Expand Down

0 comments on commit 4756483

Please sign in to comment.