IDOL Answer Server 12.0 Administration Guide
Total Page:16
File Type:pdf, Size:1020Kb
Answer Server Software Version 12.0 Administration Guide Document Release Date: June 2018 Software Release Date: June 2018 Administration Guide Legal notices Copyright notice © Copyright 2015-2018 Micro Focus or one of its affiliates. The only warranties for products and services of Micro Focus and its affiliates and licensors (“Micro Focus”) are set forth in the express warranty statements accompanying such products and services. Nothing herein should be construed as constituting an additional warranty. Micro Focus shall not be liable for technical or editorial errors or omissions contained herein. The information contained herein is subject to change without notice. Trademark notices Adobe™ is a trademark of Adobe Systems Incorporated. Microsoft® and Windows® are U.S. registered trademarks of Microsoft Corporation. UNIX® is a registered trademark of The Open Group. Documentation updates The title page of this document contains the following identifying information: l Software Version number, which indicates the software version. l Document Release Date, which changes each time the document is updated. l Software Release Date, which indicates the release date of this version of the software. To verify you are using the most recent edition of a document, go to https://softwaresupport.softwaregrp.com/group/softwaresupport/search-result?doctype=online help. You will also receive new or updated editions of documentation if you subscribe to the appropriate product support service. Contact your Micro Focus sales representative for details. To check for new versions of software, go to https://www.hpe.com/software/entitlements. To check for recent software patches, go to https://softwaresupport.softwaregrp.com/patches. The sites listed in this section require you to sign in with a Software Passport. You can register for a Passport through a link on the site. Support Visit the Micro Focus Software Support Online website at https://softwaresupport.softwaregrp.com. This website provides contact information and details about the products, services, and support that Micro Focus offers. Micro Focus online support provides customer self-solve capabilities. It provides a fast and efficient way to access interactive technical support tools needed to manage your business. As a valued support customer, you can benefit by using the support website to: l Search for knowledge documents of interest l Submit and track support cases and enhancement requests l Access the Software Licenses and Downloads portal l Download software patches l Access product documentation l Manage support contracts l Look up Micro Focus support contacts l Review information about available services l Enter into discussions with other software customers l Research and register for software training Answer Server (12.0) Page 2 of 151 Administration Guide Most of the support areas require you to register as a Passport user and sign in. Many also require a support contract. You can register for a Software Passport through a link on the Software Support Online site. To find more information about access levels, go to https://softwaresupport.softwaregrp.com/web/softwaresupport/access-levels. Answer Server (12.0) Page 3 of 151 Administration Guide Contents Part I: Get Started With Answer Server 9 Chapter 1: Introduction 11 Answer Server System Architecture 12 Answer Bank 12 Fact Bank 13 Passage Extractor 13 Conversation 14 OEM Certification 14 Chapter 2: Install and Set Up Answer Server 15 Install Answer Server 15 External Dependencies 16 Install an IDOL Component as a Service on Windows 16 Install an IDOL Component as a Service on Linux 18 Install a Component as a Service for a systemd Boot System 18 Install a Component as a Service for a System V Boot System 19 Licenses 20 Display License Information 20 Configure the License Server Host and Port 21 Revoke a Client License 22 Troubleshoot License Errors 22 Chapter 3: Configure Answer Server 25 General Configuration 25 Configure Answer Server Systems 26 Configure an Answer Bank System 26 Configure a Fact Bank System 26 Configure a Passage Extractor System 27 Configure a Conversation System 27 Configure a Remote System 27 Language Configuration 28 Answer Bank Language Configuration 28 Fact Bank and Passage Extractor Language Configuration 28 Configure Client Authorization 29 Configure SSL Communication Between Components 30 Customize Logging 31 Validate the Configuration File 32 Chapter 4: Run Answer Server 35 Start Answer Server 35 Stop Answer Server 35 Verify that Answer Server is Running 36 GetStatus 36 Answer Server (12.0) Page 4 of 151 Administration Guide GetLicenseInfo 36 Send Actions to Answer Server 37 Part II: Configure Answer Server Systems 39 Chapter 5: Set Up an Answer Bank System 41 Configure the Answer Bank System 41 Configure the Answer Bank Agentstore 42 Manage an Answer Bank 42 Find the JSON Schema for Your Update 43 Add a Question 43 Find the Likelihood of Existing Answers 44 Find the Likely Answers to a Question 44 Question Equivalence Rules 44 Special Rule Types 45 Generate a Question Equivalence Rule 46 Test Your Question Equivalence Rule 47 Find Questions that Do Not Match the Rule 47 Find Questions in Other Classes that Match the Rule 47 Test Whether Questions Match a Specified Rule 48 Create a Question Equivalence Class and Add an Answer 49 Update a Question Equivalence Class 50 Update the Question State 52 Automatic Question State Updates 52 Update the Question State Manually 52 Delete a Question or Question Equivalence Class 53 Undelete a Question or Question Equivalence Class 54 Modify the Expiration Time 55 Check the Status of an Update 55 Store Statistics for Your Answer Bank 56 Retrieve the Information Stored in an Answer Bank 57 GetResources 57 GetStats 58 Chapter 6: Set Up a Fact Bank System 59 Configure the Fact Bank System 59 Configure a Fact Bank with a SQL Database Fact Store 60 Configure a Fact Bank to Call a Lua Script 61 Configure the Fact Store 62 Set Up a SQL Backend as Fact Store 62 Manage Your Tables 63 Facts Table 63 Qualifiers Table 64 Sources Table 65 Security_Types Table 65 SQL Fact Store Example 66 Use a Lua Scripts to Retrieve Facts 68 Answer Server (12.0) Page 5 of 151 Administration Guide Create a Fact Retrieval Script 68 Create Coding Files 69 Example Data 70 Generate the Property Code Files 70 Generate the Entity Code Files 71 Generate the Fact Store Data 71 Create a Fact Store Table for a SQL Database 71 The Question Parser Eduction Grammar 72 Processors 73 Example Questions 73 Modify the Question Parser Eduction Grammar 75 Configure Security in Fact Bank 75 Configure the Security Types in Answer Server 76 Set Up Fact Store Tables for Security 77 Chapter 7: Set Up a Passage Extractor System 79 Configure the Passage Extractor System 79 Change the Passage Extractor Language 80 Train Passage Extractor Classifiers 81 Create a Training File 81 Train a Classifier 82 Classifier Behavior File 82 Training File Labels 83 Entity Extraction in Passage Extractor 85 Configure the Passage Extractor Agentstore 86 Configure the Agentstore Component 86 Index Entity Agents 87 Customize Entity Extraction 87 The Entity Extraction File Format 88 Modify the Entity Extraction File 89 Use a Different Entity Extraction File 90 Troubleshoot Passage Extractor 90 Chapter 7: Set Up a Remote Answer System 91 Configure a Remote Answer System 91 Use a Remote Answer System 93 Chapter 8: Use System Groups 95 Configure a System Group 95 Ask Questions to a System Group 96 Chapter 9: Ask Questions in Answer Server 99 Ask a Question 99 Use Context in the Ask Action 100 Create a Context 100 Use a Question Context 101 Configure Context Expiration 101 Chapter 10: Set Up a Conversation System 103 Configure the Conversation System 103 Answer Server (12.0) Page 6 of 151 Administration Guide Create a Task Configuration File 104 Pre-Task Actions 105 Conversation Triggers 106 Agent Triggers 107 Regular Expressions Triggers 108 Simple Triggers 109 Task Disambiguation 111 Trigger Options 112 Task Requirements 113 Automatic Requirement Gathering 116 Response Validation 117 Simple Validation 118 Regular Expression Validator 119 Eduction Validator 120 Lua Validator 121 Process Non-Valid Input 121 Post-Task Actions 123 Task Routing 125 Configure Simple Routing 125 Configure Conditional Routing 126 Use Routing in a Lua Function 128 Lua Processing Scripts 128 Default Tasks 129 Initial Task 129 Fallback Task 130 Default Messages 130 Response for Non-Valid Input 130 Response for Disambiguation 131 Response for Multiple Answer Disambiguation 132 Task Cancellation 135 User Cancellation 135 System Cancellation 136 Task Configuration Example 137 Configure the Conversation Agentstore 137 Configure the Agentstore Component 137 Configure the Conversation System to Use Agentstore 138 Index Conversation Trigger Agents 138 Chapter 11: Hold Conversations in Answer Server 139 Hold a Conversation 139 Create a Conversation Session 139 Retrieve Active Conversation Sessions 140 Start and Continue a Conversation 140 Close a Conversation Session 140 Retrieve a Conversation Transcript 141 Chapter 11: Use Natural Language Generation in Answer Server 141 Configure Natural Language Generation 141 Answer Server (12.0) Page 7 of 151 Administration Guide Run Natural Language Generation 142 Part III: Appendixes 145 Appendix A: Debug Your Conversation Lua Scripts 147 Glossary 149 Send documentation feedback 151 Answer Server (12.0) Page 8 of 151 Part I: Get Started With Answer Server This section introduces Micro Focus Answer Server and describes how to install and run the server. l Introduction, on page 11 l Install and Set Up Answer Server, on page 15 l Configure Answer Server, on page 25 l Run Answer Server, on page 35 Page 9 of 151 Answer Server (12.0) Administration Guide Part I: Get Started With Answer Server Page 10 of 151 Answer Server (12.0) Chapter 1: Introduction Micro Focus Answer Server uses IDOL technology to provide specific and concise answers to user questions.