diff --git a/README.md b/README.md
index a0ff5aba90..943ab4ed58 100644
--- a/README.md
+++ b/README.md
@@ -9,14 +9,11 @@ This repository generates LivePerson's Developer Center, which can be found at h
**Table of Contents**
-* :satellite:[Updating the Documentation](https://github.com/LivePersonInc/developers-community#updating-the-documentation)
-
-* :hammer:[Building the Site Locally](https://github.com/LivePersonInc/developers-community#building-the-site-locally)
-
-* :clipboard:[Template](https://github.com/LivePersonInc/developers-community#template)
-
-* :scroll:[Licensing](https://github.com/LivePersonInc/developers-community#licensing)
-
+* :satellite: [Updating the Documentation](https://github.com/LivePersonInc/developers-community#updating-the-documentation)
+* :hammer: [Building the Site Locally](https://github.com/LivePersonInc/developers-community#building-the-site-locally)
+* :clipboard: [Template](https://github.com/LivePersonInc/developers-community#template)
+* :scroll: [Licensing](https://github.com/LivePersonInc/developers-community#licensing)
+* :ghost: [How to Hide files and still make them Accessible](https://github.com/LivePersonInc/developers-community#hiding-files)
### Updating the Documentation
All pages on the site correspond to a Markdown file (.md) which can be found inside `pages/Documents`.
@@ -146,7 +143,7 @@ Jekyll uses a [front-matter](https://jekyllrb.com/docs/frontmatter/) to arrange
* `keywords`: This replaces the keywords found in the `` tag of the page. Leave it unpopulated.
-* `documentname`: This key accepts either `Documents` or `Solutions`. This designates which part of the site the document is under.
+* `sitesection`: This key accepts either `Documents` or `Solutions`. This designates which part of the site the document is under.
* `categoryname`: This is the category to which the document's API belongs (for example, the "Create Users" method belongs to the Users API which is under Contact Center Management).
@@ -162,6 +159,14 @@ Jekyll uses a [front-matter](https://jekyllrb.com/docs/frontmatter/) to arrange
* `indicator`: this key sets the Chat or Messaging indicator (or both) on a document. It accepts `chat`, `messaging` or `both` as its value.
+* `layout`: set the value to `hidden-layout` if you want this file to be ignored in search engines
+
+### Hiding Files
+* Add the Files to the Hidden->Hidden folder.
+* Do not include them to documentsupdated.yaml file.
+* Make sure Layout header is set to `hidden-layout` (This specifically makes it so search engines can't find it)
+* Make sure that the headers are set correctly follow the file header structure of `blank.md` in the Hidden->Hidden folder
+
**Any other parameters which are not documented here which you might find in the front-matter are deprecated and are only present for backwards compatibility purposes. These should not be used**.
@@ -203,6 +208,10 @@ You have two options to run the site locally after the first install:
See the `_template` folder above for a complete template of a simple REST API. Other templates will follow in the future. However, if you have a unique API to document or need further assistance, please reach out to Product Communications *before* starting to write your document so that we can advise on its structure.
+### Algolia
+Aloglia is the tool we use for the search bar. It generates a list of searchable items by indexing it in their dashboard which is then pulled into the search bar within the project
+
+To get the latest data to be added into algolia simply do a pull request on the production branch (master)
### Licensing
diff --git a/_config.yml b/_config.yml
index 4da1f89d32..8d19fd8a90 100644
--- a/_config.yml
+++ b/_config.yml
@@ -35,6 +35,9 @@ plugins:
algolia:
application_id: "EICOREWTRW"
index_name: "devMain"
+ #also index the following html elements
+ nodes_to_index: 'code,p,blockquote,li,div.paragraph'
+
# #values for the Algolia plugin
diff --git a/_data/documentsupdated.yaml b/_data/documentsupdated.yaml
index ca2b95f5ca..5bba03e881 100644
--- a/_data/documentsupdated.yaml
+++ b/_data/documentsupdated.yaml
@@ -14,6 +14,7 @@
- pagename: API Data Metrics
- pagename: Engagement Attributes
- pagename: Analytics Builder Data Metrics
+ - pagename: Important Updates
- pagename: Retry Policy Recommendations
- categoryname: Agent Experience
@@ -115,17 +116,32 @@
- categoryname: Conversational AI
image: agent-experience
documents:
- - documentname: Conversational AI
+ - documentname: Platform Overview
+ - documentname: Tutorials & Guides
pages:
- - pagename: Overview
- - documentname: Conversation Builder
- pages:
- - pagename: Tutorials & Guides
+ - pagename: Getting Started With Bot Building
+ subpages:
+ - subpagename: Overview
+ - subpagename: Dialogs & Patterns
+ - subpagename: Intents
+ - subpagename: Integrations
+ - subpagename: Disambiguation
+ - subpagename: Deploy the Bot
+ - subpagename: Escalate to an Agent
+ - pagename: Bot Groups & Other Techniques
+ subpages:
+ - subpagename: Overview
+ - subpagename: Bot Groups & Collaboration
+ - subpagename: Complex Conditions
+ - subpagename: Auto Escalation
+ - subpagename: Knowledge Bases
+ - subpagename: Meta Intents
+ - pagename: Advanced Integrations
subpages:
- - subpagename: Getting Started
- - subpagename: Using Meta Intents with Conversation Builder
- subpagename: Implementing a Web View Integration
- subpagename: Using LivePerson Functions with a Bot
+ - documentname: Conversation Builder
+ pages:
- pagename: Bot Workspace
- pagename: Bots
subpages:
@@ -144,6 +160,7 @@
- subpagename: Simple FAQ
- subpagename: Simple Lead Gen
- subpagename: Simple Router
+ - subpagename: Store Locator
- subpagename: Travel Notification
- subpagename: Maven Concierge
- pagename: Dialogs
@@ -153,6 +170,7 @@
- subpagename: Fallback Dialogs
- subpagename: Disambiguation Dialogs
- subpagename: Auto Escalation Dialogs
+ - pagename: Dialog Templates
- pagename: Interactions
subpages:
- subpagename: Interaction Basics
@@ -190,7 +208,7 @@
- subpagename: Send Messages
- subpagename: Manage Conversation Flow
- subpagename: Log & Debug
- - subpagename: Manage the Context Session Store
+ - subpagename: Manage the Conversation Context Service
- subpagename: askMaven
- subpagename: Deprecated Functions
- pagename: Testing & Deployment
@@ -198,9 +216,11 @@
- subpagename: Previewing
- subpagename: Debugging
- subpagename: Deploying to Conversational Cloud
+ - subpagename: Testing & Debugging Post-Deployment
- pagename: Advanced Use Cases
- pagename: Best Practices
subpages:
+ - subpagename: Conversational Design
- subpagename: Train & Tune NLU
- subpagename: Custom Event Logging
- subpagename: Reusable Components
@@ -212,14 +232,18 @@
- pagename: Agent Assist
subpages:
- subpagename: Overview
- - subpagename: Recommended Actions for Automations
- - subpagename: Recommended Actions for Knowledge Base
- - pagename: Context Warehouse
+ - subpagename: Setting Up Bot Recommendations
+ - subpagename: Setting Up Knowledge Base Recommendations
+ - subpagename: Testing
+ - subpagename: Agent Experience
+ - subpagename: Best Practices
+ - subpagename: Troubleshooting
+ - pagename: Conversation Context Service
subpages:
- subpagename: Overview
- subpagename: Inbox System Attributes
- subpagename: Custom Static or Function
- - subpagename: Context Session Store
+ - subpagename: Conversation Context Service
- pagename: Dynamic Routing
subpages:
- subpagename: Overview
@@ -238,24 +262,47 @@
- pagename: Intents
- pagename: Meta Intents
- pagename: Entities
+ - pagename: Testing
+ subpages:
+ - subpagename: Single Utterance Testing
+ - subpagename: Advanced Model Testing
- documentname: Intent Analyzer
pages:
- pagename: Overview
- documentname: Knowledge Base
pages:
- pagename: Overview
- - pagename: Knowledge Bases
- - pagename: Articles
- - pagename: Tutorial
+ - pagename: External Knowledge Bases
+ subpages:
+ - subpagename: Introduction
+ - subpagename: External KBs with LivePerson AI
+ - subpagename: External KBs without LivePerson AI
+ - subpagename: Mapping Content Metadata
+ - subpagename: Writing a Transformation Specification
+ - subpagename: Best Practices
+ - pagename: Internal Knowledge Bases
+ subpages:
+ - subpagename: Introduction
+ - subpagename: Knowledge Bases
+ - subpagename: Articles
+ - subpagename: Best Practices
+ - subpagename: Limits
+ - pagename: Using Intents with KBs
+ - pagename: Sending Content to Consumers
+ - pagename: Common Settings & Tasks
- documentname: Bots Status
pages:
- pagename: Overview
- pagename: Managing Custom Bots
- pagename: Managing Post-Conversation Survey Bots
+ - pagename: Alerts
- documentname: Bot Analytics
pages:
- pagename: Overview
- - pagename: Leveraging Analytics
+ - pagename: Account-Level Performance
+ - pagename: Bot Performance
+ - pagename: Transcripts
+ - pagename: Tuning Opportunities
- pagename: Troubleshooting
- documentname: Bot Accounts
pages:
@@ -265,15 +312,22 @@
pages:
- pagename: Getting Started
- pagename: Bot Status Dashboard
+ - pagename: Bot Conversation Errors
- pagename: Google Dialogflow
- pagename: Google Dialogflow Version 2
- pagename: IBM Watson Assistant
- pagename: IBM Watson Assistant Version 2
- pagename: Amazon Lex
- - pagename: Microsoft Bot Framework
+ - pagename: Microsoft Direct Line
+ subpages:
+ - subpagename: Introduction
+ - subpagename: Basic Content
+ - subpagename: Advanced Features
+ - subpagename: PVA
- pagename: Custom Integration
- pagename: Hook Configuration
- pagename: Public API
+
- documentname: Messaging Agent SDK
pages:
- pagename: Overview
@@ -363,8 +417,8 @@
- subpagename: Conversation Metadata
- subpagename: Read and Accept Events
- subpagename: Authentication
- - subpagename: Post Conversation Survey (PCS)
- - subpagename: Post Conversation Survey (CSAT)
+ - subpagename: Legacy - Post Conversation Survey (PCS)
+ - subpagename: Legacy - Post Conversation Survey (CSAT)
- subpagename: Client Properties
- subpagename: Avoid Websocket Headers
- subpagename: CoBrowse
@@ -653,6 +707,7 @@
- pagename: Deployment
- pagename: Monitoring
subpages:
+ - subpagename: Activities
- subpagename: Logs
- subpagename: Metrics
- subpagename: Email Reporting
@@ -673,7 +728,7 @@
- subpagename: Conversational AI
- subpagename: Conversational Commands
-- categoryname: Historical Data
+- categoryname: Reporting
image: historical-data
documents:
- documentname: Consumer Messaging History API
@@ -731,7 +786,49 @@
- pagename: Methods
subpages:
- subpagename: Retrieve Data Usage Logs
+ - documentname: Agent Metrics API
+ basedomain: https://{domain}/messaging_history/api/account/{accountID}/agent-view
+ pages:
+ - pagename: Overview
+ - pagename: Methods
+ subpages:
+ - subpagename: Agent Status
+ - subpagename: Agent List
+ - subpagename: Summary
+ - documentname: Messaging Operations API
+ basedomain: https://{domain}/operations/api/account/{accountID}
+ pages:
+ - pagename: Overview
+ - pagename: Methods
+ subpages:
+ - subpagename: Messaging Conversation
+ - subpagename: Messaging Queue Health
+ - subpagename: Messaging Current Queue Health
+ - subpagename: Messaging Estimated Wait Time
+ - subpagename: Messaging CSAT Distribution
+ - subpagename: Messaging Skill Segment
+ - subpagename: Messaging Agent Segment
+ - subpagename: Messaging Queue Health By Group
+ - pagename: Appendix
+ - documentname: Operational Realtime API
+ basedomain: https://{domain}/operations/api/account/{accountID}
+ pages:
+ - pagename: Overview
+ - pagename: Methods
+ subpages:
+ - subpagename: Queue Health
+ - subpagename: Engagement Activity
+ - subpagename: Agent Activity
+ - subpagename: Current Queue State
+ - subpagename: SLA Histogram
+ - documentname: Key Messaging Metrics API
+ basedomain: https://{domain}/manager_workspace/api/account/{accountID}
+ pages:
+ - pagename: Overview
+ - pagename: Methods
+ subpages:
+ - subpagename: Metrics
- categoryname: Messaging Channels
image: agent-interaction
documents:
@@ -780,6 +877,7 @@
- subpagename: Welcome Message with Quick Replies
- subpagename: Scroll Behavior Configuration
- subpagename: Logging
+ - subpagename: Proactive and IVR Deflection to App Messaging
- pagename: SDK APIs
subpages:
- subpagename: Messaging API
@@ -811,22 +909,31 @@
- documentname: Mobile App Messaging SDK for iOS
pages:
- pagename: Overview
+ - pagename: Configure the iOS SDK
+ - pagename: Push Notifications
- pagename: Quick Starts
subpages:
- subpagename: Quick Start 5.2.1 and below
- subpagename: Quick Start - 6.0 and up (XCFramework support)
- - pagename: Configure the iOS SDK
- - pagename: Push Notifications
+ - pagename: Advanced Configuration
+ subpages:
+ - subpagename: App Extensions
+ - subpagename: Conversations Lifecycle
+ - subpagename: SDK Delegates
+ - subpagename: UI
+ - subpagename: User Data
- pagename: Advanced Features
subpages:
- subpagename: Audio Messages
- subpagename: Campaigns
+ - subpagename: Certificate Pinning
- subpagename: CSAT Behavior
+ - subpagename: Logging
+ - subpagename: Proactive and IVR Deflection to App Messaging
- subpagename: Photo and File Sharing
+ - subpagename: Scroll Behavior Configuration
- subpagename: Unauthenticated In-App Messaging
- subpagename: Welcome Message with Quick Replies
- - subpagename: Scroll Behavior Configuration
- - subpagename: Logging
- pagename: SDK APIs
subpages:
- subpagename: Messaging API
@@ -836,9 +943,10 @@
- subpagename: Callbacks Index
- pagename: SDK Attributes
subpages:
+ - subpagename: Attributes Design Sheet
+ - subpagename: Deprecated Attributes
- subpagename: SDK 5.0 and above
- subpagename: SDK 4.1 and below
- - subpagename: Attributes Design Sheet
- pagename: String Localization
subpages:
- subpagename: Localization Keys
@@ -849,9 +957,11 @@
- subpagename: All Releases
- pagename: Resources
subpages:
+ - subpagename: About XCFrameworks
- subpagename: Authentication
+ - subpagename: Customizing Toast Notifications
+ - subpagename: FAQ
- subpagename: Open Source List
- - subpagename: Upgrade Guide - iOS
- documentname: Apple Business Chat SDK
pages:
- pagename: Overview
@@ -868,46 +978,6 @@
pages:
- pagename: API
-- categoryname: Real Time Data
- image: rt-data
- documents:
- - documentname: Agent Metrics API
- basedomain: https://{domain}/messaging_history/api/account/{accountID}/agent-view
- pages:
- - pagename: Overview
- - pagename: Methods
- subpages:
- - subpagename: Agent Status
- - subpagename: Agent List
- - subpagename: Summary
- - documentname: Messaging Operations API
- basedomain: https://{domain}/operations/api/account/{accountID}
- pages:
- - pagename: Overview
- - pagename: Methods
- subpages:
- - subpagename: Messaging Conversation
- - subpagename: Messaging Queue Health
- - subpagename: Messaging Current Queue Health
- - subpagename: Messaging Estimated Wait Time
- - subpagename: Messaging CSAT Distribution
- - subpagename: Messaging Skill Segment
- - subpagename: Messaging Agent Segment
- - subpagename: Messaging Queue Health By Group
-
- - pagename: Appendix
- - documentname: Operational Realtime API
- basedomain: https://{domain}/operations/api/account/{accountID}
- pages:
- - pagename: Overview
- - pagename: Methods
- subpages:
- - subpagename: Queue Health
- - subpagename: Engagement Activity
- - subpagename: Agent Activity
- - subpagename: Current Queue State
- - subpagename: SLA Histogram
-
- categoryname: Rich Messaging
image: rich-media
documents:
@@ -945,6 +1015,12 @@
- pagename: Quick Replies Template
- pagename: Best Practices
- pagename: Limitations
+ - documentname: Google Business Messages Templates
+ pages:
+ - pagename: Introduction
+ - pagename: Card Template
+ - pagename: Carousel Template
+ - pagename: Quick Replies Template
- documentname: Google RCS Business Messaging Templates
pages:
- pagename: Introduction
@@ -965,14 +1041,10 @@
- documentname: Cookies and Conversational Cloud
pages:
- pagename: Overview
- - documentname: Apple Business Chat Authentication
- pages:
- - pagename: Overview
- - documentname: Mobile SDK and Web Authentication
+ - documentname: Consumer Authentication
pages:
- pagename: Introduction
- - pagename: Major Components
- - pagename: Security
+ - pagename: Implementation Considerations
- pagename: Configuration
- pagename: How It Works
- pagename: Detailed API
@@ -1002,6 +1074,9 @@
- subpagename: Application Login
- subpagename: Refresh
- subpagename: Logout
+ - documentname: Apple Business Chat Authentication
+ pages:
+ - pagename: Overview
- documentname: MTLS
pages:
- pagename: Overview
diff --git a/_data/releasenotesandroid.yaml b/_data/releasenotesandroid.yaml
index c79f8c1b47..d02870c2f0 100644
--- a/_data/releasenotesandroid.yaml
+++ b/_data/releasenotesandroid.yaml
@@ -1,10 +1,15 @@
- operatingsystem: Android
releases:
- - releasename: 5.3.0
+ - releasename: 5.5.0
+ - releasename: Mobile App Messaging SDK for Android Release Notes 5.4.0
+ - releasename: Mobile App Messaging SDK for Android Release Notes 5.3.0
- releasename: Mobile App Messaging SDK for Android Release Notes 5.2.0
- releasename: Mobile App Messaging SDK for Android Release Notes 5.1.1
- releasename: Mobile App Messaging SDK for Android Release Notes 5.1.0
- releasename: Mobile App Messaging SDK for Android Release Notes 5.0.0
+ - releasename: Mobile App Messaging SDK for Android Release Notes 4.7.0
+ - releasename: Mobile App Messaging SDK for Android Release Notes 4.6.1
+ - releasename: Mobile App Messaging SDK for Android Release Notes 4.6.0
- releasename: Mobile App Messaging SDK for Android Release Notes 4.5.0
- releasename: Mobile App Messaging SDK for Android Release Notes 4.4.2
- releasename: Mobile App Messaging SDK for Android Release Notes 4.4.1
diff --git a/_data/releasenotesios.yaml b/_data/releasenotesios.yaml
index 835e58198a..752f0cc4fd 100644
--- a/_data/releasenotesios.yaml
+++ b/_data/releasenotesios.yaml
@@ -2,6 +2,7 @@
#Additional Release
Additional:
versions: [
+ { version: "5.2.2" },
{ version: "5.2.1" },
{ version: "5.1.2" },
{ version: "5.0.1" },
@@ -20,6 +21,9 @@ Limited:
#Regular Release
Regular:
versions: [
+ { version: "6.2.0" },
+ { version: "6.1.0" },
+ { version: "6.0.1" },
{ version: "6.0.0" },
{ version: "5.2.0" },
{ version: "5.1.1" },
diff --git a/_exclude/ShiftStatusGuide.md b/_exclude/ShiftStatusGuide.md
index 296ceb40a8..ee0755124d 100644
--- a/_exclude/ShiftStatusGuide.md
+++ b/_exclude/ShiftStatusGuide.md
@@ -26,7 +26,7 @@ For the purpose of configuring these APIs, we will need the following:
#### Bearer token retrieval
-For authorization purposes, these API requires that a bearer token be passed along in an authorization header. To retrieve this bearer token, we'll take advantage of the [getLPEngagementAttribute](conversation-builder-scripting-functions-get-set-contextual-data.html#get-current-and-previous-skills) scripting function. Insert the following code within the `__initConversation()` function inside of **Global Functions**.
+For authorization purposes, these API requires that a bearer token be passed along in an authorization header. To retrieve this bearer token, we'll take advantage of the [getLPEngagementAttribute](conversation-builder-scripting-functions-get-set-contextual-data.html#get-lp-engagement-attribute) scripting function. Insert the following code within the `__initConversation()` function inside of **Global Functions**.
```javascript
// Bearer Token Needed for Messaging Queue Health & Shift Status APIs
diff --git a/_exclude/deprecatedScriptingFunctions.md b/_exclude/deprecatedScriptingFunctions.md
index e1ef4dcb32..3a2da7e3db 100644
--- a/_exclude/deprecatedScriptingFunctions.md
+++ b/_exclude/deprecatedScriptingFunctions.md
@@ -76,3 +76,25 @@ if (email != null) {
}
```
+The following scripting function was never re-added to the Dev Center (after being removed at one point) because getUserChannel exists. (07-25-2020)
+
+### Get user platform type
+Returns the type of platform that the user is currently communicating on. This function returns:
+
+* SMS
+* INAPP (for In-app SDK)
+* FACEBOOK
+* ABC (for Apple Business Chat)
+* RCS
+* WHATSAPP
+
+| Function Name | Arguments | Returns |
+| --- | --- | --- |
+| `getUserPlatformType()` | None | SMS, INAPP, FACEBOOK, ABC, RCS, or WHATSAPP |
+
+#### Example
+
+```javascript
+var channel = botContext.getUserPlatformType();
+botContext.printDebugMessage("channel used by the user is: " + channel);
+```
\ No newline at end of file
diff --git a/pages/Documents/ConversationalAI/ConversationBuilder/Tutorials&Guides/getting-started.md b/_exclude/getting-started.md
similarity index 96%
rename from pages/Documents/ConversationalAI/ConversationBuilder/Tutorials&Guides/getting-started.md
rename to _exclude/getting-started.md
index 48fb7fcfe7..e4b9447478 100644
--- a/pages/Documents/ConversationalAI/ConversationBuilder/Tutorials&Guides/getting-started.md
+++ b/_exclude/getting-started.md
@@ -1,23 +1,7 @@
----
-pagename: Getting Started
-redirect_from:
- - conversation-builder-getting-started-0-video-tutorials.html
- - conversation-builder-getting-started-1-dialogs-and-patterns.html
- - conversation-builder-getting-started-getting-started-part-1.html
- - conversation-builder-getting-started-2-intents.html
- - conversation-builder-getting-started-getting-started-part-2.html
- - conversation-builder-getting-started-3-integrations.html
- - conversation-builder-getting-started-getting-started-part-3.html
- - conversation-builder-getting-started-4-connect-to-liveengage.html
- - conversation-builder-getting-started-getting-started-part-4.html
-Keywords:
-sitesection: Documents
-categoryname: "Conversational AI"
-documentname: Conversation Builder
-subfoldername: Tutorials & Guides
-permalink: conversation-builder-tutorials-guides-getting-started.html
-indicator: both
----
+THIS IS AN ARCHIVE OF THE OLD GETTING STARTED TUTORIALS FOR CB.
+
+{: .important}
+Did you know that LivePerson has a Conversational AI forum for builders? Check it out [here](https://talkyard.livepersonai.com/)!
### Overview
@@ -233,11 +217,11 @@ Since you’re going to be using an intent in this tutorial, you need to leave t
11. In the upper-left corner, click **Entities**.
-12. On the Add Entity page, create a new entity named "bill" and add a number of entity values (synonyms) like `bill`, `billing`, `payment`, and `statement`. Press Enter to add each one.
+12. On the Add Entity page, create a new entity named "bill." Select "Value Set" as the **Entity type**, and add a number of entity values (synonyms) like `bill`, `billing`, `payment`, and `statement`. Press Enter to add each one.
- 
+
-13. Click **Add Entity** in the lower-right corner.
+13. Click **Save** in the lower-right corner.
Now let's see how adding an entity can improve the NLU matching.
diff --git a/_exclude/kb_archive.md b/_exclude/kb_archive.md
new file mode 100644
index 0000000000..72bb5bd145
--- /dev/null
+++ b/_exclude/kb_archive.md
@@ -0,0 +1,61 @@
+This file contains an archive of out-of-date Knowledge Base documentation.
+
+### Chat with a bot linked to a knowledge base
+
+If you have a bot linked to your knowledge base via a [Knowledge Base integration](conversation-builder-integrations-knowledge-base-integrations.html), in the Knowledge Base application, you can feed test user input to the bot to see if it matches, returns and renders content as you'd expect.
+
+{: .important}
+If you're just getting started with knowledge bases and want to try using this tool, we recommend you create a bot using the [Simple FAQ bot template](conversation-builder-bot-templates-simple-faq.html) and connect it to your knowledge base. Most of the bot development work is already done. You only need to update the integration in the bot so that it uses your knowledge base, as shown in the image below.
+
+ 
+
+**To chat with a bot linked to a knowledge base**
+
+1. If you haven't already done so, in Conversation Builder, create a bot that includes a [Knowledge Base integration](conversation-builder-integrations-knowledge-base-integrations.html) that uses the knowledge base you want to test.
+2. Return to the Knowledge Base application, and open the knowledge base.
+2. In the upper-right corner, click 
, and select **Chat**.
+4. In the Preview panel, select the bot to use.
+
+ 
+
+5. Begin to feed test user input to the bot to see how it responds.
+
+ 
+
+
+### Refresh the intents
+
+The intents for every article are stored in a cache that is updated automatically every 5 minutes. But if you've made a recent change to intents--either [Knowledge Base intents or Domain intents](knowledge-base-internal-knowledge-bases-introduction.html#domain-intents-versus-knowledge-base-intents)--and you want to immediately see the result of the changes, you can manually refresh the cache.
+
+**To refresh the intents in a knowledge base**
+1. Open the knowledge base.
+2. In the upper-right corner, click , and select **Knowledge Base Menu**.
+3. In the Settings panel, click **KB Settings**.
+4. Click **More Options**, scroll down to the **Refresh Intents** section, and click 
(Refresh icon).
+
+### Test user input
+
+Use the Debugger tool to feed user input directly into a knowledge base to test content matching.
+
+The Debugger tool works exactly like a [Knowledge Base integration](conversation-builder-integrations-knowledge-base-integrations.html) in a bot. So, if your search selections in the tool match how you've configured the bot, the results you see with the tool will be the same as those returned in a bot conversation. If you don't yet have a bot integrated with your knowledge base, the Debugger tool is also a way to test how the bot will behave once it is.
+
+The Debugger tool is also *the* way to see the JSON that's returned by the search.
+
+**To test user input**
+
+1. Open the knowledge base.
+2. In the upper-right corner, click , and select **Test User Input**.
+
+ 
+
+3. Specify the following:
+
+ * **Phrase**: Enter the phrase to search for.
+ * **Search Modes**: Select either Intents, Intents Only, or All. For a description of each mode, see [here](knowledge-base-using-intents-with-kbs.html#search-modes).
+ * **Threshold**: Select the minimum score that a result must have in order to be returned, either VERY GOOD, GOOD, or FAIR PLUS. For more on thresholds, see [here](knowledge-base-using-intents-with-kbs.html#scoring-and-thresholds).
+
+4. Click **test**.
+
+ In the results, the JSON of the matched article is displayed. You can examine the "title" to see which article has been matched.
+
+ 
\ No newline at end of file
diff --git a/_exclude/knowledgeBaseTestAndTrain.md b/_exclude/knowledgeBaseTestAndTrain.md
index 1ba448a531..712af5a0ae 100644
--- a/_exclude/knowledgeBaseTestAndTrain.md
+++ b/_exclude/knowledgeBaseTestAndTrain.md
@@ -88,4 +88,4 @@ If you have a bot that's linked to a knowledge base, you can feed it test user i
The Thumbs Up and Thumbs Down icons are so easy to use that they are often misused. Often we see people using Thumbs Up for extremely specific or lengthy utterances that, although said by an end user, are not great training phrases because they would never match another user’s utterance. Over time, the addition of these utterances (often 50+ added) skew the results in a negative way. The same is true when using Thumbs Down.
-Try to keep your intent qualifiers or training phrases as generalized as possible so that they have a high likelihood of matching many user utterances, not just one. As mentioned [here](knowledge-base-articles.html#best-practices), anything over 10 - 15 intent qualifiers or training phrases might begin to return false positives.
\ No newline at end of file
+Try to keep your intent qualifiers or training phrases as generalized as possible so that they have a high likelihood of matching many user utterances, not just one. As mentioned [here](knowledge-base-internal-knowledge-bases-best-practices.html), anything over 10 - 15 intent qualifiers or training phrases might begin to return false positives.
\ No newline at end of file
diff --git a/_exclude/scraps_kb.md b/_exclude/scraps_kb.md
index 3e6b831940..08089299ac 100644
--- a/_exclude/scraps_kb.md
+++ b/_exclude/scraps_kb.md
@@ -1,9 +1,3 @@
-Don't doc, at least not yet:
-Add Stop Words - might be removed as deprecated
-Add Keyword Patterns - might be removed as deprecated
-Approve Pending Articles - will be changed to enable/disable (BA-3704)
-Search feature - will be changed
-
### Add keyword patterns
INTRO TO BE ADDED
diff --git a/_exclude/scraps_mef.md b/_exclude/scraps_mef.md
index 4c7b66cf3d..68afdb42f5 100644
--- a/_exclude/scraps_mef.md
+++ b/_exclude/scraps_mef.md
@@ -1,72 +1,34 @@
This is for storing segments of doc temporarily until they can be added to the public files...
+SNIPPET FOR TOP SECTION
-### Starter packs
+- **Consumer Authentication**: Use this when you require the bot to make API calls on behalf of the consumer. With this type of credential, the consumer is sent an authentication link, uses it to authenticate, and obtains a token that is sent to the bot. This “delegates” access to the bot, so it can make the API calls.
-To get you quickly up and running with [intents](intent-builder-intents.html), LivePerson provides a set of starter packs that you can easily add to your Intent Builder environment. A starter pack is a ready-made domain that includes a set of predefined intents. There are two kinds of starter packs available:
+NEW SECTION BELOW
-* Generic starter packs for a number of verticals: Telecommunications, Financial Services, and more.
-* Cross-vertical starter packs that are appropriate for all verticals. These include starter packs for things like account management, billing and payment, “small talk,” and more.
+### Add a Consumer Authentication credential
-{Nice preview screenshot here}
+You can create a Consumer Authentication credential and use it in [API integrations](conversation-builder-integrations-api-integrations.html) when you require the bot to make API calls on behalf of the consumer. With this credential, the consumer receives an authentication link, uses it to authenticate, and obtains a token that is sent to the bot. This “delegates” access to the bot, so it can make the API calls. The general flow is this:
-Once you add a domain using a starter pack, you can customize it as you see fit. The domain behaves like any other you might create manually or via an import file.
+1. In the bot, the Integration interaction is triggered in the dialog.
+2. The bot sends an authentication URL (a plain link) to the consumer.
-If you want a fast, low effort way to get up and running with well-defined intents, LivePerson recommends that you get started using starter packs.
+ 
-{: .important}
-Starter packs for the [LP NLU v1 engine](intent-builder-natural-language-understanding.html#livepersons-nlu-engine) aren’t supported.
+3. The consumer clicks the link, is directed to the authentication URL (e.g., a login page), and authenticates, thereby obtaining a token.
+4. The token is sent to the bot.
+5. The bot runs the integration (with the token) and responds with a result.
+**To add a Consumer Authentication credential**
-### Add a domain with a starter pack
-
-For an introduction to starter packs, see here.
-
-**To add a domain with a starter pack**
-
-1. Access the Intent Builder application, as described [here](intent-builder-overview.html#access-intent-builder).
-2. In the dashboard that lists your domains, click **Prebuilt Domains** at the top of the domain list.
-
- {screen}
-
-3. On the Prebuilt Domains tab in the Add Domain dialog box, select the domain. Then click **Preview** to see a description of the domain and some sample user phrases. This helps you to verify that the domain is the one you want.
-
- {screen}
-
-4. Click **Add**.
-
- The domain is added.
-
- {: .important}
- There’s no need to train or activate the domain for the first time. Both of these steps have been done automatically. However, from this point forward, things work as if you had created the domain manually. If you subsequently make any changes, you’ll need to manually re-train the domain to create a new model version that reflects the changes. And when ready, you’ll need to activate the new model version.
-
-
-### Import a dialog
-
-You can import one or more dialogs from another bot. This can be advantageous when you have a well-defined dialog in one bot that you want to quickly and easily reuse in another. Note the following:
-
-* You can import dialogs from only one bot at a time.
-* You can import a maximum of 10 dialogs at a time.
-* You can import dialogs of all types except Fallback and Disambiguation.
-* You can import dialogs from the bots to which you have access in your organization. For example, you can’t import dialogs from a private bot that was created by another bot developer.
-* The following is imported:
- * All selected dialogs and the interactions therein.
- * All integrations referenced in the selected dialogs.
-* During the import:
- * The order of the interactions is maintained.
- * The “next action” for each interaction is maintained whenever possible. If you don’t import a dialog that is referenced, the “next action” is cleared. After the import you are shown an error message, so you can import the associated dialog and/or update the next action as appropriate.
- * The assignments (IDs) of domains, intents, and entities are maintained.
-* If you import a dialog that uses a knowledge base integration, and that knowledge base is private to another, …???
-
-**To import a dialog from another bot**
-
-1. Open the destination bot.
-2. Click **Add Dialog** in the lower-left corner.
-3. In the Add Dialog dialog box, select the **From Existing Bots** tab.
-4. Browse and/or search to find and select the dialogs to import. You can search by…
-5. Click **Add**.
-
- The selected dialogs are imported. At this point, you might need to do the following:
-
- * If you received any errors, this is because you imported a dialog that referenced another dialog that you didn’t import. In this case, the “next action” in the relevant interaction in the imported dialog is cleared. To resolve this, import the associated dialog and/or update the next action as appropriate.
- * You might want to rename the imported dialogs and interactions. They are given standard names based on the destination bot name and element name.
+1. In the Bot Accounts application, select the name of the organization for which to create the credential.
+2. Click **Credentials** in the upper-left corner.
+3. Click **Add Credentials** in the upper-right corner.
+4. In the Add Credentials dialog box, specify the following:
+ * **Name**: Enter a descriptive name.
+ * **Authentication Type**: Select "Consumer Authentication."
+5. Click **Next**.
+6. In the Add Credentials dialog box, specify the following:
+ * **Authentication URL**: Enter the authentication endpoint to be sent to the consumer in order to obtain an access token that is sent to the bot. The URL is provided by the resource provider; see their documentation for this information.
+ 
+7. Click **Save**.
\ No newline at end of file
diff --git a/_exclude/subscriptions.md b/_exclude/subscriptions.md
deleted file mode 100644
index 6e3f3eaf55..0000000000
--- a/_exclude/subscriptions.md
+++ /dev/null
@@ -1,29 +0,0 @@
----
-pagename: Subscriptions
-Keywords:
-sitesection: Documents
-categoryname: "Conversational AI"
-documentname: Bot Accounts
-permalink: bot-accounts-subscriptions.html
-indicator: both
----
-
-
-Bot Builder - dropdown should show public and own, for those bots that don't have alerts
-Admin - dropdown should show all bots (???), for those bots that don't have alerts
-
-**To subscribe to a bot**
-
-1. In the upper-right corner of the menu bar, click 
(Subscriptions icon).
-2. In the upper-right corner, select the bot to subscribe to, and click **Add Bot**.
-
- 
-
-3. Select how you want to receive alerts.
-4. For **Bot monitor**, click the slider to enable the alert.
-
- 
-
-
-
-
diff --git a/pages/Documents/ConversationalAI/KnowledgeBase/tutorial.md b/_exclude/tutorial.md
similarity index 78%
rename from pages/Documents/ConversationalAI/KnowledgeBase/tutorial.md
rename to _exclude/tutorial.md
index 1ec150acb9..739ee004e9 100644
--- a/pages/Documents/ConversationalAI/KnowledgeBase/tutorial.md
+++ b/_exclude/tutorial.md
@@ -1,21 +1,24 @@
---
pagename: Tutorial
redirect_from:
+ - knowledge-base-tutorial.html
Keywords:
sitesection: Documents
categoryname: "Conversational AI"
documentname: Knowledge Base
-permalink: knowledge-base-tutorial.html
+subfoldername: LivePerson Knowledge Bases
+permalink: knowledge-base-liveperson-knowledge-bases-tutorial.html
indicator: both
---
-This tutorial is designed to familiarize you with Knowledge Base.
+This tutorial is designed to familiarize you with the Knowledge Base application and [internal knowledge bases](knowledge-base-internal-knowledge-bases-introduction.html).
-### Step 1: Add a knowledge base
+### Step 1: Add an external knowledge base
1. In the dashboard that lists the available knowledge bases, click **Add Knowledge Base** in the upper-right corner.
-2. For **Data source name**, enter a name for the knowledge base, e.g., "Tutorial KB."
-3. Click **Add**.
+2. On the **AI Enabled** tab of the window that appears, select **Built-in Content Store**.
+3. For **Data source name**, enter a name for the knowledge base, e.g., "Tutorial KB."
+4. Click **Save**.
### Step 2: Add an article
@@ -43,15 +46,18 @@ This tutorial is designed to familiarize you with Knowledge Base.
Tags help to increase the accuracy of Knowledge Base search results by highlighting the key sections of the user's message.
-6. Click **Save**.
+3. Click **Save**.
-Back in the search view, you should now see your new article, which should look something like this:
+ Back in the search view, you should now see your new article, which should look something like this:
-
+
-Note that the article has a “Pending” notation on it. We add this for new articles so that a manager or supervisor can approve them before they are included in the results.
+ The article is inactive, which means it won't be returned in knowledge base searches in Knowledge Base integrations.
+
+ Manually added articles are inactive by default because the **Enable Article** setting is turned off by default. This is to give you the opportunity to test the article before enabling it.
+
+ For the purposes of this tutorial, the inactive status is fine, as this tutorial doesn't get into use in an Knowledge Base integration. For more on active versus inactive articles, see [here](knowledge-base-internal-knowledge-bases-introduction.html#active-versus-inactive-articles). For information on how to enable the article, see [here](knowledge-base-internal-knowledge-bases-articles.html#enable-or-disable-an-article).
-To continue with this tutorial, click the **Enable** link over on the right.
### Step 3: Train and tune
@@ -69,7 +75,7 @@ Let’s test our knowledge base and see how the NLU will return results.
This is different enough that the NLU engine will return as FAIR PLUS. Generally, in a Knowledge Base integration in a bot, we set the threshold to GOOD, so, in this new example, the article wouldn't be shown to a user. However, we can easily “train” the article to respond to this input by clicking the thumbs-up icon that's beneath the result.
-3. Click **thumbs up**.
+3. Click 
(**Thumbs Up** icon).
This adds the utterance to a set of “positive learnings” that are used in the matching.
@@ -79,7 +85,7 @@ Let’s test our knowledge base and see how the NLU will return results.
Keep in mind that when you are training articles, it's very easy to use the thumbs-up button. It's so easy that you might *overtrain* the bot using lengthy or very specific intents just because you can. Try to keep your intent qualifiers as generalized as possible so that they have a high likelihood of matching many user utterances, not just one. Overall, use the training feature sparingly.
-What about **thumbs down**? This should be used sparingly to differentiate two articles that might have intents that are close in meaning. NLU is not a specific pattern match, but more fuzzy, so having articles with similar intents but different content should be discouraged. That said, using thumbs down can help when that does occur, to indicate which of the two articles you'd like the NLU engine to match. Simply use the thumbs-down button on the article you'd like to de-prioritize, and the NLU engine will "prefer" the other one over it.
+What about **Thumbs Down**? This should be used sparingly to differentiate two articles that might have intents that are close in meaning. NLU is not a specific pattern match, but more fuzzy, so having articles with similar intents but different content should be discouraged. That said, using thumbs down can help when that does occur, to indicate which of the two articles you'd like the NLU engine to match. Simply use the thumbs-down button on the article you'd like to de-prioritize, and the NLU engine will "prefer" the other one over it.
For more best practices, see [here](conversation-builder-best-practices-train-tune-nlu.html).
@@ -100,7 +106,8 @@ Leveraging entities within a knowledge base provides the same benefits that doin
1. Inside the domain you just created, click **Entities** in the upper-left corner.
2. In the Add Entity panel, specify the following:
- * **Entity name**: Enter "credentials."
+ * **Entity name**: Enter "CREDENTIALS."
+ * **Entity type**: Select "Value Set," which is the default.
* **Entity values**: Add the values below:
* `log in`
* `login`
@@ -110,7 +117,7 @@ Leveraging entities within a knowledge base provides the same benefits that doin
* `username`
* `pin`
-3. Click **Add Entity**.
+3. Click **Save**.
#### Connect the domain to the knowledge base
diff --git a/pages/Documents/ConversationalAI/ConversationBuilder/Tutorials&Guides/using-meta-intents-with-conversation-builder.md b/_exclude/using-meta-intents-with-conversation-builder.md
similarity index 90%
rename from pages/Documents/ConversationalAI/ConversationBuilder/Tutorials&Guides/using-meta-intents-with-conversation-builder.md
rename to _exclude/using-meta-intents-with-conversation-builder.md
index 7664955ea5..bc508ed77e 100644
--- a/pages/Documents/ConversationalAI/ConversationBuilder/Tutorials&Guides/using-meta-intents-with-conversation-builder.md
+++ b/_exclude/using-meta-intents-with-conversation-builder.md
@@ -20,7 +20,7 @@ To demonstrate this, we'll be using meta intents in conjunction with a “small
-Our Small Talk knowledge base is going to be configured to use [domain intents](knowledge-base-overview.html#knowlege-base-intents-versus-domain-intents) for its articles, which means we need to start off by building the domain in Intent Builder. Select “New Domain” from Intent Builder, give your domain a name, and you’re ready to start adding your intents.
+Our Small Talk knowledge base is going to be configured to use [domain intents](knowledge-base-internal-knowledge-bases-introduction.html#domain-intents-versus-knowledge-base-intents) for its articles, which means we need to start off by building the domain in Intent Builder. Select “New Domain” from Intent Builder, give your domain a name, and you’re ready to start adding your intents.
Several intents need to be created that are related to common small talk that a user may utter to the bot during the course of their interaction. “How are you”, “Thank you”, and disagreement utterances should still be answered in an appropriate manner, so we want to make sure that we’re capturing these intents and processing them appropriately. We build these intents as usual, adding training phrases and entities to improve the results from the NLU. Once we have created some initial intents, we can create the Small Talk meta intent, which will contain our created intents.
@@ -34,7 +34,7 @@ Take this opportunity to test out some user inputs to make sure that the intents
### Connect the domain to the Small Talk knowledge base
-Next, we’ll create the knowledge base that will house our small talk responses in the form of articles. We’ll start by creating a new knowledge base using [domain intents](knowledge-base-overview.html#knowlege-base-intents-versus-domain-intents), making sure to select "Domain Intents" as the **Intent Association**. This will provide a menu from which to select our newly created Small Talk domain.
+Next, we’ll create the knowledge base that will house our small talk responses in the form of articles. We’ll start by creating a new knowledge base using [domain intents](knowledge-base-internal-knowledge-bases-introduction.html#domain-intents-versus-knowledge-base-intents), making sure to select "Domain Intents" as the **Intent Association**. This will provide a menu from which to select our newly created Small Talk domain.
diff --git a/_layouts/default.html b/_layouts/default.html
index 1218e069bf..192d79d178 100644
--- a/_layouts/default.html
+++ b/_layouts/default.html
@@ -94,4 +94,4 @@
{% include google_analytics.html %}
{% endif %}
-