aksw/sante

The Ontology, Dataset and Knowledge Search Engine

@inproceedings{marx/starpath/sante/mtsr/2016,
  author = {Marx, Edgard and H{\"o}ffner, Konrad and Shekarpour, Saeedeh and Ngomo, Axel-Cyrille Ngonga and Lehmann, Jens and Auer, S{\"o}ren},
  booktitle = {Metadata and Semantics Research: 10th International Conference, MTSR 2016, G{\"o}ttingen, Germany, November 22-25, 2016, Proceedings},
  doi = {10.1007/978-3-319-49157-8_22},
  isbn = {978-3-319-49157-8},
  pages = {249--261},
  publisher = {Springer International Publishing},
  title = {Exploring Term Networks for Semantic Search over RDF Knowledge Graphs},
  url = {https://www.researchgate.net/publication/309700280_Exploring_Term_Networks_for_Semantic_Search_over_RDF_Knowledge_Graphs},
  year = 2016
}

SANTé stands for SemANTic Search Engine and is designed to simplify RDF data access and exploration. SANTé covers different aspects of search engines such as indexing, ranking as well as interaction. You can use SANTé via command line or via SANTé Web Interface (smile).

Following we discuss some of the basic functionalities to help you to instantiate your own SANTé instance in few steps.

• Showcases
• SANTé in 5 minutes
• Creating an index
• Running SANTé
• APIs
• Known Issues & Limitations

Showcases

FOAF Ontology: http://foaf.aksw.org

In this showcase we demonstrate SANTé with basic functionalities (search and data browser) using the foaf ontology.

Pokemon dataset: http://pokemon.aksw.org/

In this showcase we demonstrate SANTé with full functionalities (search, APIs, filters and data browser) using the Pokemon dataset.

SANTé in 5 minutes

In this 5 minutes tutorial we will help you to instantiate your first knowledge base search engine over FOAF ontology using KBox https://github.com/AKSW/KBox.

1. Download KBox and instantiate the FOAF knowledge graph.

Download the jar here https://github.com/AKSW/KBox/releases and run the following command:

java -jar kbox-vXXXX.jar -server -kb "http://xmlns.com/foaf/0.1,https://www.w3.org/2000/01/rdf-schema,http://www.w3.org/2002/07/owl,http://www.w3.org/1999/02/22-rdf-syntax-ns,http://purl.org/dc/elements/1.1/,http://purl.org/dc/terms/,http://purl.org/dc/dcam/,http://purl.org/dc/dcmitype/" -install
Loading Model...
Publishing service on http://localhost:8080/kbox/query
Service up and running ;-) ...

You can now access and query your knowledge graph at http://localhost:8080. Notice that in the example above we also include RDFS, RDF and OWL ontologies, that's because we need their information for correctly instantiate FOAF ontology. In case the SPARQL endpoint does not contain all necessary information, SANTé will not be capable of retrieving or searching for it and will display the information as Unavailable.

2. Download one of the available SANTé runnable jar files.

Download the jar here https://github.com/AKSW/sante/releases

3. Create the index.

Assuming that you successfully performed step 1,

java -jar sante-vXXX.jar index -endpoint http://localhost:8080/kbox/query -path \foaf_kg

4. Download one of the available smile WAR files (same version as the step 2).

Download the WAR here https://github.com/AKSW/sante/releases

5. Instantiate smile

java -jar sante-vXXX.jar server -war sante-vXXX.war -path \foaf_kg -port 9090
[main] INFO org.eclipse.jetty.util.log - Logging initialized @150ms to org.eclipse.jetty.util.log.Slf4jLog
[main] INFO org.eclipse.jetty.server.Server - jetty-9.4.z-SNAPSHOT, build timestamp: 2017-11-21T22:27:37+01:00, git hash: 82b8fb23f757335bb3329d540ce37a2a2615f0a8
[main] INFO org.eclipse.jetty.server.session - DefaultSessionIdManager workerName=node0
[main] INFO org.eclipse.jetty.server.session - No SessionScavenger set, using defaults
[main] INFO org.eclipse.jetty.server.session - Scavenging every 660000ms
May 09, 2020 9:25:16 AM org.apache.myfaces.config.DefaultFacesConfigurationProvider getStandardFacesConfig
...

If you correctly executed all the steps above, now you should be able to access SANTé at http://localhost:9090.

Creating an index

Creating an index is pretty much straightforward, you can do it via code or command line. However, SANté uses triple stores to feed data to the index. That's useful for performing reasoning over the target knowledge graph. To create the index, you will first need to index your data in a triple store of your preference.

1. Download one of the availabes SANTé runnable jar file.

2. Execute the following command:

java -jar sante.jar index -endpoint <endpoint> -path <path>

where:

<endpoint> stands for the sparql endpoint.
 
<path>     stands for the target index directory.

Running SANTé

1. Download one of the availabes SANTé runnable jar file.

2. Download the available SANTé WAR file.

3. Execute the following command:

java -jar sante.jar server -war <smile.war> -path <path> [-port <port>]

where:

<war>  stands for smile war file.

<path> stands for the target index directory.

<port> stands for the server publishing port (default 8080).

Creating SANTé runnable jar file

Run mvn package at the sante.main base directory:

...\sante.main\mvn package
...
[INFO] org/apache/lucene/analysis/ already added, skipping
[INFO] org/apache/lucene/analysis/standard/ already added, skipping
[INFO] META-INF/LICENSE.txt already added, skipping
[INFO] META-INF/NOTICE.txt already added, skipping
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time:  43.329 s
[INFO] Finished at: 2020-05-07T23:31:50+02:00
[INFO] ------------------------------------------------------------------------

The runnable jar file will be generated at sante.main/target/sante.main-0.0.1-SNAPSHOT-jar-with-dependencies.jar

Creating SANTé smile WAR file

Run mvn war:war at the sante.smile base directory:

...\sante.smile\mvn war:war
...
[INFO] Packaging webapp
[INFO] Assembling webapp [sante.smile] in [...\sante.smile\target\sante.smile-0.0.1-SNAPSHOT]
[INFO] Processing war project
[INFO] Copying webapp resources [...\sante.smile\src\main\webapp]
[INFO] Webapp assembled in [356 msecs]
[INFO] Building war: ...\sante.smile\target\sante.smile-0.0.1-SNAPSHOT.war
[INFO] WEB-INF\web.xml already added, skipping
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time:  5.772 s
[INFO] Finished at: 2020-05-07T23:42:36+02:00
[INFO] ------------------------------------------------------------------------

The smile WAR file will be generated at sante.smile/target/sante.smile-0.0.1-SNAPSHOT.war

APIs

SANTé implements the following APIs:

API/search

Example 1: search for all occurrences of the word pokemon:

http://pokemon.aksw.org/API/search?q=%22pokemon%22

API/suggest

Example 1: suggest using the word pokemon:

http://pokemon.aksw.org/API/suggest?q=%22pokemon%22

API/dbpedialookup

Example 1: looking for all occurrences of the word pokemon:

http://pokemon.aksw.org/API/dbpedialookup?MaxHits=5&QueryString=pokemon

API/reconcile

Example 1: looking for all occurrences of the word pokemon:

http://pokemon.aksw.org/API/reconcile?search={%20%22q%22:%20{%20%22query%22:%20%22pokemon%22%20}}

Known Issues

Blank Nodes

There many issues regarding RDF blank nodes such as no uniformity or standard way of tackling them. To avoid custom implementations, we have made a design decision not to support blank nodes. If your dataset happens to have blank nodes, you should perform a canonization using the query below (customizing it according to your needs). This query will assign an URI with the prefix blanknode:// to every blank node of your dataset.

DELETE {?s ?p ?o}
INSERT {?s ?p ?cO}
WHERE
{
     ?s ?p ?o.
     FILTER(isblank(?o))
     bind (iri(concat("blanknode://",SHA1(STR(iri(?o))))) as ?cO)
};

DELETE {?s ?p ?o}
INSERT {?cS ?p ?o}
WHERE
{
    ?s ?p ?o.
    FILTER(isblank(?s))
	bind (iri(concat("blanknode://",SHA1(STR(iri(?s))))) as ?cS)
};

sante's Issues

Move Index configuration to application properties

Move parameters from index configuration file to spring boot application properties.

Dockerize sante.main

This task consists in dockerizing the project sante.main.

• sante.main should have a docker file that pull the project, compile and run sante.main
• the command should reflect the commands in sante.main command line: i.e. docker sante/main -index -endpoint http://../sparql
• the target directory for the index should be fixed to a local directory i.e. $index/

v0.0.2-SNAPSHOT not working while starting the SANTe

Error message on terminal :

Commands in use :

1. Creating Index

java -jar sante.main-v0.0.2-SNAPSHOT.jar index -endpoint http://localhost:8080/kbox/query -path \foaf_kg

2. Instantiating Smile

java -jar sante.main-v0.0.2-SNAPSHOT.jar server -war sante.smile-v0.0.2-SNAPSHOT.war -path \foaf_kg -port 9090

Property not being suggested

The property http://xmlns.com/foaf/0.1/depiction is not being suggested with 'depiction' keyword in filter nor as a single property in autosuggest using Pokémon dataset http://pokemon.aksw.org .

dockerize sante.smile

This ticket consists of dockerizing sante.smile project.

GraphQL API implementation

This task consists in creating the GraphQL API implementation.

Dockerize project sante.api

This task consists in dockerizing the project sante.api.

• the docker should pull the project sante.api from sante repository and compile it
• the image should run by executing the war inside the image when running it: i.e. docker run sante/api

GraphQL API spec

This task consists in creating the GraphQL API specification.

Write the docs

This ticket consists in writing the docs for SANTé:

For reference, use: https://aksw.github.io/sante-api-docs

The documentation should be implemented at the repository: https://github.com/AKSW/sante-api-docs

The documentation should contain the following menu:

• Introduction
• Compiling
• Creating an index
  • Docker
  • Jar
• Running
  • sante.main
    • Docker
    • Jar
  • smile.smile
    • Docker
    • Jar
  • sante.api
    • Docker
    • Jar
• APIs
  • DBpedia Lookup
  • Suggestion
  • Search
  • Reconcile
• Known Issues & Limitations