# FAQ

The FAQ module contains a single FAQ, FAQ section and all FAQ categories, and supports different ways to jump to robot and human services through configuration.

# API

# ShowAllFAQSections()

You can call this function to display the FAQ section list, you can search a specific FAQ, show the entrance of AIHelp conversation system in the appropriate location:

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()

Different from displaying all FAQ sections, AIHelp supports displaying a FAQ section separately in some special scenarios:

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()

You can show a specific FAQ question by calling this method:

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" 
);

# Definition

# showConversationMoment

  • Type: EAIHelpConversationMoment
  • Default: EAIHelpConversationMoment::Never
  • Details: Optional. When to show conversation entrance in FAQ page, always / never / after-marking-unhelpful / only-in-answer-page

# conversationIntent

  • Type: EAIHelpConversationIntent
  • Default: EAIHelpConversationIntent::Bot
  • Detail: Optional. Intent for customer service display

# alwaysShowHumanSupportButtonInBotPage

  • Type: bool
  • Default: false
  • Detail: Optional. Entrance visibility for human support button in bot page

# welcomeMessage

  • Type: FString
  • Default: ''
  • Detail: Optional. Custom welcome message for human support

# storyNode

  • Type: FString
  • Default: ''
  • Detail: Optional. Entrance node for specific story line, a.k.a: story lines' user say

# sectionId

  • Type: FString
  • Default: ''
  • Details: Required. The ID of the FAQ section about to display, you can get it at here:

# faqId

  • Type: FString
  • Default: ''
  • Details: Required. The ID of the specific FAQ about to display, you can get it at here:

# Page Example

Page examples based on the above scenario are as follows:

Last Updated: 8/1/2023, 2:02:11 AM