# FAQ
FAQ 模块包含了单条 FAQ,FAQ 分类和所有 FAQ 分类,并且支持通过配置以不同的方式跳转到机器人和人工服务。
# API
# ShowAllFAQSections()
你可以通过配置来展示分类列表,支持 FAQ 的搜索,并支持在合适的位置展示客服系统入口,并根据需求进行自定义配置:
FAIHelpForUEModule::Get().GetAIHelp()->ShowAllFAQSections(
EAIHelpConversationMoment::Always,
EAIHelpConversationIntent::Human,
false,
"This is a welcome message for FAQ.",
"THE SAME CONTENT AS YOUR SPECIFIC 'User Say' CONFIGURATION"
);
# ShowFAQSection()
不同于展示全部分类列表,AIHelp 支持在某些特殊场景下单独展示某个 FAQ 分类,并根据需求进行自定义配置:
FAIHelpForUEModule::Get().GetAIHelp()->ShowFAQSection(
"SECTION ID",
EAIHelpConversationMoment::OnlyInAnswerPage,
EAIHelpConversationIntent::Bot,
false,
"This is a welcome message for FAQ.",
"THE SAME CONTENT AS YOUR SPECIFIC 'User Say' CONFIGURATION"
);
# ShowSingleFAQ()
你可以通过调用此方法来展示某个特定的 FAQ 问题,并根据需求进行自定义配置:
FAIHelpForUEModule::Get().GetAIHelp()->ShowSingleFAQ(
"FAQ ID",
EAIHelpConversationMoment::AfterMarkingUnhelpful,
EAIHelpConversationIntent::Bot,
true,
"This is a welcome message for FAQ.",
"THE SAME CONTENT AS YOUR SPECIFIC 'User Say' CONFIGURATION"
);
# 参数释义
# showConversationMoment
- 类型:
EAIHelpConversationMoment
- 默认值:
EAIHelpConversationMoment::Never
- 详情:可选参数。 FAQ 页面展示联系客服按钮的时机,可选值:常显、不显、详情页显示、点踩后显示。
# conversationIntent
- 类型:
EAIHelpConversationIntent
- 默认值:
EAIHelpConversationIntent::Bot
- 详情:可选参数。 客服系统的跳转意图。
# alwaysShowHumanSupportButtonInBotPage
- 类型:
bool
- 默认值:
false
- 详情:可选参数。 机器人常显人工入口。
# welcomeMessage
- 类型:
FString
- 默认值:
''
- 详情:可选参数。 人工客服自定义欢迎语,自定义传参。
# storyNode
- 类型:
FString
- 默认值:
''
- 详情:可选参数。 特定故事线的入口节点,故事线配置内容。
# sectionId
- 类型:
FString
- 详情:必传参数。 要展示的 FAQ 分类的分类 ID,可在 AIHelp 后台图示位置获取:
# faqId
- 类型:
FString
- 详情:必传参数。 要展示的特定 FAQ 的 ID,可在 AIHelp 后台图示位置获取:
# 页面示例
AIHelp 页面显示示例如下: