showEntityConfidence
Displays the entity level confidence, value, literal, and origin in the legacy HTTP and Websocket responses available from NLE recognition results.
Value |
Boolean |
Default |
False |
How to set |
In Management Station, set on the Natural Language Processing service. If not using Management Station, set in the NLP service configuration file (User-nlpsxx.properties, see Configuration roadmap). |
Usage |
Sometimes changed when configuring the services in environments using NLE. When set to true, the NLP service displays the entity level confidence, value, literal, and origin in the legacy HTTP and Websocket responses. When set to false, the NLP service displays the HTTP and Websocket responses in their original format. |
When showEntityConfidence is set to false, the NLP service displays the HTTP and Websocket responses in their original format as shown below:
<?xml version='1.0'?>
<result>
<interpretation grammar="My_Cities" confidence="99">
<input mode="speech">austin</input>
<instance>
<city confidence="99">Austin</city>
<state confidence="99">TX</state>
</instance>
</interpretation>
<interpretation grammar="My_Cities" confidence="95>
<input mode="speech">boston</input>
<instance>
<city confidence="95">Boston</city>
<state confidence="95">MA</state>
</instance>
</interpretation>
</result>
Note: The samples are formatted for readability. Newlines and indentation are added. The actual return string is delimited by spaces.
<?xml version='1.0'?>
<emma:emma version="1.0"
xmlns:emma="http://www.w3.org/2005/09/emma">
<emma:one-of id="nbest" emma:disjunction-type="recognition" emma:duration="924">
<emma:interpretation id="interp_1" emma:confidence="0.52"
emma:grammar-ref="grammar_1" emma:tokens="Austin">
<city conf="0.52">Austin</city>
<state conf="0.52">TX</state>
<SWI_literal>Austin</SWI_literal>
<SWI_spoken>Austin</SWI_spoken>
<SWI_meaning>{city:Austin state:TX}</SWI_meaning>
</emma:interpretation>
<emma:interpretation id="interp_2" emma:confidence="0.45"
emma:grammar-ref="grammar_1" emma:tokens="Boston">
<city conf="0.45">Boston</city>
<state conf="0.45">MA</state>
<SWI_literal>Boston</SWI_literal>
<SWI_spoken>Boston</SWI_spoken>
<SWI_meaning>{city:Boston state:MA}</SWI_meaning>
</emma:interpretation>
</emma:one-of>
<emma:grammar id="grammar_1" href="My_Cities"/>
</emma:emma>
Note: The samples are formatted for readability. Newlines and indentation are added. The actual return string is delimited by spaces.
When showEntityConfidence is set to true, the NLP service displays the entity level confidence, value, literal, and origin in the legacy HTTP and Websocket responses as shown below:
<?xml version='1.0'?>
<result>
<interpretation grammar="My_Cities" confidence="99">
<input mode="speech">austin</input>
<instance>
<city confidence="95">{"value":"Austin","conf":"95","literal":"austin","origin":"SSM"}</city>
<state confidence="97">{"value":"TX","conf":"97","literal":"texas","origin":"SSM"}</state>
</instance>
</interpretation>
<interpretation grammar="My_Cities" confidence="95>
<input mode="speech">boston</input>
<instance>
<city confidence="94">{"value":"Boston","conf":"94","literal":"boston","origin":"SSM"}</city>
<state confidence="95">{"value":"MA","conf":"95","literal":"massachussets","origin":"SSM"}</state>
</instance>
</interpretation>
</result>
Note: The samples are formatted for readability. Newlines and indentation are added. The actual return string is delimited by spaces.
<?xml version='1.0'?>
<emma:emma version="1.0"
xmlns:emma="http://www.w3.org/2005/09/emma">
<emma:one-of id="nbest" emma:disjunction-type="recognition" emma:duration="924">
<emma:interpretation id="interp_1" emma:confidence="0.52"
emma:grammar-ref="grammar_1" emma:tokens="Austin">
<city conf="0.50">{"value":"Austin","conf":"0.50","literal":"austin","origin":"SSM"}</city>
<state conf="0.47">{"value":"TX","conf":"0.47","literal":"texas","origin":"SSM"}</state>
<SWI_literal>Austin</SWI_literal>
<SWI_spoken>Austin</SWI_spoken>
<SWI_meaning>{city:Austin state:TX}</SWI_meaning>
</emma:interpretation>
<emma:interpretation id="interp_2" emma:confidence="0.45"
emma:grammar-ref="grammar_1" emma:tokens="Boston">
<city conf="0.40">{"value":"Boston","conf":"0.40","literal":"boston","origin":"SSM"}</city>
<state conf="0.42">{"value":"MA","conf":"0.42","literal":"massachussets","origin":"SSM"}</state>
<SWI_literal>Boston</SWI_literal>
<SWI_spoken>Boston</SWI_spoken>
<SWI_meaning>{city:Boston state:MA}</SWI_meaning>
</emma:interpretation>
</emma:one-of>
<emma:grammar id="grammar_1" href="My_Cities"/>
</emma:emma>
Note: The samples are formatted for readability. Newlines and indentation are added. The actual return string is delimited by spaces.