Author: rwesten
Date: Fri Feb 17 11:17:04 2012
New Revision: 1245395
URL: http://svn.apache.org/viewvc?rev=1245395&view=rev
Log:
minor corrections
Modified:
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/enhancerrest.mdtext
Modified:
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/enhancerrest.mdtext
URL:
http://svn.apache.org/viewvc/incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/enhancerrest.mdtext?rev=1245395&r1=1245394&r2=1245395&view=diff
==============================================================================
---
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/enhancerrest.mdtext
(original)
+++
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/enhancerrest.mdtext
Fri Feb 17 11:17:04 2012
@@ -1,4 +1,4 @@
-title: Stanbol Enhancer RESTful API
+title: Stanbol Enhancer RESTful Services
<p>The RESTful service endpoint provided by the Stanbol Enhancer is a
stateless interface that allows the caller to submit content and get the
resulting enhancements formatted as RDF at once without storing anything on the
server-side. More advanced options also allow to parse pre-existing metadata,
parse and request alternate content versions and additional metadata created by
the Enhancer or specific Enhancement Engines.</p>
@@ -9,7 +9,7 @@ The here described RESTful interface is
* __'/enhancer/chain/{chain-name}'__: The Stanbol Enhancer supports the
configuration of multiple [Enhancement Chains](chains). Users can lookup active
chains by requests to the 'enhancer/chain' endpoint.
* __'/engines':__ Same as '/enhancer' this ensures backward compatibility to
older Stanbol versions.
-## Enhancement Request
+## Basic Enhancement Service
This sections describes how to parse Content to the Stanbol Enhancer that gets
than analyzed. Results are sent back in the form of a serialized RDF graph.
@@ -31,7 +31,7 @@ Stanbol enhancer is able to serialize th
text/turtle (Turtle)
text/rdf+nt (N-TRIPLES)
-### Additional supported QueryParameters:
+### Additional Parameters:
* __uri={content-item-uri}:__ 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 [ContentItem](contentitem.html) to be used in the enhancements RDF graph.
* __executionmetadata=true/false:__ Allows the include of [execution
metadata](executionmetadata.html) in the enhancement metadata of the response.
Such data include also the [execution plan](chains/executionplan.html) used to
enhance the parsed content. This information is typically only useful to
clients that want to know how the parsed content was processed by the enhancer.
NOTE that the execution metadata can also be requested by using the multi-part
content item API described below.
@@ -47,9 +47,7 @@ In addition this request is directed to
## Multi-part ContentItem support
-The multi-part <code>ContentItem</code> extensions to the RESTful API
(introduced by
[STANBOL-481](https://issues.apache.org/jira/browse/STANBOL-481)) are
considered an advanced usage of the Stanbol Enhancer.
-
-Users will want to use this extensions if they need to:
+The multi-part <code>ContentItem</code> extensions to the basic RESTful
services provided by the Stanbol Enhancer. It was introduced (by
[STANBOL-481](https://issues.apache.org/jira/browse/STANBOL-481)) to allow
advanced usage scenarios. Users will want to use this extensions if they need
to:
* parse multiple versions of the content: Most CMS already do have support for
converting content to plain text. This API allows to parse both the original
AND multiple transcoded versions of the content to the Enhancer.
* parse pre-existing metadata: Typically CMS do have already some metadata
about content parsed to the Stanbol Enhancer (e.g. User provided Tags,
Categories â¦). The multi-part extensions do allow to parse such data in
addition to the content.
