You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@stanbol.apache.org by rw...@apache.org on 2012/02/16 11:06:17 UTC
svn commit: r1244912 - in
/incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer: ./
chains/ engines/
Author: rwesten
Date: Thu Feb 16 10:06:16 2012
New Revision: 1244912
URL: http://svn.apache.org/viewvc?rev=1244912&view=rev
Log:
changed name of enhancementchain.mdtext to index.mdtext; added :::{language} prefixes for all code segments of the enhancer documentation
Added:
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/chains/index.mdtext
- copied, changed from r1244417, incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/chains/enhancementchain.mdtext
Removed:
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/chains/enhancementchain.mdtext
Modified:
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/chains/chainmanager.mdtext
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/chains/executionplan.mdtext
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/chains/graphchain.mdtext
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/chains/listchain.mdtext
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/chains/weightedchain.mdtext
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/contentitem.mdtext
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/engines/enhancementenginemanager.mdtext
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/engines/geonamesengine.mdtext
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/engines/index.mdtext
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/engines/keywordlinkingengine.mdtext
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/engines/langidengine.mdtext
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/engines/metaxaengine.mdtext
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/engines/namedentityextractionengine.mdtext
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/engines/namedentitytaggingengine.mdtext
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/engines/opencalaisengine.mdtext
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/engines/refactorengine.mdtext
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/engines/zemantaengine.mdtext
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/enhancementjobmanager.mdtext
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/executionmetadata.mdtext
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/index.mdtext
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/stanbolenhancementstructure.mdtext
Modified: incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/chains/chainmanager.mdtext
URL: http://svn.apache.org/viewvc/incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/chains/chainmanager.mdtext?rev=1244912&r1=1244911&r2=1244912&view=diff
==============================================================================
--- incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/chains/chainmanager.mdtext (original)
+++ incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/chains/chainmanager.mdtext Thu Feb 16 10:06:16 2012
@@ -1,11 +1,12 @@
Title: ChainManager
-The ChainManager provides name based access to all active [Enhancement Chain](enhancementchain.html) and their ServiceReferences. This interface is typically used by components that need to lookup Chains based on their name. However the ChainsTracker implementation can also be used to track specific Chains.
+The ChainManager provides name based access to all active [Enhancement Chain](index.html) and their ServiceReferences. This interface is typically used by components that need to lookup Chains based on their name. However the ChainsTracker implementation can also be used to track specific Chains.
### ChainManager interface
This is the Java API providing access to registered Chains in the ways as described above. This interface includes the following methods:
+ :::java
/** Constant for the name of the DefaultChain */
DEFAULT_CHAIN_NAME : String
/** Getter for all names with active Chains */
@@ -34,6 +35,7 @@ There are two implementations of this in
This is an implementation of the ChainManager interface that is registered as OSGI service. It can be used e.g. by using the @Reference annotation
+ :::java
@Reference
ChainManager chainManager
@@ -43,6 +45,7 @@ This service is provided by the "org.apa
This is an Utility similar to the standard OSGI ServiceTracker that allows to track some/all Chains. It also supports the usage of a ServiceTrackerCustomizer so that users of that utility can directly react to changes of tracked Chains.
+ :::java
//track only "myChain" and "otherChain"
ChainsTracker tracker = new ChainsTracker(
context, "myChain","otherChain");
Modified: incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/chains/executionplan.mdtext
URL: http://svn.apache.org/viewvc/incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/chains/executionplan.mdtext?rev=1244912&r1=1244911&r2=1244912&view=diff
==============================================================================
--- incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/chains/executionplan.mdtext (original)
+++ incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/chains/executionplan.mdtext Thu Feb 16 10:06:16 2012
@@ -1,6 +1,6 @@
Title: ExecutionPlan
-The ExecutionPlan is represented as an RDF graph following the ExecutionPlan Ontology. It needs to be provided by the [Enhancement Chain](enhancementchain.html) and is used by the [EnhancementJobManager](../enhancementjobmanager.html) to enhance [ContentItem](../contentitem.html)s and to write the [ExecutionMetadata](../executionmetadata.html).
+The ExecutionPlan is represented as an RDF graph following the ExecutionPlan Ontology. It needs to be provided by the [Enhancement Chain](index.html) and is used by the [EnhancementJobManager](../enhancementjobmanager.html) to enhance [ContentItem](../contentitem.html)s and to write the [ExecutionMetadata](../executionmetadata.html).
## ExecutionPlan Ontology
@@ -34,6 +34,7 @@ This example assumes that
The RDF graph of such a chain would look:
+ :::none
urn:execPlan
rdf:type ep:ExecutionPlan
ep:hasExecutionNode urn:node1, urn:node2, urn:node3, urn:node4, urn:node5
@@ -75,6 +76,7 @@ This plan defines that the "langId" and
The Enhancer MUST also define an Utility that provides the following utility
+ :::java
/** Getter for the list of executable ep:ExecutionNodes */
+ getExecuteable(Graph executionPlan, Set<NonLiteral> completed) : Collection<NonLiteral>
@@ -82,6 +84,7 @@ This method takes an execution plan and
Typically code using this utility will look like this (pseudo code)
+ :::java
Graph executionPlan = chain.getExecuctionPlan();
Map<String, EnhancementEngine> engines = enhancementEngineManager.getActiveEngines(chain);
Collection<NonLiteral> executed = new HashSet<NonLiteral>();
Modified: incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/chains/graphchain.mdtext
URL: http://svn.apache.org/viewvc/incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/chains/graphchain.mdtext?rev=1244912&r1=1244911&r2=1244912&view=diff
==============================================================================
--- incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/chains/graphchain.mdtext (original)
+++ incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/chains/graphchain.mdtext Thu Feb 16 10:06:16 2012
@@ -12,10 +12,12 @@ The GraphChain supports two variants to
A GraphResource is a RDF file available via the DataFileProvider. The easiest way is to copy the RDF file defining the ExecutionPlan to the "/sling/datafile" directory within the Stanbol home directory. The configuration of the GraphChain needs than only to refer to that file such as:
+ :::none
stanbol.enhancer.chain.graph.graphresource=myExecutionPlan.rdf
The used RDF encoding is guessed by the file extension. If the extension is not recognized the format can be also parsed as additional parameter
+ :::none
stanbol.enhancer.chain.graph.graphresource=myExecutionPlan.something;format=application/rdf+xml
The GraphCain will track for that file and activate itself as soon as the file gets available. Removing the file, waiting some seconds and providing the new version afterwards should also work. Just replacing the file will not work, because the DataFileProvider does not have supports for updates. In such cases it might be needed to deactivate/activate the GraphChain.
@@ -28,10 +30,12 @@ _NOTE_: As soon as a graph resource is c
The Syntax is defined as follows:
+ :::none
{engine-name};[optional];[dependsOn={engine-name1},{engine-name2}]
The following Example shows how this Syntax can be used to define an ExecutionPlan.
+ :::none
metaxa;optional
langId;dependsOn=metaxa
ner;dependsOn=langId
@@ -44,6 +48,7 @@ Not that the internal oder of the list d
Within an osgi configuration file (org.apache.stanbol.enhancer.chain.graph.impl.GraphChain-myGraphChain.config) this would look like
+ :::none
stanbol.enhancer.chain.graph.chainlist=["metaxa;optional","langId;dependsOn\=metaxa","ner;dependsOn\=langId","zemanta;optional","dbpedia-linking;dependsOn\=ner","geonames;optional;dependsOn\=ner","refactor;dependsOn\=geonames,dbpedia-linking,zemanta"]
A better visual expression provides this screenshot of the Apache Feilx Webconsole showing the dialog for the same configuration
Copied: incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/chains/index.mdtext (from r1244417, incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/chains/enhancementchain.mdtext)
URL: http://svn.apache.org/viewvc/incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/chains/index.mdtext?p2=incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/chains/index.mdtext&p1=incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/chains/enhancementchain.mdtext&r1=1244417&r2=1244912&rev=1244912&view=diff
==============================================================================
--- incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/chains/enhancementchain.mdtext (original)
+++ incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/chains/index.mdtext Thu Feb 16 10:06:16 2012
@@ -4,10 +4,12 @@ An Enhancement Chain defines how Content
In the RESTful API enhancement chains can be accessed by there name under
+ :::none
http://{host}:{port}/{stanbol-path}/enhancer/chain/{chain-name}
Enhancement requestes issued to
+ :::none
http://{host}:{port}/{stanbol-path}/enhancer
http://{host}:{port}/{stanbol-path}/engines
@@ -15,6 +17,7 @@ are processed by using the default enhan
When using the Java API Chains can be looked up as OSGI services. The [ChainManager](chainmanager.html) service is designed to ease this by providing a API that allows to access Chains by their name. Because Chains are not responsible to perform the actual execution but only provide the [ExecutionPlan](executionplan.html) one needs to also lookup an EnhancementJobManager instance to enhance a contentItem
+ :::java
@Reference
EnhancementJobManager jobManager;
@@ -40,6 +43,7 @@ To enhance a ContentItem with the defaul
The Chain interface is very simplistic. It only defines three methods.
+ :::java
/** Getter for the name of the Chain */
+ getName() : String
/** Getter for the execution plan */
@@ -51,7 +55,8 @@ The Chain interface is very simplistic.
Each Chain has an name assigned. This is typically provided by the chain configuration and MUST be set as value to the property "stanbol.enhancer.chain.name" of the service registration. The getter for the name MUST return the same value. Chain implementation will usually get the name by calling
- this.name = (String)ComponentContext.getProperties(Chain.PROPERTY_NAME);
+ :::java
+ this.name = (String)ComponentContext.getProperties(Chain.PROPERTY_NAME);
within the activate method of the Chain. There is also an AbstractChain implementation provided by the servicesapi module of the Stanbol Enhancer that already implements this functionality.
Modified: incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/chains/listchain.mdtext
URL: http://svn.apache.org/viewvc/incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/chains/listchain.mdtext?rev=1244912&r1=1244911&r2=1244912&view=diff
==============================================================================
--- incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/chains/listchain.mdtext (original)
+++ incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/chains/listchain.mdtext Thu Feb 16 10:06:16 2012
@@ -12,6 +12,7 @@ In addition it is possible to define Eng
The syntax to define an Engine as optional is as follows
+ :::none
<name>;optional
<name>;optional=true
@@ -25,6 +26,7 @@ It is also possible to configure a ListC
To create the same configuration as in the above screenshot the file would need to look like this:
+ :::none
stanbol.enhancer.chain.name="list"
stanbol.enhancer.chain.list.enginelist=["metaxa;optional","langid","ner","dbpediaLinking"]
Modified: incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/chains/weightedchain.mdtext
URL: http://svn.apache.org/viewvc/incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/chains/weightedchain.mdtext?rev=1244912&r1=1244911&r2=1244912&view=diff
==============================================================================
--- incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/chains/weightedchain.mdtext (original)
+++ incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/chains/weightedchain.mdtext Thu Feb 16 10:06:16 2012
@@ -12,6 +12,7 @@ In addition it is possible to define Eng
The syntax to define an Engine as optional is as follows
+ :::none
<name>;optional
<name>;optional=true
Modified: incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/contentitem.mdtext
URL: http://svn.apache.org/viewvc/incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/contentitem.mdtext?rev=1244912&r1=1244911&r2=1244912&view=diff
==============================================================================
--- incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/contentitem.mdtext (original)
+++ incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/contentitem.mdtext Thu Feb 16 10:06:16 2012
@@ -12,6 +12,7 @@ Content parts are used to represent the
The ContentItem provides the following API to work with ContentParts:
+ :::java
/** Getter for the ContentPart based on the index */
getPart(int index, Class<T> type) : T
/** Getter for the ContentPart based on its ID */
@@ -32,6 +33,7 @@ There are two types of content parts:
The main content of the content item refers to the content parsed by the enhancement request (or downloaded from the URL provided by an request). For accessing this content the following methods are available
+ :::java
/** Getter for the InputStream of the content as parsed
for the ContentItem */
+ getStream() : InputStream
@@ -44,6 +46,7 @@ The <code>getStream()</code> and <code>g
The content parsed by the user is stored as content part at the index '0' with the URI of the content item in the form of a blob. Therefore calling
+ :::java
contentItem.getPart(0,Blob.class)
contentItem.getPart(contentItem.getUri(),Blob.class)
contentItem.getBlob()
@@ -60,11 +63,13 @@ This graph is used to store all enhancem
During the Apache Stanbol enhancement process as executed by the [enhancement job manager](enhancementjobmanager.html) components running in multiple threads need to access the state of the content item. Because of that the content item provides the possibility to acquire locks.
+ :::java
/** Getter for the ReadWirteLock of a ContentItem +/
+ getLock() : java.util.concurrent.ReadWriteLock
Note also that
+ :::java
contentItem.getLock()
contentItem.getMetadata().getLock()
@@ -74,6 +79,7 @@ This lock can be used to request read/wr
However, whenever components need to ensure that the data are not changed by other threads while performing some calculations read/write locks _must be_ used. A typical example are iterations over data returned by the MGraph. In this case code iterating over the results should be protected against concurrent changes by
+ :::java
contentItem.getLock().readLock().lock();
try {
Iterator<Triple> it = contentItem.getMetadata().
Modified: incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/engines/enhancementenginemanager.mdtext
URL: http://svn.apache.org/viewvc/incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/engines/enhancementenginemanager.mdtext?rev=1244912&r1=1244911&r2=1244912&view=diff
==============================================================================
--- incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/engines/enhancementenginemanager.mdtext (original)
+++ incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/engines/enhancementenginemanager.mdtext Thu Feb 16 10:06:16 2012
@@ -6,6 +6,7 @@ The EnhancementEngineManager provides na
This is the Java API providing access to registered EnhancementEngines in the ways as described above. This interface includes the following methods:
+ :::java
/** Getter for all names with active engines */
getActiveEngineNames() : Set<String>
/** Getter for the ServiceReference to the engine
@@ -30,6 +31,7 @@ There are two implementations of this in
This is an implementation of the EnhancementEngineManager interface that is registered as OSGI service. It can be used e.g. by using the @Reference annotation
+ :::java
@Reference
EnhancementEngineManager engineManager
@@ -39,6 +41,7 @@ This service is provided by the "org.apa
This is an Utility similar to the standard OSGI ServiceTracker that allows to track some/all EnhancementEngines. It also supports the usage of a ServiceTrackerCustomizer so that users of that utility can directly react to changes of tracked EnhancementEngines.
+ :::java
//track only "myEngine" and "otherEngine"
EnginesTracker tracker = new EnginesTracker(
context, "myEngine","otherEngine");
Modified: incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/engines/geonamesengine.mdtext
URL: http://svn.apache.org/viewvc/incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/engines/geonamesengine.mdtext?rev=1244912&r1=1244911&r2=1244912&view=diff
==============================================================================
--- incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/engines/geonamesengine.mdtext (original)
+++ incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/engines/geonamesengine.mdtext Thu Feb 16 10:06:16 2012
@@ -6,27 +6,29 @@ This engine creates fise:EntityAnnotatio
This engine consumes fise:TextAnnotations of type dbpedia:Place. More concrete it filters for enhancements that confirm to the following two requirements and consumes the text selected by the TextAnnotations:
- ?textAnnotation rdf:type fise:TextAnnotation .
- ?textAnnotation dc:type dbpedia:Place
- ?textAnnotation fise:selected-text ?text
+ :::none
+ ?textAnnotation rdf:type fise:TextAnnotation .
+ ?textAnnotation dc:type dbpedia:Place
+ ?textAnnotation fise:selected-text ?text
Here an example for such an TextAnnotations selecting the text "Vienna" form the content "The community Workshop will take place in Vienna".
+ :::none
urn:enhancement:text-enhancement:id1
- a fise:TextAnnotation , fise:Enhancement ;
- dc:type
+ a fise:TextAnnotation , fise:Enhancement ;
+ dc:type
dbpedia:Place ;
- fise:selected-text
+ fise:selected-text
"Vienna"^^xsd:string ;
- fise:selection-context
+ fise:selection-context
"The community Workshop will take place in Vienna"^^xsd:string ;
- fise:start
+ fise:start
"46"^^xsd:int ;
- fise:end
+ fise:end
"52"^^xsd:int ;
- fise:confidence
+ fise:confidence
"0.9773640902587215"^^xsd:double ;
- fise:extracted-from
+ fise:extracted-from
urn:content-item:id1 .
Typically such enhancements are created by engines that provide named entity extraction based on some natural language processing framework.
@@ -45,51 +47,53 @@ The following example shows three Entity
The first Entity found in the geonames.orf dataset is the capital city in Austria with an confidence level of 1.0:
+ :::none
urn:enhancement:entity-enhancement:id1
- a fise:EntityAnnotation , fise:Enhancement ;
- fise:confidence
+ a fise:EntityAnnotation , fise:Enhancement ;
+ fise:confidence
"1.0"^^xsd:double ;
- fise:entity-label
+ fise:entity-label
"Vienna"^^xsd:string ;
- fise:entity-reference
+ fise:entity-reference
http://sws.geonames.org/2761369/ ;
- fise:entity-type
+ fise:entity-type
geonames:Feature , dbpedia:Place , dbpedia:Settlement , dbpedia:PopulatedPlace , geonames:P.PPLC ;
- fise:extracted-from
+ fise:extracted-from
urn:content-item:id1 ;
- dc:relation
+ dc:relation
urn:enhancement:text-enhancement:id1 .
With lower confidence levels there are a lot of other populated places with the name "Vienna" found in the geonames.org dataset.
+ :::none
urn:enhancement:entity-enhancement:id2
- a fise:EntityAnnotation , fise:Enhancement ;
- fise:confidence
+ a fise:EntityAnnotation , fise:Enhancement ;
+ fise:confidence
"0.42163702845573425"^^xsd:double ;
- fise:entity-label
+ fise:entity-label
"Vienna"^^xsd:string ;
- fise:entity-reference
+ fise:entity-reference
http://sws.geonames.org/4496671/ ;
- fise:entity-type
+ fise:entity-type
geonames:Feature , dbpedia:Place , dbpedia:Settlement , dbpedia:PopulatedPlace , geonames:P.PPL ;
- fise:extracted-from
+ fise:extracted-from
urn:content-item:id1 ;
- dc:relation
+ dc:relation
urn:enhancement:text-enhancement:id1 .
urn:enhancement:entity-enhancement:id3
- a fise:EntityAnnotation , fise:Enhancement ;
- fise:confidence
+ a fise:EntityAnnotation , fise:Enhancement ;
+ fise:confidence
"0.42163702845573425"^^xsd:double ;
- fise:entity-label
+ fise:entity-label
"Vienna"^^xsd:string ;
- fise:entity-reference
+ fise:entity-reference
http://sws.geonames.org/4825976/ ;
- fise:entity-type
+ fise:entity-type
geonames:Feature , dbpedia:Place , dbpedia:Settlement , dbpedia:PopulatedPlace , geonames:P.PPL ;
- fise:extracted-from
+ fise:extracted-from
urn:content-item:id1 ;
- fdc:relation
+ dc:relation
urn:enhancement:text-enhancement:id1 .
@@ -104,89 +108,94 @@ The following example shows the entity h
First the enhancement for the continent Europe:
+ :::none
urn:enhancement:entity-hierarchy-enhancement:id1
- a fise:EntityAnnotation , fise:Enhancement ;
- fise:confidence
+ a fise:EntityAnnotation , fise:Enhancement ;
+ fise:confidence
"0.42163702845573425"^^xsd:double ;
- fise:entity-label
+ fise:entity-label
"Europe"^^xsd:string ;
- fise:entity-reference
+ fise:entity-reference
http://sws.geonames.org/6255148/ ;
- fise:entity-type
+ fise:entity-type
geonames:Feature , dbpedia:Place, geonames:L.CONT ;
- fise:extracted-from
+ fise:extracted-from
urn:content-item:id1 ;
- dc:requires
+ dc:requires
urn:enhancement:entity-enhancement:id1 .
###Country: Austria
Next the enhancement for the country "Austria", classified as an independent political entry within geonames.org
+ :::none
urn:enhancement:entity-hierarchy-enhancement:id2
- a fise:EntityAnnotation , fise:Enhancement ;
- fise:confidence
+ a fise:EntityAnnotation , fise:Enhancement ;
+ fise:confidence
"0.42163702845573425"^^xsd:double ;
- fise:entity-label
+ fise:entity-label
"Austria"^^xsd:string ;
- fise:entity-reference
+ fise:entity-reference
http://sws.geonames.org/2782113/ ;
- fise:entity-type
+ fise:entity-type
geonames:Feature , dbpedia:Place, dbpedia: AdministrativeRegion, geonames:A.PCLI ;
- fise:extracted-from
+ fise:extracted-from
urn:content-item:id1 ;
- dc:requires
+ dc:requires
urn:enhancement:entity-enhancement:id1 .
### A.ADM1 - A county
Now three enhancement describing the different hierarchies of administrative regions within Austria. First the "Bundesland", next the "Stadtteil" and last the "Gemeindebezirk".
-
+ :::none
urn:enhancement:entity-hierarchy-enhancement:id3
- a fise:EntityAnnotation , fise:Enhancement ;
- fise:confidence
+ a fise:EntityAnnotation , fise:Enhancement ;
+ fise:confidence
"0.42163702845573425"^^xsd:double ;
- fise:entity-label
+ fise:entity-label
"Vienna"^^xsd:string ;
- fise:entity-reference
+ fise:entity-reference
http://sws.geonames.org/2761367/ ;
- fise:entity-type
+ fise:entity-type
geonames:Feature , dbpedia:Place, dbpedia: AdministrativeRegion, geonames:A.ADM1 ;
- fise:extracted-from
+ fise:extracted-from
urn:content-item:id1 ;
- dc:requires
+ dc:requires
urn:enhancement:entity-enhancement:id1 .
### A.ADM2 - A city
+ :::none
urn:enhancement:entity-hierarchy-enhancement:id4
- a fise:EntityAnnotation , fise:Enhancement ;
- fise:confidence
+ a fise:EntityAnnotation , fise:Enhancement ;
+ fise:confidence
"0.42163702845573425"^^xsd:double ;
- fise:entity-label
+ fise:entity-label
"Politischer Bezirk Wien (Stadt)"^^xsd:string ;
- fise:entity-reference
+ fise:entity-reference
http://sws.geonames.org/2761333/ ;
- fise:entity-type
+ fise:entity-type
geonames:Feature , dbpedia:Place, dbpedia: AdministrativeRegion, geonames:A.ADM2 ;
- fise:extracted-from
+ fise:extracted-from
urn:content-item:id1 ;
- dc:requires
+ dc:requires
urn:enhancement:entity-enhancement:id1 .
### A.ADM3 - A village
+
+ :::none
urn:enhancement:entity-hierarchy-enhancement:id5
- a fise:EntityAnnotation , fise:Enhancement ;
- fise:confidence
+ a fise:EntityAnnotation , fise:Enhancement ;
+ fise:confidence
"0.42163702845573425"^^xsd:double ;
- fise:entity-label
+ fise:entity-label
"Gemeindebezirk Innere Stadt"^^xsd:string ;
- fise:entity-reference
+ fise:entity-reference
http://sws.geonames.org/2775259/ ;
- fise:entity-type
+ fise:entity-type
geonames:Feature , dbpedia:Place, dbpedia: AdministrativeRegion, geonames:A.ADM3 ;
- fise:extracted-from
+ fise:extracted-from
urn:content-item:id1 ;
- dc:requires
+ dc:requires
urn:enhancement:entity-enhancement:id1 .
The last two hierarchy levels are no longer valid for the meaning of "Vienna" as selected by the TextAnnotation, but added, because the geonames.org dataset locations the Feature of cities exactly in the center. However if the TextAnnotation would describe a precise address such hierarchy levels would completely make sense.
@@ -196,26 +205,16 @@ The last two hierarchy levels are no lon
The LocationEnhancementEngine provides six configurations
The first three can be used to optimise the behaviour of the Engine
- - Minimum score (default = 0.33): The minimum score (confidence) that is required
- for entity suggestions
- - Maximum Locations (default = 3): The maximum numbers of entity
- suggestions added (regardless if there would be more results with a
- score > min-score.
- - Maximum Locations (default = 0.7): The minimum score (confidence) that is
- required that hierarchy enhancements are added for an suggested entity.
- To add hierarchy enhancements for all suggested entities
- min-hierarchy-score needs to be set to a value smaller equals
- than min-score.
+
+* Minimum score (default = 0.33): The minimum score (confidence) that is required for entity suggestions
+* Maximum Locations (default = 3): The maximum numbers of entity suggestions added (regardless if there would be more results with a score > min-score.
+* Maximum Locations (default = 0.7): The minimum score (confidence) that is required that hierarchy enhancements are added for an suggested entity. To add hierarchy enhancements for all suggested entities min-hierarchy-score needs to be set to a value smaller equals than min-score.
The other three are used to configure the configured geonames.org server
- - geonames.org Server: The URL of the geonames.org service. The default is the
- free geonames.org webserver that works without user authentication. There
- is a second free server at http://api.geonames.org/ that requires to setup
- a free user account. Users with a premium account will require to add here
- there own URL
- - User Name: Thats the name of the account (can be empty if the configured
- server does not require user authentication
- - Token: The token is usually the password of the user account.
+
+* geonames.org Server: The URL of the geonames.org service. The default is the free geonames.org webserver that works without user authentication. There is a second free server at http://api.geonames.org/ that requires to setup a free user account. Users with a premium account will require to add here there own URL
+* User Name: Thats the name of the account (can be empty if the configured server does not require user authentication
+* Token: The token is usually the password of the user account.
### HOWTO setup a free user account:
@@ -225,19 +224,13 @@ The other three are used to configure th
free server available at http://ws.geonames.org/.
To setup the free account:
-(1) go to www.geonames.org. In the right top corner you will find a "login" link
- that is also used to create new accounts
-(2) choose a username and pwd. You will get an confirmation mail at the provided
- email address. When choosing the password consider, that it will be sent
- unencrypted (as token) with every webservice Request. Therefore it is
- strongly suggested to do not use an password that is used for any other
- account!
-(3) confirm the account
-(4) IMPORTANT: You need to activate the free web service for the account via
- http://www.geonames.org/manageaccount. Log in first, go back to this site.
- At the botton you should find the text "the account is not yet enabled to
- use the free web services. Click here to enable"
-
-If you do not complete step (4) requests with your account will result in
-IOExceptions with the message
- "user account not enabled to use the free webservice. Please enable it on your account page: http://www.geonames.org/manageaccount"
+
+1. go to www.geonames.org. In the right top corner you will find a "login" link that is also used to create new accounts
+2. choose a username and pwd. You will get an confirmation mail at the provided email address. When choosing the password consider, that it will be sent unencrypted (as token) with every webservice Request. Therefore it is strongly suggested to do not use an password that is used for any other account!
+3. confirm the account
+4. IMPORTANT: You need to activate the free web service for the account via http://www.geonames.org/manageaccount. Log in first, go back to this site. At the botton you should find the text "the account is not yet enabled to use the free web services. Click here to enable"
+
+If you do not complete step (4) requests with your account will result an IOExceptions with the message
+
+ :::java
+ "user account not enabled to use the free webservice. Please enable it on your account page: http://www.geonames.org/manageaccount"
Modified: incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/engines/index.mdtext
URL: http://svn.apache.org/viewvc/incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/engines/index.mdtext?rev=1244912&r1=1244911&r2=1244912&view=diff
==============================================================================
--- incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/engines/index.mdtext (original)
+++ incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/engines/index.mdtext Thu Feb 16 10:06:16 2012
@@ -4,10 +4,12 @@ Enhancement engines are the components t
The RESTful interface of an enhancement engine can be accessed by
+ :::none
http://{host}:{port}/{stanbol-root}/enhancer/engine/{engine-name}
e.g. an enhancement engine with the name "ner" running at a Apache Stanbol instance on local host with the default configuration will be accessible at
+ :::none
http://localhost:8080/enhancer/engine/ner
When using the Java API enhancement engines can be liked up as OSGI services. The [Enhancement Engine Manager](enhancementenginemanager.html) service is designed to ease this by providing a API that allows to access enhancement engine by their name.
@@ -16,6 +18,7 @@ When using the Java API enhancement engi
The interface for enhancement engines contains the following three methods:
+ :::java
/** Getter for the value of the "stanbol.enhancer.engine.name" property */
+ getName() : String
/** Checks if this engine can enhance the parsed content item */
@@ -34,7 +37,8 @@ The interface for enhancement engines co
Each enhancement engine has a name. This is typically provided by the engine configuration and MUST be set as value to the property "stanbol.enhancer.engine.name" in the service registration of the enhancement engine. The getter for the name MUST return the same value as the value set to this property. Enhancement engine implementations will usually get the name by calling:
- this.name = (String)ComponentContext.getProperties(EnhancementEngine.PROPERTY_NAME);
+ :::java
+ this.name = (String)ComponentContext.getProperties(EnhancementEngine.PROPERTY_NAME);
The <code>canEnahnce(ContentItem ci)</code> method is used by the [Enhancement Job Manager](../enhancementjobmanager.html) to check if an engine is able to process a [Content Item](../contentitem.html). Calling this method MUST NOT change the state of the content item and this method MUST also NOT acquire a write lock on the content item.
@@ -53,6 +57,7 @@ Both the <code>canEnhance(..)</code> and
This interface is implemented by most of the current enhancement engines. It allows engines to expose additional properties to other component. This interface defines a single method
+ :::java
/** Getter for the ServiceProperties */
Map<String,Object> getServiceProperties();
@@ -62,6 +67,7 @@ but also predefines the property <code>E
By implementing the ServicesProperties interface enhancement engines do have the possibility to expose additional metadata to other components. The services properties interface defines only a single method
+ :::java
/** Getter for the ServiceProperties */
Map<String,Object> getServiceProperties();
@@ -82,7 +88,7 @@ However, the engine ordering is not the
## Enhancement Engine Management
-This section describes how enhancement engines are managed by the Apache Stanbol Enhancer and how they can be selected/accessed through the [Enhancement Job Manager](../enhancementjobmanager.html) and executed in an [Enhancement Chain](../chains/enhancementchain.html).
+This section describes how enhancement engines are managed by the Apache Stanbol Enhancer and how they can be selected/accessed through the [Enhancement Job Manager](../enhancementjobmanager.html) and executed in an [Enhancement Chain](../chains).
Enhancement engines are registered as OSGi services and managed by using the following service properties:
Modified: incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/engines/keywordlinkingengine.mdtext
URL: http://svn.apache.org/viewvc/incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/engines/keywordlinkingengine.mdtext?rev=1244912&r1=1244911&r2=1244912&view=diff
==============================================================================
--- incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/engines/keywordlinkingengine.mdtext (original)
+++ incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/engines/keywordlinkingengine.mdtext Thu Feb 16 10:06:16 2012
@@ -12,15 +12,10 @@ The following list provides a short over
* **Language detection:** The KeywordLinkingEngine depends on the correct detection of the language by the LanguageIdentificationEngine. If no language is detected or this information is missing then "English" is assumed as default.
* **Multi-lingual labels of the controlled vocabulary:** Entities are matched based on labels of the current language and labels without any defined language. e.g. English labels will not be matched against German language texts. Therefore it is important to have a controlled vocabulary that includes labels in the language of the texts you want to enhance.
* **Natural Language Processing support:** The KeywordLinkingEngine is able to use [Sentence Detectors](http://opennlp.sourceforge.net/api/opennlp/tools/sentdetect/SentenceDetector.html), [POS (Part of Speech) taggers](http://opennlp.sourceforge.net/api/opennlp/tools/postag/POSTagger.html) and [Chunkers](http://opennlp.sourceforge.net/api/opennlp/tools/chunker/Chunker.html). If such components are available for a language then they are used to optimize the enhancement process.
-
- * **Sentence detector:** If a sentence detector is present the memory footprint of the engines improves, because Tokens, POS tags and Chunks are only kept for the currently active sentence. If no sentence detector is available the entire content is treated as a single sentence.
-
- * **Tokenizer:** A (word) [tokenizer](http://opennlp.sourceforge.net/api/opennlp/tools/tokenize/Tokenizer.html) is required for the enhancement process. If no specific tokenizer is available for a given language, then the [OpenNLP SimpleTokenizer](http://opennlp.sourceforge.net/api/opennlp/tools/tokenize/SimpleTokenizer.html) is used as default. How well this tokenizer works will depend on the language.
-
- * **POS tagger:** POS (Part-of-Speech) taggers annotate tokens with their type. Because of the KeywordLinkingEngine is only interested in Nouns, Foreign Words and Numbers, the presence of such a tagger allows to skip a lot of the tokens and to improve performance. However POS taggers use different sets of tags for different languages. Because of that it is not enough that a POS tagger is available for a language there MUST BE also a configuration of the POS tags representing Nouns.
-
- * **Chunker:** There are two types of Chunkers. First the [Chunkers](http://opennlp.sourceforge.net/api/opennlp/tools/chunker/Chunker.html) as provided by OpenNLP (based on statistical models) and second a [POS tag based Chunker](http://svn.apache.org/repos/asf/incubator/stanbol/trunk/commons/opennlp/src/main/java/org/apache/stanbol/commons/opennlp/PosTypeChunker.java) provided by the openNLP bundle of Stanbol. Currently the availability of a Chunker does not have a big influence on the performance nor the quality of the Enhancements.
-
+* **Sentence detector:** If a sentence detector is present the memory footprint of the engines improves, because Tokens, POS tags and Chunks are only kept for the currently active sentence. If no sentence detector is available the entire content is treated as a single sentence.
+* **Tokenizer:** A (word) [tokenizer](http://opennlp.sourceforge.net/api/opennlp/tools/tokenize/Tokenizer.html) is required for the enhancement process. If no specific tokenizer is available for a given language, then the [OpenNLP SimpleTokenizer](http://opennlp.sourceforge.net/api/opennlp/tools/tokenize/SimpleTokenizer.html) is used as default. How well this tokenizer works will depend on the language.
+* **POS tagger:** POS (Part-of-Speech) taggers annotate tokens with their type. Because of the KeywordLinkingEngine is only interested in Nouns, Foreign Words and Numbers, the presence of such a tagger allows to skip a lot of the tokens and to improve performance. However POS taggers use different sets of tags for different languages. Because of that it is not enough that a POS tagger is available for a language there MUST BE also a configuration of the POS tags representing Nouns.
+* **Chunker:** There are two types of Chunkers. First the [Chunkers](http://opennlp.sourceforge.net/api/opennlp/tools/chunker/Chunker.html) as provided by OpenNLP (based on statistical models) and second a [POS tag based Chunker](http://svn.apache.org/repos/asf/incubator/stanbol/trunk/commons/opennlp/src/main/java/org/apache/stanbol/commons/opennlp/PosTypeChunker.java) provided by the openNLP bundle of Stanbol. Currently the availability of a Chunker does not have a big influence on the performance nor the quality of the Enhancements.
* **Configuration:** The set of languages to be annotated can be configured for the KeywordLinkingEngine. An empty configuration indicates that texts in any language should be processed. By using this configuration it is possible to configure different KeywordLinkingEngine instances for different languages (e.g. with different configurations)
## Keyword extraction and linking workflow ##
@@ -96,7 +91,8 @@ Input Parameters
* span: number of tokens selected by the current suggestion e.g. "Barack Hussein Obama" -> 2
* label_tokens: number of tokens of the matched label of the current entity (label_token) e.g. "Barack Hussein Obama" -> 3
-confidence = (match/max_matched)^2 * (matched/span) * (matched/label_tokens)
+ :::java
+ confidence = (match/max_matched)^2 * (matched/span) * (matched/label_tokens)
Some Examples:
Modified: incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/engines/langidengine.mdtext
URL: http://svn.apache.org/viewvc/incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/engines/langidengine.mdtext?rev=1244912&r1=1244911&r2=1244912&view=diff
==============================================================================
--- incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/engines/langidengine.mdtext (original)
+++ incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/engines/langidengine.mdtext Thu Feb 16 10:06:16 2012
@@ -10,14 +10,17 @@ The text to be checked must be provided
* a plain text content item
* by the content item's metadata as the string value of the property
+ :::html
<pre><code>http://www.semanticdesktop.org/ontologies/2007/01/19/nie#plainTextContent</pre></code>
The result of language identification is added as TextAnnotation to the content item's metadata as string value of the property
+ :::none
http://purl.org/dc/terms/language
This RDF snippet illustrates the output:
+ :::xml
<fise:TextAnnotation rdf:about="urn:enhancement-a147957b-41f9-58f7-bbf1-b880b3aa4b49">
<dc:language>en</dc:language>
<dc:creator>org.apache.stanbol.enhancer.engines.langid.LangIdEnhancementEngine</dc:creator>
@@ -50,17 +53,13 @@ Additional language models can be create
## Configuration options
-* <code>org.apache.stanbol.enhancer.engines.langid.probe-length</code>
-
- an integer specifying how many characters will be used for
- identification. A value of 0 or below means to use the complete
- text. Otherwise only a substring of the specified length taken from the
- middle of the text will be used. The default value is 400 characters.
+* <code>org.apache.stanbol.enhancer.engines.langid.probe-length</code>: an integer specifying how many characters will be used for identification. A value of 0 or below means to use the complete text. Otherwise only a substring of the specified length taken from the middle of the text will be used. The default value is 400 characters.
## Usage
Assuming that the Stanbol endpoint with the full launcher is running at
+ :::none
http://localhost:8080
and the engine is activated, from the command line commands like this
@@ -68,13 +67,16 @@ can be used for submitting some text fil
* stateless interface
+ :::bash
curl -i -X POST -H "Content-Type:text/plain" -T testfile.txt http://localhost:8080/engines
* stateful interface
+ :::bash
curl -i -X PUT -H "Content-Type:text/plain" -T testfile.txt http://localhost:8080/contenthub/content/someFileId
Alternatively, the Stanbol web interface can be used for submitting documents
and viewing the metadata at
+ :::none
http://localhost:8080/contenthub
Modified: incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/engines/metaxaengine.mdtext
URL: http://svn.apache.org/viewvc/incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/engines/metaxaengine.mdtext?rev=1244912&r1=1244911&r2=1244912&view=diff
==============================================================================
--- incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/engines/metaxaengine.mdtext (original)
+++ incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/engines/metaxaengine.mdtext Thu Feb 16 10:06:16 2012
@@ -14,6 +14,7 @@ The general structure of the Metaxa anno
#### The top-level <tt>TextAnnotation</tt> instance
+ :::none
<urn:enhancement-03c9e85e-2681-21b7-a5af-6da62d67ef6b>
a <http://fise.iks-project.eu/ontology/TextAnnotation> ,
<http://fise.iks-project.eu/ontology/Enhancement> ;
@@ -29,6 +30,7 @@ The general structure of the Metaxa anno
#### The top-level document metadata, referenced from the <tt>TextAnnotation</tt> instance via the *extracted-from* property:
+ :::none
<http://localhost:8080/store/content/mf_example.htm>
a <http://www.semanticdesktop.org/ontologies/2007/03/22/nfo#HtmlDocument> ;
<http://www.semanticdesktop.org/ontologies/2007/01/19/nie#contains>
@@ -37,14 +39,15 @@ The general structure of the Metaxa anno
"Cheap Flights to Tenerife, Arrecife, Paphos, Mahon, Las Palmas, Malaga, Alicante, Faro, Heraklion, Palma and the rest of the World. Flightline searches over 100 Airlines and 30,000 Hotels. ABTA, IATA, ATOL Bonded." ;
<http://www.semanticdesktop.org/ontologies/2007/01/19/nie#keyword>
"travel" , "bargain flights" , "late deals" , "hotels" , "air tickets" , "air fares" , "discount travel" , "last minute flights" , "cheap airlines" , "cheap holidays" , "cheap flights" , "flightline" , "hotel reservations" , "discount flights" , "air travel" , "package holidays" ;
- <http://www.semanticdesktop.org/ontologies/2007/01/19/nie#plainTextContent>
- "More Than Just Cheap Flights ..." ;
<http://www.semanticdesktop.org/ontologies/2007/01/19/nie#title>
"Flightline | Cheap Flights, Package Holidays, Hotels, Travel Insurance & More" .
+NOTE: The extracted plain text is no longer added to the metadata of the contentItem but stores in an own [ContentPart](../contentitem.html#content_parts) with the media type "text/plain". Both the RESTful Service as the Java API allows to request this data. See the according documentations for details.
+
#### Embedded <tt>hCard</tt> microformat data referenced via the <tt>nie:contains</tt> property:
+ :::none
<urn:rnd:-9e25553:12b3843df43:-7ffe>
a <http://www.w3.org/2006/vcard/ns#VCard> ;
<http://www.w3.org/2006/vcard/ns#adr>
@@ -90,7 +93,6 @@ The general structure of the Metaxa anno
"0.700753927230835" .
-
### Supported document types
The set of extraction engines for specific document types is defined by the resource *extractionregistry.xml*. Each engine specifies what MIME types it can handle. By default the extraction registry provides extractors for the
@@ -133,9 +135,19 @@ following set of document formats:
### Textual Content
-Metaxa represents the plain text content of a document in the content item's metadata as the value of the property:
+The extracted plain text is no longer added to the metadata of the contentItem but stores in an own [ContentPart](../contentitem.html#content_parts) with the media type "text/plain".
+
+The following POST request to the Enhancer can be used to directly request the plain text version of a parsed content
+
+ :::bash
+ curl -v -X POST -H "Accept: text/plain" \
+ -H "Content-type: text/html; charset=UTF-8" \
+ --data "<html><body><p>John Smith was born in London.</p></body></html>" \
+ "http://localhost:8080/enhancer/chain/language?omitMetadata=true"
+
+There is also the possibility to request both the extracted metadata and the plain text version. Please see the Documentation of the RESTful API ([http://localhost:8080/enhacer](http://localhost:8080/enhacer) if Stanbol runs on localhost).
- http://www.semanticdesktop.org/ontologies/2007/01/19/nie#plainTextContent
+NOTE: previous versions of this engine had stored the plain text version by using the "http://www.semanticdesktop.org/ontologies/2007/01/19/nie#plainTextContent" property directly in the metadata of the ContentItem. This is no longer supported.
### Vocabularies
@@ -146,20 +158,24 @@ Metaxa uses a set of vocabularies ("onto
These ontologies belong to the underlying Aperture subsystem, contained in the
package
+ :::none
org.semanticdesktop.aperture.vocabulary
The most important ones with respect to top-level document properties are
* NIE (Nepomuk Information Element):
+ :::none
http://www.semanticdesktop.org/ontologies/2007/01/19/nie#
* NFO (Nepomuk File Object):
+ :::none
http://www.semanticdesktop.org/ontologies/2007/01/19/nfo#
Documentation of Aperture's core ontologies is provided in Aperture's Javadoc [http://aperture.sourceforge.net/doc/javadoc/1.5.0/index.html](http://aperture.sourceforge.net/doc/javadoc/1.5.0/index.html) for the packages in
+ :::none
org.semanticdesktop.aperture.vocabulary.
#### HTML Microformat Extractors
@@ -250,6 +266,7 @@ The following table describes which voca
By default, Metaxa uses the extractors specified in the resource "extractionregistry.xml", and for HTML pages, the resource "htmlregistry.xml".
Alternative configurations and extractors can be attached to Metaxa as fragment bundles, specifying as host bundle
+ :::none
Fragment-Host: org.apache.stanbol.enhancer.engines.metaxa
The alternative configuration files then can be set as values of the properties
@@ -262,20 +279,24 @@ The alternative configuration files then
Assuming that the Stanbol endpoint with the full launcher is running at
+ :::none
http://localhost:8080
and the engine is activated, from the command line commands like this can be used for submitting some file as content item, where the mime type must match the document type:
* stateless interface
+ :::none
curl -i -X POST -H "Content-Type:text/html" -T testpage.html http://localhost:8080/engines
* stateful interface
+ :::none
curl -i -X PUT -H "Content-Type:text/html" -T testpage.html http://localhost:8080/contenthub/content/someFileId
Alternatively, the Stanbol web interface can be used for submitting documents
and viewing the metadata at
+ :::none
http://localhost:8080/contenthub
Modified: incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/engines/namedentityextractionengine.mdtext
URL: http://svn.apache.org/viewvc/incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/engines/namedentityextractionengine.mdtext?rev=1244912&r1=1244911&r2=1244912&view=diff
==============================================================================
--- incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/engines/namedentityextractionengine.mdtext (original)
+++ incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/engines/namedentityextractionengine.mdtext Thu Feb 16 10:06:16 2012
@@ -9,6 +9,7 @@ This engine is based on the NLP features
This engine adds **TextAnnotation-Enhancements** for the text "John Smith lives in London", (amongst other) the following information to the enhancement graph, suggesting London (of type: Place) for the string London:
+ :::none
{
"@subject": "<urn:enhancement-e6a08398-a49f-5bf6-c09f-6da5db63507e>",
"@type": [
Modified: incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/engines/namedentitytaggingengine.mdtext
URL: http://svn.apache.org/viewvc/incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/engines/namedentitytaggingengine.mdtext?rev=1244912&r1=1244911&r2=1244912&view=diff
==============================================================================
--- incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/engines/namedentitytaggingengine.mdtext (original)
+++ incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/engines/namedentitytaggingengine.mdtext Thu Feb 16 10:06:16 2012
@@ -6,43 +6,20 @@ The Entity Linking Engine uses *[Referen
The configuration decides, which dataset you want to use as linking target. The default value is "local" referencing to the default DBpedia index. You may also decide on whether given types should restrict the set of possible links. E.g. for DBpedia, some organisations are not tagged as such, therefore, you want get them with this engine although, you expect them from your dataset.
-- Referenced Site: {local, your referenced site}
-
- *The ID of the Entityhub Referenced Site used for semantic lifting of TextAnnotations.*
-
-- Persons: {true, false}
-
- *Set to TRUE to enable semantic lifting of Persons*
-
-- Person Type {<empty>, dbp-ont:Person}
-
- *The rdf:type used to search for Persons. If empty Entities of any type are accepted.*
-
-- Organisations {true, false}
-
- *Set to TRUE to enable semantic lifting of Organisations*
-
-- Organisation Type {<empty>, dbp-ont:Organisation}
-
- *The rdf:type used to search for Organizations. If empty Entities of any type are accepted.*
-
-- Places {true, false}
-
- *Set to TRUE to enable semantic lifting of Places*
-
-- Place Type {<empty>, dbp-ont:Place}
-
- *The rdf:type used to search for Places. If empty Entities of any type are accepted.*
-
-- Label Field {<empty>, rdfs:label}
-
- *The field used to search for Entities with a label similar to the selected text of the Text Annotation. If empty rdfs:label is used as default*
-
+* Referenced Site: {local, your referenced site}: The ID of the Entityhub Referenced Site used for semantic lifting of TextAnnotations.
+* Persons: {true, false}: Set to TRUE to enable semantic lifting of Persons
+* Person Type {<empty>, dbp-ont:Person}: The rdf:type used to search for Persons. If empty Entities of any type are accepted.
+* Organisations {true, false}: Set to TRUE to enable semantic lifting of Organisations
+* Organisation Type {<empty>, dbp-ont:Organisation}: The rdf:type used to search for Organizations. If empty Entities of any type are accepted.
+* Places {true, false}: Set to TRUE to enable semantic lifting of Places
+* Place Type {<empty>, dbp-ont:Place}: The rdf:type used to search for Places. If empty Entities of any type are accepted.*
+* Label Field {<empty>, rdfs:label}: The field used to search for Entities with a label similar to the selected text of the Text Annotation. If empty rdfs:label is used as default*
## Example Result
For the sentence "John Smith lives in London", you will get several EntityAnnotations for the terms "London", "John Smith" form your linking target resource (in this case DBpedia) together with a confidence value, which can be used to sort the suggestions.
+ :::none
{
"@subject": "<urn:enhancement-2ec0662c-3a10-f8f5-43b4-cf7403e4c39d>",
"@type": [
Modified: incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/engines/opencalaisengine.mdtext
URL: http://svn.apache.org/viewvc/incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/engines/opencalaisengine.mdtext?rev=1244912&r1=1244911&r2=1244912&view=diff
==============================================================================
--- incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/engines/opencalaisengine.mdtext (original)
+++ incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/engines/opencalaisengine.mdtext Thu Feb 16 10:06:16 2012
@@ -13,6 +13,7 @@ The engine natively supports the mime ty
*text/html*. Additionally, text can be processed that is provided in the content
item's metadata as value of the property
+ :::none
http://www.semanticdesktop.org/ontologies/2007/01/19/nie#plainTextContent
Supported languages are
@@ -29,50 +30,33 @@ obtained from [http://www.opencalais.com
In the OSGi configuration the key is set as value of the property
+ :::none
org.apache.stanbol.enhancer.engines.opencalais.license
Also, the unit tests require the API key. Without the key some tests will be
skipped. For Maven the key can be set as a system property on the command line:
+ :::bash
mvn -Dorg.apache.stanbol.enhancer.engines.opencalais.license=YOUR_API_KEY [install|test]
The following configuration properties are defined:
-* <tt>org.apache.stanbol.enhancer.engines.opencalais.license</tt>
-
- The OpenCalais license key that **must** be defined.
-
-* <tt>org.apache.stanbol.enhancer.engines.opencalais.url</tt>
-
- The URL of the OpenCalais RESTful service. That needs only be changed
- when OpenCalais should change its web service address.
-
-* <tt>org.apache.stanbol.enhancer.engines.opencalais.typeMap</tt>
-
- The value is the name
- of a file for mapping the NER types from OpenCalais to other types. By
- default, a mapping to the DBPedia types is provided in order to achieve
- compatibility with the Stanbol OpenLNLP-NER engine. If no mapping is
- desired one might pass an empty mapping file. Types for which no
- mapping is defined are passed as is to the metadata. The syntax of the
- mapping table is similar to that of Java property files. Each entry
- takes the form
+* <tt>org.apache.stanbol.enhancer.engines.opencalais.license</tt>: The OpenCalais license key that **must** be defined.
+* <tt>org.apache.stanbol.enhancer.engines.opencalais.url</tt>: The URL of the OpenCalais RESTful service. That needs only be changed when OpenCalais should change its web service address.
+* <tt>org.apache.stanbol.enhancer.engines.opencalais.typeMap</tt>: The value is the name of a file for mapping the NER types from OpenCalais to other types. By default, a mapping to the DBPedia types is provided in order to achieve compatibility with the Stanbol OpenLNLP-NER engine. If no mapping is desired one might pass an empty mapping file. Types for which no mapping is defined are passed as is to the metadata. The syntax of the mapping table is similar to that of Java property files. Each entry takes the form
+ :::none
CalaisTypeURI=TargetTypeURI
-* <tt>org.apache.stanbol.enhancer.engines.opencalais.NERonly</tt>
-
- A Boolean property to
- specify whether in addition to the NER enhancements also the OpenCalais
- Linked Data references are included as entity references. By default,
- these are omitted.
+* <tt>org.apache.stanbol.enhancer.engines.opencalais.NERonly</tt>: A Boolean property to specify whether in addition to the NER enhancements also the OpenCalais Linked Data references are included as entity references. By default, these are omitted.
## Usage
Assuming that the Stanbol endpoint with the full launcher is running at
+ :::none
http://localhost:8080
the license key has been defined and the engine is activated, from the
@@ -80,14 +64,17 @@ command line commands like this can be u
* stateless interface
+ :::bash
curl -i -X POST -H "Content-Type:text/plain" -T testfile.txt http://localhost:8080/engines
* stateful interface
+ :::bash
curl -i -X PUT -H "Content-Type:text/plain" -T testfile.txt http://localhost:8080/contenthub/content/someFileId
Alternatively, the Stanbol web interface can be used for submitting documents
and viewing the metadata at
+ :::none
http://localhost:8080/contenthub
Modified: incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/engines/refactorengine.mdtext
URL: http://svn.apache.org/viewvc/incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/engines/refactorengine.mdtext?rev=1244912&r1=1244911&r2=1244912&view=diff
==============================================================================
--- incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/engines/refactorengine.mdtext (original)
+++ incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/engines/refactorengine.mdtext Thu Feb 16 10:06:16 2012
@@ -6,9 +6,9 @@ snippets.
##Technical Description
This enhancement engine requires the following components running:
-- Stanbol Entityhub
-- Stanbol Refactor
-- Stanbol OntoNet
+* Stanbol Entityhub
+* Stanbol Refactor
+* Stanbol OntoNet
##Example
Modified: incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/engines/zemantaengine.mdtext
URL: http://svn.apache.org/viewvc/incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/engines/zemantaengine.mdtext?rev=1244912&r1=1244911&r2=1244912&view=diff
==============================================================================
--- incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/engines/zemantaengine.mdtext (original)
+++ incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/engines/zemantaengine.mdtext Thu Feb 16 10:06:16 2012
@@ -4,15 +4,17 @@ Enhancement engine that uses the Zemanta
## Usage
-- build ("mvn install") and deploy the Clerezza bundle org.apache.clerezza.rdf.jena.parser
+If the Engine does not show up in the Componets tab of the Apache Felix Web Console you will first need to build and install this Engine to your OSGI environment
-- build the jar ("mvn install")
+1. build ("mvn install") and deploy the Clerezza bundle org.apache.clerezza.rdf.jena.parser
+2. build the jar ("mvn install")
+3. import the jar into the OSGi runtime (all default
-- import the jar into the OSGi runtime
+To use this Enhancement Engine it is important to configure your Zemanta API key.
-- In the OSGi web console, set the property "org.apache.stanbol.enhancer.engines.zemanta.key" with your API key
- (restart the bundle in the OSGi console)
+* In the OSGi web console, set the property "org.apache.stanbol.enhancer.engines.zemanta.key" with your API key
+* restart the component in the OSGi console
+* Watch the console when you add text using commands such as:
-- Watch the console when you add text using commands such as:
-
- curl -T myText.txt -H Content-Type:text/plain http://localhost:8080/fise/someId
\ No newline at end of file
+ :::bash
+ curl -T myText.txt -H Content-Type:text/plain http://localhost:8080/enhancer
\ No newline at end of file
Modified: incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/enhancementjobmanager.mdtext
URL: http://svn.apache.org/viewvc/incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/enhancementjobmanager.mdtext?rev=1244912&r1=1244911&r2=1244912&view=diff
==============================================================================
--- incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/enhancementjobmanager.mdtext (original)
+++ incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/enhancementjobmanager.mdtext Thu Feb 16 10:06:16 2012
@@ -1,13 +1,14 @@
Title: EnhancementJobManager
-The EnhancementJobManager is component responsible for the execution of the [ExecutionPlan](chains/executionplan.html) as provided by the [Enhancement Chain](chains/enhancementchain.html) on the [ContentItem](contentitem.html).
+The EnhancementJobManager is component responsible for the execution of the [ExecutionPlan](chains/executionplan.html) as provided by the [Enhancement Chain](chains) on the [ContentItem](contentitem.html).
## EnhancementJobManager interface
The interface of the EnhancementJobManager is very simple:
+ :::java
/** Enhances the content item by using the default Chain */
+ enhanceContent(ContentItem ci)
/** Enhances the content item by using the parsed Chain */
@@ -42,6 +43,7 @@ For details on how to initialize/load th
The ExecutionPlan provides the necessary information what [EnhancementEngine](engines/enhancementengine.html)s can be executed at any given state. The following code shows how to determine executable engines.
This code snippet assumes to be called after the execution of an EnhancementEngine has completed. Note that in a multi threaded environment access to the list of executed and running engines need to be synchronized.
+ :::java
Collection<NonLiteral> executed; //already executed Engines
Collection<NonLiteral> running; //currently running Engines
Modified: incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/executionmetadata.mdtext
URL: http://svn.apache.org/viewvc/incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/executionmetadata.mdtext?rev=1244912&r1=1244911&r2=1244912&view=diff
==============================================================================
--- incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/executionmetadata.mdtext (original)
+++ incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/executionmetadata.mdtext Thu Feb 16 10:06:16 2012
@@ -1,6 +1,6 @@
Title: Execution Metadata
-The execution metadata provide detailed information about an ongoing/completed enhancement process. Basically they describe how the [ExecutionPlan](chains/executionplan.html) provided by the [Chain](chains/enhancementchain.html) was executed by the [EnhancementJobManager](enhancementjobmanager.html). Both the ExecutionMetadata and the ExecutionPlan are provided with the ContentItem as an own content part of the type MGraph with the URI "http://stanbol.apache.org/ontology/enhancer/executionMetadata#ChainExecution". For users of the Stanbol Enhacer the Execution Metadata are of interest to:
+The execution metadata provide detailed information about an ongoing/completed enhancement process. Basically they describe how the [ExecutionPlan](chains/executionplan.html) provided by the [Chain](chains) was executed by the [EnhancementJobManager](enhancementjobmanager.html). Both the ExecutionMetadata and the ExecutionPlan are provided with the ContentItem as an own content part of the type MGraph with the URI "http://stanbol.apache.org/ontology/enhancer/executionMetadata#ChainExecution". For users of the Stanbol Enhacer the Execution Metadata are of interest to:
* check progress of asynchronously started Enhancement Processes: Metadata for all planed executions of engines are created as soon as an ContentItem is parsed to the EnhancementJobManager and are updated as soon as the execution of engines start/complete/fail.
* Monitor the performance of different EnhancementEngines: The Execution Metadata provide detailed information about starting/completion time points for engine executions.
@@ -51,6 +51,7 @@ This example describes the following sit
The RDF graph with the Execution Metadata:
+ :::none
urn:exec
rdf:type em:ChainExecution
em:executionPlan urn:execPlan
@@ -90,6 +91,7 @@ The RDF graph with the Execution Metadat
The Execution Plan: (copy from the example provided in the ExecutionPlan section)
+ :::none
urn:execPlan
rdf:type ep:ExecutionPlan
ep:hasExecutionNode urn:node1, urn:node2, urn:node3, urn:node4, urn:node5
@@ -135,7 +137,7 @@ When the [EnhancementJobManager](enhance
If no ExecutionMetadata are present within a parsed ContentItem a new EnhancementProcess needs to be set up. This includes the following steps:
-1. Get the [ExecutionPlan](chains/executionplan.html) for the parsed enhancement [Chain](chains/enhancementchain.html). If no chain is parsed the default chain need to be acquired by using the [ChainManager](chains/chainmanager.html).
+1. Get the [ExecutionPlan](chains/executionplan.html) for the parsed enhancement [Chain](chains). If no chain is parsed the default chain need to be acquired by using the [ChainManager](chains/chainmanager.html).
2. Create the content part for the ExecutionMetadata with the [ContentItem](contentitem.html) and add the information of the [ExecutionPlan](chains/executionplan.html) to it.
3. Create the initial ExecutionMetadata. This includes the 'em:ChainExecution' instance for the 'ep:ExecutionPlan' as well as 'em:EngineExecution' instances for all 'ep:ExecutionNode's defined by the execution plan. All such 'em:Execution' instances MUST BE created with the 'em:ExecutionStatus' 'em:StatusSheduled'.
@@ -197,6 +199,7 @@ This Section provides some Examples on h
The ExecutionMetadata and the [ExecutionPlan](chains/executionplan.html) are stored in a content part with with URI "http://stanbol.apache.org/ontology/enhancer/executionMetadata#ChainExecution" with the [ContentItem](contentitem.html). The following code segment can be used to retrieve the RDF graph with the ExecutionMetadata:
+ :::java
ContentItem ci; //the ContentItem
//the URI is available as constant of the ExecutionMetadata class
UriRef contentPartURI = ExecutionMetadata.CHAIN_EXECUTION;
@@ -215,6 +218,7 @@ The following code segments show how to
This code example first gets the ChainExecution, ExecutionPlan and Chain name for the enhanced content item. In a second step metadata of all executed EnhancementEngines are retrieved.
+ :::java
ContentItem ci; //the ContentItem
MGraph em; //the ExecutionMetadata
Modified: incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/index.mdtext
URL: http://svn.apache.org/viewvc/incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/index.mdtext?rev=1244912&r1=1244911&r2=1244912&view=diff
==============================================================================
--- incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/index.mdtext (original)
+++ incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/index.mdtext Thu Feb 16 10:06:16 2012
@@ -1,6 +1,6 @@
Title: Stanbol Enhancer
-The Apache Stanbol Enhancer provides both a RESTful and a Java API that allows caller to Extract features from parsed Content. In more detail the parsed Content is processed by [Enhancement Engines](engines) as defined by the called [Enhancement Chain](chains/enhancementchain.html).
+The Apache Stanbol Enhancer provides both a RESTful and a Java API that allows caller to Extract features from parsed Content. In more detail the parsed Content is processed by [Enhancement Engines](engines) as defined by the called [Enhancement Chain](chains).
## Using the Stanbol Enhancer
@@ -78,8 +78,8 @@ Apache Stanbol comes with a [list of pre
* __ContentItem__: A [content item](contentitem.html) is the unit of content that Stanbol Enhancer can deal with. It gives access to the binary content that was registered, and the graph that represents its metadata (provided by client and/or generated).
* __EnhancementEngine__: The [enhancement engine](engines) provides the interface to internal or external semantic enhancement engines. Typically content items will be processed by several enhancement engines.
-* __EnhancementChain__: A [enhancement chain](chains/enhancementchain.html) represents a user provided configuration that describes how [content item](contentitem.html)s parsed to this chain should be processed by the Stanbol Enhancer. A chain defines list of [enhancement engine](engines/) and their order of execution.
-* __EnhancementJobManager__: The [EnhancementJobManager](enhancementjobmanager.html) performs the execution of the enhancement process as described in the [execution plan](chains/executionplan.html) provided by the [enhancement chain](chains/enhancementchain.html). The enhancement job manager is also responsible for recording the [execution metadata](executionmetadata.html).
+* __EnhancementChain__: A [enhancement chain](chains) represents a user provided configuration that describes how [content item](contentitem.html)s parsed to this chain should be processed by the Stanbol Enhancer. A chain defines list of [enhancement engine](engines/) and their order of execution.
+* __EnhancementJobManager__: The [EnhancementJobManager](enhancementjobmanager.html) performs the execution of the enhancement process as described in the [execution plan](chains/executionplan.html) provided by the [enhancement chain](chains). The enhancement job manager is also responsible for recording the [execution metadata](executionmetadata.html).
* __ChainManager__: The [chain manager](chains/chainmanager.html) allows to lookup all configured enhancement chains. It also provides a getter for the default chain.
* __EnhancementEngineManager__: The [enhancement engine manager](engines/enhancementenginemanager.html) allows to lookup active enhancement engines by their name.
Modified: incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/stanbolenhancementstructure.mdtext
URL: http://svn.apache.org/viewvc/incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/stanbolenhancementstructure.mdtext?rev=1244912&r1=1244911&r2=1244912&view=diff
==============================================================================
--- incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/stanbolenhancementstructure.mdtext (original)
+++ incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/stanbolenhancementstructure.mdtext Thu Feb 16 10:06:16 2012
@@ -62,6 +62,7 @@ A special NOTE to the usage of <{code
The ContentItem <ci> represents a content parsed to the Stanbol Enhancer. It is the central resource used to link all the enhancements created by the EnhancementEngines.
+ :::none
<ci> rdf:type sb:ContentItem
[<ci> sb:embeds-knowledge {knowlegeGraphId}]
[<ci> sb:has-section sb:ContentItem]
@@ -80,6 +81,7 @@ In addition metadata extracted or parsed
This example shows how SIOC (Semantically-Interlinked Online Communities) and RDFa can be used to embed knowledge to tell Stanbol how to process parsed HTML markup.
+ :::html
<body about="http://www.examplenews.com/featuredNews"><table><tr>
<td><!-- The menue: Not to be enhanced --> </td>
<td><span property="sic:content" about="http://www.examplenews.com/story123">
@@ -110,6 +112,7 @@ The concept "Enhancement" defines proper
The following code segments shows the knowledge typically described by using the Enhancement concept
+ :::none
<e> rdf:type sb:Enhancement
<e> dc:creator enhancementEngine^^xsd:anyURI
<e> dc:contributor enhancementEngine^^xsd:anyURI
@@ -147,6 +150,7 @@ Sections below are not yet updated
The concept "Annotation" provides metadata about the extracted feature. This information are important both for the enhancement process and the users of the Stanbol Enhancer.
The following code segment shows the knowledge typically provided by an Annotation <a>. A description of the properties is provided below:
+ :::none
<a> rdf:type sb:Annotation
[<a> rdf:type sb:Enhancement, sb:Occurrence]
<a> sb:extracted-from <ci>
@@ -214,67 +218,72 @@ for details how they are used please see
As example lets assume that the following RDFa annotated content is parsed to the Stanbol Enhancer
- <span typeof="cal:Vevent">
- <h3 property="dc:title"> Stanbol Teleconference </h3>
- <span property="cal:summary>
- <p> Agenda: </p>
- <ul>
- <li> ... </li>
- <ul>
- <p> Participants: </p>
- <ul>
- <li typeof="foaf:Person" property="foaf:name">Rupert Westenthaler</li>
- <li typeof="foaf:Person" property="foaf:name">Olivier Grisel</li>
- <li> ... </li>
- </ul>
- </span>
- </span>
+ :::html
+ <span typeof="cal:Vevent">
+ <h3 property="dc:title"> Stanbol Teleconference </h3>
+ <span property="cal:summary>
+ <p> Agenda: </p>
+ <ul>
+ <li> ... </li>
+ <ul>
+ <p> Participants: </p>
+ <ul>
+ <li typeof="foaf:Person" property="foaf:name">Rupert Westenthaler</li>
+ <li typeof="foaf:Person" property="foaf:name">Olivier Grisel</li>
+ <li> ... </li>
+ </ul>
+ </span>
+ </span>
(1) Suggest the Entities for Rupert and Olivier
(2) Suggest to link Rupert and Olivier as values for "cal:attendee"
Both for Rupert Westenthaler and Olivier Grisel an EntityAnnotation would be present - in that case created by the RDFa extractor, but in principle this could also work if the RDFa markup is missing. In such cases the EntityAnnotations could be created by an NLPEnhancementEngine.
- <a1> rdf:type sb:EntityAnnotation
- <a1> dc:title Rupert Westenthaler
- <a1> sb:entity-type foaf:Person
- <a1> sb:hasOccurrence <o1>
- <a1> sb:hasSuggestion <s1>
-
- <a2> rdf:type sb:EntityAnnotation
- <a2> dc:title Olivier Grisel
- <a1> sb:entity-type foaf:Person
- <a2> sb:hasOccurrence <o2>
- <a2> sb:hasSuggestion <s2>
+ :::none
+ <a1> rdf:type sb:EntityAnnotation
+ <a1> dc:title Rupert Westenthaler
+ <a1> sb:entity-type foaf:Person
+ <a1> sb:hasOccurrence <o1>
+ <a1> sb:hasSuggestion <s1>
+
+ <a2> rdf:type sb:EntityAnnotation
+ <a2> dc:title Olivier Grisel
+ <a1> sb:entity-type foaf:Person
+ <a2> sb:hasOccurrence <o2>
+ <a2> sb:hasSuggestion <s2>
Lets ignore the occurrences - because how to create Occurrences for RDFa markup is a whole different story that needs to be specified - and concentrate on the suggestions.
- <s1> rdf:type sb:Suggestion
- <s1> sb:entity <http://www.example.com/person/Rupert_Westenthaler>
- <s1> sb:entity-type foaf:Person, vCard:vCard, dbpedia-ont:Person
- <s1> sb:confidence 123,456
-
- <s2> rdf:type sb:Suggestion
- <s2> sb:entity <http://www.example.com/person/Olivier_Grisel>
- <s2> sb:entity-type foaf:Person, vCard:vCard, dbpedia-ont:Person
- <s2> sb:confidence 234,567
+ :::none
+ <s1> rdf:type sb:Suggestion
+ <s1> sb:entity <http://www.example.com/person/Rupert_Westenthaler>
+ <s1> sb:entity-type foaf:Person, vCard:vCard, dbpedia-ont:Person
+ <s1> sb:confidence 123,456
+
+ <s2> rdf:type sb:Suggestion
+ <s2> sb:entity <http://www.example.com/person/Olivier_Grisel>
+ <s2> sb:entity-type foaf:Person, vCard:vCard, dbpedia-ont:Person
+ <s2> sb:confidence 234,567
If the suggestion is accepted by the client the RDFa markup could be updated like this
- <li about="http://www.example.com/person/Rupert_Westenthaler"
- typeof="foaf:Person" property="foaf:name">Rupert Westenthaler</li>
- <li about="http://www.example.com/person/Olivier_Grisel"
- typeof="foaf:Person" property="foaf:name">Olivier Grisel</li>
+ :::html
+ <li about="http://www.example.com/person/Rupert_Westenthaler"
+ typeof="foaf:Person" property="foaf:name">Rupert Westenthaler</li>
+ <li about="http://www.example.com/person/Olivier_Grisel"
+ typeof="foaf:Person" property="foaf:name">Olivier Grisel</li>
Now lets have a detailed look at the suggestions to add Rupert and Olivier as a "cal:attendee" to the meeting.
First we need to create an EntityAnnotation for the Meeting that would be created by the RDFa extractor
- <a> rdf:type sb:EntityAnnotation
- <a> dc:title "Stanbol Teleconference"
- <a> sb:entity-type cal:Vevent
- <a> sb:hasOccurrence <o>
- <a> sb:hasSuggestion <s3>
- <a> sb:hasSuggestion <s4>
+ :::none
+ <a> rdf:type sb:EntityAnnotation
+ <a> dc:title "Stanbol Teleconference"
+ <a> sb:entity-type cal:Vevent
+ <a> sb:hasOccurrence <o>
+ <a> sb:hasSuggestion <s3>
+ <a> sb:hasSuggestion <s4>
Again lets skip the occurrence and look at the two suggestions. What I want to do here is to suggest to use the Annotations for Rupert (<a1>) and Olivier (<a2>) as values for the property "cal:attendee".
@@ -282,17 +291,18 @@ It is important to suggest here the anno
The following suggestions also use the sb:field property to tell the user that the suggestions is about values for the "cal:attendee" property.
- <s3> rdf:type sb:Suggestion
- <s3> sb:field cal:attendee
- <s3> sb:entity <a1>
- <s3> sb:entity-type sb:EntityAnnotation
- <s3> sb:confidence 12,34
-
- <s4> rdf:type sb:Suggestion
- <s4> sb:field cal:attendee
- <s4> sb:entity <a2>
- <s4> sb:entity-type sb:EntityAnnotation
- <s4> sb:confidence 12,34
+ :::none
+ <s3> rdf:type sb:Suggestion
+ <s3> sb:field cal:attendee
+ <s3> sb:entity <a1>
+ <s3> sb:entity-type sb:EntityAnnotation
+ <s3> sb:confidence 12,34
+
+ <s4> rdf:type sb:Suggestion
+ <s4> sb:field cal:attendee
+ <s4> sb:entity <a2>
+ <s4> sb:entity-type sb:EntityAnnotation
+ <s4> sb:confidence 12,34
NOTE:
@@ -300,28 +310,30 @@ NOTE:
Here the RDFa markup if the user accepts <s3> and <s4> but not <s1> and <s2>
- <span typeof="cal:Vevent">
- [...]
- <p> Participants: </p>
- <ul property="cal:attendee">
- <li typeof="foaf:Person" property="foaf:name">Rupert Westenthaler</li>
- <li typeof="foaf:Person" property="foaf:name">Olivier Grisel</li>
- <li> ... </li>
- </ul>
- </span>
+ :::html
+ <span typeof="cal:Vevent">
+ [...]
+ <p> Participants: </p>
+ <ul property="cal:attendee">
+ <li typeof="foaf:Person" property="foaf:name">Rupert Westenthaler</li>
+ <li typeof="foaf:Person" property="foaf:name">Olivier Grisel</li>
+ <li> ... </li>
+ </ul>
+ </span>
and finally the RDFa markup if the all suggestions are accepted by the client side
- <span typeof="cal:Vevent">
- [...]
- <p> Participants: </p>
- <ul property="cal:attendee">
- <li about="http://www.example.com/person/Rupert_Westenthaler"
- typeof="foaf:Person" property="foaf:name">Rupert Westenthaler</li>
- <li about="http://www.example.com/person/Olivier_Grisel"
- typeof="foaf:Person" property="foaf:name">Olivier Grisel</li>
- </ul>
- </span>
+ :::html
+ <span typeof="cal:Vevent">
+ [...]
+ <p> Participants: </p>
+ <ul property="cal:attendee">
+ <li about="http://www.example.com/person/Rupert_Westenthaler"
+ typeof="foaf:Person" property="foaf:name">Rupert Westenthaler</li>
+ <li about="http://www.example.com/person/Olivier_Grisel"
+ typeof="foaf:Person" property="foaf:name">Olivier Grisel</li>
+ </ul>
+ </span>
### Occurrences
@@ -335,6 +347,7 @@ Different Occurrence descriptions are ne
Describe the occurrence of a feature within an textual content.
+ :::none
<o> rdf:type sb:TextOccurrence
sb:TextOccurrence rdfs:subClassOf sb:Occurrence
<o> rdf:type sb:Occurrence
@@ -354,6 +367,7 @@ Describe the occurrence of a feature wit
Describes the occurrence of an feature within the metadata of the parsed content. This are extremely useful to link entities for literal values provided by metadata standards such as creator information for Dublin Core, Artist, Album, Label ... information provided by ID3 or Camera Model information as present in EXIF metadata. Also geo-point to City, Region, Country enhancements could be done by using this type of occurrences.
+ :::none
<o> rdf:type sb:MetadataOccurrence
sb:MetadataOccurrence rdfs:subClassOf sb:Occurrence
<o> rdf:type sb:Occurrence
@@ -385,6 +399,7 @@ An User types the text "Next week I will
Lets assume that Paris was detected to describe a location and travel to be a keyword. There are also two known Entities with the name "Paris" and the type Location.
This would result in an enhancement graph as follows
+ :::none
# The content item
<ci> rdf:type sb:ContentItem
@@ -458,6 +473,7 @@ When consuming the following queries wou
Getting all Tags: to get all Keywords/Categories replace sb:Tag with sb:Keyword/sb:Category
+ :::none
PREFIX dc: <http://purl.org/dc/terms/>
PREFIX sb: <http://stanbol.apache.org/ontology/1.0/>
SELECT ?id, ?title, ?type
@@ -469,6 +485,7 @@ Getting all Tags: to get all Keywords/Ca
Getting suggestions for an known Annotation (e.g. urn:annotation1)
+ :::none
PREFIX dc: <http://purl.org/dc/terms/>
PREFIX sb: <http://stanbol.apache.org/ontology/1.0/>
SELECT ?entity, ?title, ?type ?score
@@ -482,6 +499,7 @@ Getting suggestions for an known Annotat
Getting all selected Entities within the Text
+ :::none
PREFIX dc: <http://purl.org/dc/terms/>
PREFIX sb: <http://stanbol.apache.org/ontology/1.0/>
SELECT ?id, ?title, ?start, ?end, ?type
@@ -495,6 +513,7 @@ Getting all selected Entities within the
Getting all Locations and optionally the occurrences within the text
+ :::none
PREFIX dc: <http://purl.org/dc/terms/>
PREFIX sb: <http://stanbol.apache.org/ontology/1.0/>
PREFIX dbpedia-ont: <http://dbpedia.org/ontology/>
@@ -521,6 +540,7 @@ Lets assume that a user parses a content
Further assume that both Richard and Rachel works for the company running the Stanbol Enhancer and there is an EnhancementEngine that knows about Company resource.
This example uses the URI "http://www.company.org/team/Richard_Cypher" and "http://www.company.org/team/Rachel_Brandstone" to identify the two example employees.
+ :::none
#The content item
<ci> rdf:type sb:ContentItem
<ci> dc:creator "Richard Cypher", "Rachel Brandstone"
@@ -574,6 +594,7 @@ This example uses the URI "http://www.co
*NOTE*: One could also create two sb:Annotations for both Richard and Rachel, one Annotation describing the annotated value and a second suggesting the entity for the first, but that seams like an unnecessary complexity as long as there is only one person with this name in the company. Nonetheless this decision needs to be reviewed.
Therefore the code for Richard when using this variant.
+ :::none
#Annotation describing "Richard Cypher" as extracted from the DC description
<a1> rdf:type sb:Enhancement
<a1> rdf:type sb:Annotation
@@ -615,6 +636,7 @@ Getting all Annotations for the dc:creat
Version based on variant 1:
+ :::none
PREFIX dc: <http://purl.org/dc/terms/>
PREFIX sb: <http://stanbol.apache.org/ontology/1.0/>
SELECT ?id, ?title, ?creatorId
@@ -626,6 +648,7 @@ Version based on variant 1:
Version for variant 2:
+ :::none
PREFIX dc: <http://purl.org/dc/terms/>
PREFIX sb: <http://stanbol.apache.org/ontology/1.0/>
SELECT ?id, ?title, ?creatorId
@@ -642,6 +665,7 @@ Getting all Annotations created for DC p
Version based on variant 1:
+ :::none
PREFIX dc: <http://purl.org/dc/terms/>
PREFIX sb: <http://stanbol.apache.org/ontology/1.0/>
SELECT ?id, ?title, ?field, ?entity
@@ -654,6 +678,7 @@ Version based on variant 1:
Version based on variant 2:
+ :::none
PREFIX dc: <http://purl.org/dc/terms/>
PREFIX sb: <http://stanbol.apache.org/ontology/1.0/>
SELECT ?id, ?title, ?field, ?entity