Author: fchrist
Date: Tue Feb 14 09:31:13 2012
New Revision: 1243845
URL: http://svn.apache.org/viewvc?rev=1243845&view=rev
Log:
Enhancer review, fixed some typos and formatting
Modified:
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/index.mdtext
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=1243845&r1=1243844&r2=1243845&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
Tue Feb 14 09:31:13 2012
@@ -13,39 +13,41 @@ The list of mimetypes accepted as inputs
Apache Stanbol comes with a [list of predefined enhancement
engines](engines/list.html). These engines are supported by the Apache Stanbol
community. If you would like to implement your own enhancement engine, you
should go on reading this documentation.
-
## Main Interfaces and Utilities
-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). The __[Enhancement Engine](engines/)__ provides the
interface to internal or external semantic enhancement engines. There will
usually be several of those, that the EnhancementJobManager uses to enhance
content items. The __Enhancement Job Manager__ accepts requests for enhancing
ContentItems, and processes them either synchronously or asynchronously (as
decided by the enhancement engines or by configuration). The __Enhancement
Engine Helper__ provides the classes for the resulting enhancement structure
according to the defined __Enhancement Structure__.
+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). The [enhancement engine](engines/) provides the interface to
internal or external semantic enhancement engines. There will usually be
several of those, that the EnhancementJobManager uses to enhance content items.
The [enhancement job manager](enhancementjobmanager.html) accepts requests for
enhancing [content items](contentitem.html), and processes them either
synchronously or asynchronously (as decided by the enhancement engines or by
configuration). The enhancement engine helper provides the classes for the
resulting enhancement structure according to the defined enhancement structure.
## Enhancement Structure
-The enhancement structure for Apache Stanbol is been described
[here](http://wiki.iks-project.eu/index.php/EnhancementStructure) in full. It
defines the types and properties used for the resulting metadata graph of
Apache Stanbol. _Note: There is a proposal and ongoing discussion to update
this structure in the future._ Every __Enhancement__ type is a description
which contains the following important properties:
+The enhancement structure for Apache Stanbol is been described
[here](http://wiki.iks-project.eu/index.php/EnhancementStructure) in full. It
defines the types and properties used for the resulting metadata graph of
Apache Stanbol.
+
+_Note: There is a proposal and ongoing discussion to update this structure in
the future._
+
+Each enhancement type description which contains the following important
properties:
* creator: the specific enhancement engine creating this enhancement
* creation time: the local system time, when the annotation was created
-* extracted-from: the content item for the enhancement. This links to the ID
of the content item as assigned by Stanbol.
+* extracted-from: the content item for the enhancement. This links to the ID
of the content item as assigned by Apache Stanbol.
* type: the type of the enhancement (e.g. Location, Person, Location, Concept
...).
* confidence: The level of confidence in the range from 0 to 1
-A __Text Annotation__ type provides metadata for the selected text. This is
intended to be used in addition to the enhancement type if an enhancement is
based on a part of the content.
+A text annotation type provides metadata for the selected text. This is
intended to be used in addition to the enhancement type if an enhancement is
based on a part of the content.
* start: the character position of the start of the selection. If start is not
defined it is assumed, that the selection starts at the beginning of the
document
* end: the character position of the end of the selection. If end is not
defined it is assumed, that the selection ends at the end of the document.
* selected-text: The text selected by the enhancement. (optional).
* selection-context: The context of the selected text. This adds the
possibility to specify the context used to extract entities such as persons,
organizations, locations ... from natural language documents.
-The __Entity Annotation__ refer to named entities which have been recognized
within the content. This type is intended to be used together with the FISE
enhancement type.
+The entity annotation type refers to named entities which have been recognized
within the content. This type is intended to be used together with the FISE
enhancement type.
* entity-reference: This refers to the URI identifying the Entity
* entity-label: The label(s) of the referred entity
* entity-type: This property can be used to specify the type of the entity
(optional)
* The occurrences of the entity within the content (the exact positions within
the text where this entity is referred) are determined by outgoing dc:relation
links.
-
## Response in RDF
-Apache Stanbol Enhancer is able to serialize the response in the following RDF
formats:
+The Apache Stanbol enhancer is able to serialize the response in the following
RDF formats:
application/json (JSON-LD)
application/rdf+xml (RDF/XML)
@@ -57,4 +59,4 @@ By default the URI of the content item b
curl -X POST -H "Accept: text/turtle" -H "Content-type: text/plain" \
--data "John Smith was born in London." \
- "http://localhost:8080/engines?uri=urn:fise-example-content-item";
\ No newline at end of file
+ "http://localhost:8080/engines?uri=urn:fise-example-content-item";
