You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@stanbol.apache.org by ag...@apache.org on 2011/06/30 11:11:05 UTC
svn commit: r1141454 - in
/incubator/stanbol/site/trunk/content/stanbol/docs/trunk: engines.md
enhancer.md features.md index.md services.md
Author: agruber
Date: Thu Jun 30 09:11:04 2011
New Revision: 1141454
URL: http://svn.apache.org/viewvc?rev=1141454&view=rev
Log:
Initial documentation, work in progress
Added:
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/engines.md
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer.md
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/features.md
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/index.md
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/services.md
Added: incubator/stanbol/site/trunk/content/stanbol/docs/trunk/engines.md
URL: http://svn.apache.org/viewvc/incubator/stanbol/site/trunk/content/stanbol/docs/trunk/engines.md?rev=1141454&view=auto
==============================================================================
--- incubator/stanbol/site/trunk/content/stanbol/docs/trunk/engines.md (added)
+++ incubator/stanbol/site/trunk/content/stanbol/docs/trunk/engines.md Thu Jun 30 09:11:04 2011
@@ -0,0 +1,48 @@
+_[Back to index](index.html)_
+
+# Enhancement Engines and their main features
+
+## Preprocessing
+
+- __Language Identification Engine__
+ - langage dedection for textual content
+
+
+- __Metaxa Engine__
+ - text extraction from various documents
+ - extraction of metadata from documents
+
+## Natural Language Processing
+
+- __Named Entity Extraction Enhancement Engine__
+ - NLP processing
+ - dedect occurences of persons, places and organizations, mandatory for every enhancement.
+
+
+## Linking Suggestions
+
+- __Named Entity Tagging Engine__
+ - suggest links to several Linked Data Sources (e.g. dbpedia)
+
+- __Location Enhancement Engine__
+ - suggests links to geonames.org
+
+- __OpenCalais Enhancement Engine__
+ - integrates service from Open Calais. (Note: You need to provide a key in order to use this engine)
+
+- __Zemanta Enhancement Engine__
+ - integrates the Zemanta services. (Note: You need to provide a key in order to use this engine)
+
+
+
+## Postprocessing / Other
+
+- __CachingDereferencerEngine__
+ - retrieves additional content for presenting the enhancement results.
+
+- __Refactor Engine__
+ - transforms enhancements according to a target ontology, requires KRES launcher.
+
+
+---
+_[Back to index](index.html)_
Added: incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer.md
URL: http://svn.apache.org/viewvc/incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer.md?rev=1141454&view=auto
==============================================================================
--- incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer.md (added)
+++ incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer.md Thu Jun 30 09:11:04 2011
@@ -0,0 +1,62 @@
+_[Back to index](index.html)_
+
+# Enhancer
+
+This stateless interface allows the caller to submit content to the Apache Stanbol enhancer engines and get the resulting enhancements formatted as RDF at once without storing anything on the server-side.
+
+The content to analyze should be sent in a POST request with the mimetype specified in the Content-type header. The response will hold the RDF enhancement serialized in the format specified in the Accept header:
+
+ curl -X POST -H "Accept: text/turtle" -H "Content-type: text/plain" \
+ --data "John Smith was born in London." http://localhost:8080/engines
+
+The list of mimetypes accepted as inputs depends on the deployed engines. By default only text/plain content will be analyzed. By using the Metaxa En
+
+## Main Interfaces and Utilities
+
+A __Content Item__ 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__ 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__.
+
+## Enhancement Structure
+
+The enhancement structure for Apache Stanbol is been described in full [here]
+The enhancement structure defines the types and properties used for the resulting metadata graph of Apache Stanbol. Every __Enhancement__ type is a description which contains the following mandatory 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.
+* 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.
+
+* 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.
+
+* 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:
+
+ application/json (JSON-LD)
+ application/rdf+xml (RDF/XML)
+ application/rdf+json (RDF/JSON)
+ text/turtle (Turtle)
+ text/rdf+nt (N-TRIPLES)
+
+By default the URI of the content item being enhanced is a local, non de-referencable URI automatically built out of a hash digest of the binary content. Sometimes it might be helpful to provide the URI of the content-item to be used in the enhancements RDF graph. This can be achieved by passing a URI request parameter as follows:
+
+ 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"
+
+____
+_[Back to index](index.html)_
\ No newline at end of file
Added: incubator/stanbol/site/trunk/content/stanbol/docs/trunk/features.md
URL: http://svn.apache.org/viewvc/incubator/stanbol/site/trunk/content/stanbol/docs/trunk/features.md?rev=1141454&view=auto
==============================================================================
--- incubator/stanbol/site/trunk/content/stanbol/docs/trunk/features.md (added)
+++ incubator/stanbol/site/trunk/content/stanbol/docs/trunk/features.md Thu Jun 30 09:11:04 2011
@@ -0,0 +1,20 @@
+_[Back to index](index.html)_
+
+# Apache Stanbol features
+
+* NLP and Named Entity Recognition via [Apache OpenNLP](http://incubator.apache.org/opennlp/)
+* Enhancement engines linking to open data such as dbpedia, geonames, dplb.
+* Enhancement engines integrating external services such as zemanta and opencalais.
+* Local Indexes of Linked open Data
+* RDF management via [Apache Clerezza](http://incubator.apache.org/clerezza/)
+* Various enhancement output serialisations (RDF/XML, JSON-LD, RDF/XML, RDF/JSON, Turtle, N-TRIPLES)
+* Language Detection for European Languages
+* Extracting embedded metadata and textual content via [Aperture](http://aperture.sourceforge.net/)
+
+## Upcoming features whishlist
+
+* Multilingual support
+
+---
+
+_[Back to index](index.html)_
Added: incubator/stanbol/site/trunk/content/stanbol/docs/trunk/index.md
URL: http://svn.apache.org/viewvc/incubator/stanbol/site/trunk/content/stanbol/docs/trunk/index.md?rev=1141454&view=auto
==============================================================================
--- incubator/stanbol/site/trunk/content/stanbol/docs/trunk/index.md (added)
+++ incubator/stanbol/site/trunk/content/stanbol/docs/trunk/index.md Thu Jun 30 09:11:04 2011
@@ -0,0 +1,119 @@
+# Apache Stanbol - services for semantic content management
+
+---
+
+[Apache Stanbol][stan-home] is an open source modular software stack and reusable set of components for semantic content management.
+
+Apache Stanbol components are meant to be accessed over RESTful interfaces to provide semantic services for content management. The current code is written in Java and based on the OSGi modularization framework.
+
+Applications include extending existing content management systems with (internal or external) semantic services, and creating new types of content management systems with semantics at their core. Its main features will include:
+
+- Persistence: services that store (or cache) semantic information and make it searchable
+- Lifting/Enhancement: services that add semantic information to ânon-semanticâ pieces of content
+- Knowledge models and reasoning: services that enhance the semantic information
+- Interaction: intelligent user interface management and generation
+
+Apache Stanbol project was initiated and is part-funded by the European R&D project [IKS - Interactive Knowledge Stack for small to medium CMS providers][iks].
+
+Online demos of Apache Stanbol are available at
+
+* [http://dev.iks-project.eu:8080/](http://dev.iks-project.eu:8080/)
+* [http://stanbol.demo.nuxeo.com/](http://stanbol.demo.nuxeo.com/)
+
+
+## Build, install and run Apache Stanbol
+
+As there is no official release of [Apache Stanbol][stan-home] so far, one needs to build the software from source.
+
+
+### Installation
+
+1. To build Stanbol from source you need Java 6 and maven 2.2.1 + (version as defined in the pom). You probably need also:
+
+ <code>$ export MAVEN_OPTS="-Xmx512M -XX:MaxPermSize=128M </code>
+
+
+2. Fetch the sources from the Apache code repository
+
+ <code>$ svn co https://svn.apache.org/repos/asf/incubator/stanbol/ stanbol</code>
+
+3. From the source directory run:
+
+ <code>$ mvn clean install</code>
+
+ _Updating sources_: From your Stanbol root directory call <code>$ mvn clean</code>, then <code>% svn update</code> and build a new version with <code>$ mvn clean install</code>.
+
+
+### Launch the Server
+
+Several launchers are available under the <code>launchers/</code> directory:
+
+* The __"stable launcher"__ provides you with the most stable components only,
+* the __"full launcher"__ contains all major components available,
+* the __"stateless launcher"__ lets you work with Apache Stanbol components in offline mode and
+* the __"kres launcher"__ activates the rules machinery only.
+
+You can launch the Server via e.g:
+
+<code>$ java -Xmx1g -jar full/target/org.apache.stanbol.launchers.full-0.9-SNAPSHOT.jar</code>
+
+ Your instance is then available on <http://localhost:8080>. You may change the default port number by passing a `-p 9090` options to the commandline launcher. Upon first startup, a folder named `sling/` is created in the current folder. This folder will hold the files for any database used by Stanbol, deployment configuration and logs.
+
+
+### HTTP entry points
+
+The web interface of your Apache Stanbol installation provides information for the main HTTP entry points. Each resource comes with a web view that documents the matching RESTful API for applications. Depending on which launcher you use, you will get a different set of [services](services.html).
+
+
+## Usage Scenarios for Apache Stanbol
+
+* [Content Enhancement](contentenhancement.html)
+
+ Analyze textual content, enhance with with named entities (person, place, organization), suggest links to open data sources.
+
+* Working with "local" Entities
+
+ Use locally defined entities (e.g. thesaurus concepts) from an organization's context.
+
+* Semantic Search in Portals
+
+ Store/index enhancements and content items. For a portal this would facilitate semantic search applications.
+
+* Refactoring Enhancements for SEO
+
+ Refactor the enhancement result, its property names and ontology types according your target ontology.
+
+* Transforming CMS repository structures into ontologies
+ Provide repository structures as thesaurus or domain ontology, e.g. categories.
+
+
+## Technical Documentation
+
+A detailed technical documentation of its components can be found here:
+
+* [Enhancer](enhancer.html)
+* [Enhancement Engines](engines.html)
+* Entityhub
+* Contenthub
+* CMS Adapter
+* Ontology Manager
+* Reasoners
+* Reengineer
+* Rules
+* Benchmark
+
+
+## Follow and support Apache Stanbol
+
+- Subscribe to the Apache Stanbol Developers mailinglist by sending an email to <code>stanbol-dev-subscribe AT incubator.apache.org</code>.
+
+- Please report bugs on the [Apache issue tracker](https://issues.apache.org/jira/browse/STANBOL)
+
+[iks]: http://www.iks-project.eu/
+[stan-home]: http://incubator.apache.org/stanbol/
+[stan-admin]: http://localhost:8080/system/console/
+[stan-engines]: http://localhost:8080/engines
+[stan-contenthub]: http://localhost:8080/contenthub
+
+
+
Added: incubator/stanbol/site/trunk/content/stanbol/docs/trunk/services.md
URL: http://svn.apache.org/viewvc/incubator/stanbol/site/trunk/content/stanbol/docs/trunk/services.md?rev=1141454&view=auto
==============================================================================
--- incubator/stanbol/site/trunk/content/stanbol/docs/trunk/services.md (added)
+++ incubator/stanbol/site/trunk/content/stanbol/docs/trunk/services.md Thu Jun 30 09:11:04 2011
@@ -0,0 +1,35 @@
+# HTTP entry points for Apache Stanbol services
+
+The web interface of your Apache Stanbol installation provides information for the main HTTP entry points. Each resource comes with a web view that documents the matching RESTful API for applications. Depending on which launcher you use, you will get a different set of services.
+
+- [/engines][stan-engines] (stable)
+
+ This is a stateless interface to allow clients to submit content to be analyzed by the Enhancement Engines and get the resulting RDF enhancements at once without storing anything on the server-side.
+
+- [/entityhub](http://localhost:8080/entityhub) (stable)
+
+ The Entityhub provides two main services: The entity network manages (external) referenced sites and lets one consume entity information, the Entityhub supports managing and using local entities.
+
+
+- [/system/console][stan-admin] (stable)
+
+ This is the OSGi administration console (for administrators and developers). The initial username / password is set to admin / admin. Use the console to add new bundles and activate, de-activate and configure components. The console can also be used to perform hot-(re)deployment of any OSGi bundles. For instance to re-deploy a new version of this web interface, go to the <code>$STANBOL_HOME/enhancer/jersey</code> source folder and run the following command:
+
+ <code>$ mvn install -o -DskipTests -PinstallBundle \
+ -Dsling.url=http://localhost:8080/system/console</code>
+
+
+- [/sparql](http://localhost:8080/sparql) (full)
+
+ This is the SPARQL endpoint for the Stanbol store. SPARQL is the standard query language the most commonly used to provide interactive access to semantic knowledge bases.
+
+- [/contenthub](http://localhost:8080/contenthub) (full)
+
+ This is a stateful interface to submit content to analyze and store the results on the server. It is then possible to browse the resulting enhanced content items. The longer-term goal of this endpoint is to implement faceted semantic search of the enhanced content items. (Note: Up to now, this endpoint is a proof of concept / experimental feature. It does not actually store the content on the disk, just in memory.)
+
+- [/ontonet](http://dev.iks-project.eu:8080/ontonet) (full)
+
+- [/factstore](http://dev.iks-project.eu:8080/factstore) (full)
+
+-
+