Author: buildbot
Date: Wed May 30 11:28:44 2012
New Revision: 819608
Log:
Staging update by buildbot for stanbol
Added:
websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/hallo-annotate_scrrenshot.png
(with props)
Modified:
websites/staging/stanbol/trunk/content/ (props changed)
websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/enhancementstructure.html
Propchange: websites/staging/stanbol/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Wed May 30 11:28:44 2012
@@ -1 +1 @@
-1344141
+1344200
Modified:
websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/enhancementstructure.html
==============================================================================
---
websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/enhancementstructure.html
(original)
+++
websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/enhancementstructure.html
Wed May 30 11:28:44 2012
@@ -197,7 +197,87 @@
NOTE: the values "local" and "entityhub" need to be treated separately. In
those cases the GET request need to use
"{stanbol}/entityhub/entity?id={entity}".</li>
</ul>
<h1 id="part-2-using-the-stanbol-enhancement-structure">Part 2: Using the
Stanbol Enhancement Structure</h1>
+<h2 id="entity-tagging">Entity Tagging</h2>
<p>TODO: Work in progress</p>
+<h2 id="entity-disambiguation">Entity Disambiguation</h2>
+<p>TODO: Work in progress</p>
+<h2 id="occurrence-based-annotation">Occurrence based Annotation</h2>
+<p>This describes a user interface similar to one of a spell/grammar checker.
But instead of marking misspelled words entities recognized within the text are
suggested to the user. The following figure shows such an interface as
implemented by the <a href="http://hallojs.org";>hallo.js</a> combined with the
<a href="https://github.com/szabyg/annotate.js";>annotate.js</a> plugin.</p>
+<p><img alt="Occurrence based Annotation UI"
src="hallo-annotate_scrrenshot.png" title="hallo.js with the annotate.js plugin
used to implement an text occurrence based annotation UI" /></p>
+<p>To implement user interfaces like that one needs to acquire the following
information form the enhancements returned by the Stanbol Enhancer.</p>
+<p><strong>Showing the Occurrences within the Text</strong></p>
+<p>This described how to obtain the necessary information needed to visualize
extracted Entities within the text.</p>
+<ol>
+<li>Query for/iterate over 'fise:TextAnnotation's of the enhancement
results.<ul>
+<li>it is important to only use TextAnnotations that define a
'fise:selected-text' property. TextAnnotations that do not define this property
usually select whole sections or even the document as a whole. Those are not of
interest for this use case.</li>
+</ul>
+</li>
+<li>Determine the exact occurrence of the TextAnnoations<ul>
+<li>in case of plain text content this can be easily done by using the values
of 'fise:start' and 'fise:end'</li>
+<li>in case the content includes additional markup the char indexes of
'fise:start'/'fise:end' will not match. In such cases the preferred way is to
first search the occurrence of'fise:selection-context' and thann the occurrence
of 'fise:selected-text' within.</li>
+</ul>
+</li>
+<li>Retrieve suggested Entities for a given TextAnnotation. For that one needs
to search for "?suggestion dc:relation {text-annotation}" where
'{text-annotation}' refers to the URI of the current TextAnnotation.<ul>
+<li>Note that there will be TextAnnotations with no suggestions.</li>
+</ul>
+</li>
+</ol>
+<p>The following SPARQL query could be used to select all the required
information. However the use of SPARQL is optional as the required information
can be also easily retrieved by other means (e.g. the filtered Iteratros as
typically provided by RDF frameworks). </p>
+<div class="codehilite"><pre><span class="nb">select</span> <span
class="o">*</span>
+<span class="n">from</span> <span class="p">{</span>
+ <span class="p">?</span><span class="n">textAnnotation</span> <span
class="n">rdfs:type</span> <span class="n">fise:TextAnnotation</span>
+ <span class="p">?</span><span class="n">textAnnotation</span> <span
class="n">fise:selected</span><span class="o">-</span><span
class="n">text</span> <span class="p">?</span><span class="n">selected</span>
+ <span class="p">?</span><span class="n">textAnnotation</span> <span
class="n">fise:selection</span><span class="o">-</span><span
class="n">context</span> <span class="p">?</span><span class="n">context</span>
+ <span class="p">?</span><span class="n">textAnnotation</span> <span
class="n">fise:start</span> <span class="p">?</span><span
class="n">startIndex</span>
+ <span class="p">?</span><span class="n">textAnnotation</span> <span
class="n">fise:end</span> <span class="p">?</span><span
class="n">endIndex</span>
+ <span class="p">?</span><span class="n">textAnnotation</span> <span
class="n">dc:type</span> <span class="p">?</span><span class="n">nature</span>
+<span class="n">optional</span> <span class="p">{</span> <span
class="p">?</span><span class="n">suggestions</span> <span
class="n">dc:relation</span> <span class="p">?</span><span
class="n">textAnnotation</span> <span class="p">}</span>
+<span class="p">}</span>
+</pre></div>
+
+
+<p>Additionally:</p>
+<ul>
+<li>The value of the 'dc:type' is well suited to select different style
sheets. See the section for <a
href="#fisetextannotation">fise:TextAnnotation</a> for detailed
information.</li>
+<li>The UI might need to differentiate between TextAnnotations with/without
suggestions.</li>
+</ul>
+<p><strong>Processing Suggested Entities</strong></p>
+<p>In principle there are three different cases</p>
+<ol>
+<li>No suggestion: This indicates that a Named Entity was recognized during
natural language processing, but to matching Entity was found within the
knowledge base. In this case users might want to<ul>
+<li>manually search the knowledge base for an Entity. The Stanbol Entityhub
Sites Endpoint can be used to implement this feature by sending a "GET
http://{host}:{port}/entityhub/sites/find?name={name}"; (see the WebUI of your
Stanbol instance for the detailed documentation).</li>
+<li>Create a new Entity based on the current TextAnnotation. In this case the
'fise:selected-text' should be suggested as 'rdfs:label' and the 'dc:type'
value could be used for the 'rdf:type'. New Entities can be added to the
knowledge base by sending a "POST http://{host}:{port}/entityhub/entity"; with
the RDF data of the Entity as content (see the WebUI of your Stanbol instance
for the detailed documentation).</li>
+</ul>
+</li>
+<li>Distinct suggestion: This means that there is only a single suggestion
with a high 'fise:confidence'. Also multiple suggestions where the first one as
a high confidence and additional suggestions come with low confidence values
may fit this description. In such situations <ul>
+<li>the UI might want to automatically accept the suggestion</li>
+<li>allow users to show additional suggestion on request.</li>
+<li>undo automatic acceptance of the suggestion.</li>
+</ul>
+</li>
+<li>Ambiguous Suggestions: This situation is satisfied if multiple entities
are suggested with a medium to high 'fise:confidence'. In those cases typically
the user must provide additional input by<ul>
+<li>selecting the correct entity</li>
+<li>rejecting all suggestions</li>
+<li>also manually searching and/or creating a new Entity as described for (1)
would be possible interaction</li>
+</ul>
+</li>
+</ol>
+<p>The required data for for the described interaction patters are available
within the enhancement results as follows:</p>
+<p>The following assumes {text-annotation} - the URI of the current
'fise:TextAnnotation' - as context</p>
+<ol>
+<li>Query for/iterate over all entity suggestions: The suggestions for
{text-annotation} can be acquired by using "?entityAnnotation dc:relation
{text-annotation}<ul>
+<li>only results with the the 'rdf:type' 'fise:EntityAnnotation' should be
processed. However typically all results will be any way of that type.</li>
+<li>the 'fise:confidence' property represents the confidence of the suggestion
in the range FROM 0 (very uncertain) TO 1 (very certain). Note that the
'fise:confidence' value is optional - so there might be EntityAnnotations
without confidence information. However all <a
href="engines/list.html">EnhancementEngines managed by the Stanbol
community</a> do provide confidence information.</li>
+</ul>
+</li>
+<li>Visualize suggestions: EntityAnnotations do provide some basic information
about the suggested Entity that can be used for visualization. Most important
the URI of the suggested entity as value of 'fise:referenced-entity'.
Additional the label and the types of the Entity are included.</li>
+<li>Retrieving additional information about referenced Entities: While the
EntityAnnotation includes some basic information some users might want to
retrieve all available information of referenced Entities - to dereference the
Entity:<ul>
+<li>As this is a rather common use case the <a href="">EntityLinkingEngine</a>
and <a href="">KeywordLinkingEngine</a> are by default configured to include
information of Entities within the EnhancementResults. So users that use those
EnhancementEngines will not need to dereference Entities as those information
are already available within the enhancement results.</li>
+<li>If a 'fise:EntityAnnotation' has the 'entityhub:site' property Entities
can be dereferenced by using the Stanbol Entityhub (see the section for <a
href="#fiseentityannotation">fise:EntityAnnotation</a> for details)</li>
+<li>In all other cases the URI of the suggested entity need to be used for
dereferencing. If the referenced Entity is part of the <a
href="http://linkeddata.org/";>Linked Data</a> cloud this is often possible by
the <a href="http://www.w3.org/TR/cooluris/";>CoolURI</a> - basically sending a
"GET -h "Accept: application/json+rdf" {entity-uri}".</li>
+</ul>
+</li>
+</ol>
</div>
<div id="footer">
Added:
websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/hallo-annotate_scrrenshot.png
==============================================================================
Binary file - no diff available.
Propchange:
websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/hallo-annotate_scrrenshot.png
------------------------------------------------------------------------------
svn:mime-type = image/png
