Lucene-based service for the knowledge base used by Platypus
Java Python HTML
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
docker
scripts
src
.gitignore
.travis.yml
LICENSE
README.md
pom.xml

README.md

Platypus Knowledge Base Lucene Service

Build Status

This repository contains a Lucene-based service for the knowledge base used by Platypus.

This knowledge base is currently using Wikidata content.

To see the provided API methods go to http://kb.askplatyp.us/api

Install

This service depends on Java 8 and some maven dependencies. To run it you should have Java 8 and maven installed on your machine then in the root directory of the project run the commands:

mvn compile
mvn exec:java

The service will run and fill its database with the latest Wikidata dumps.

To see the API documentation (based on Swagger) browse the base URI of your installation.

If you want to create a docker image of the service just run:

mvn clean package docker:build

It creates an image called platypus-kb-lucence with the service listening to port 4567.

Configuration

The main configuration file is src/main/resources/config.properties.

The following configuration variables are available:

  • us.askplatyp.kb.lucene.http.uri: the server base URI. By default http://localhost:4567.
  • us.askplatyp.kb.lucene.lucene.directory: the directory where Lucene should store its files. By default the relative directory data.
  • us.askplatyp.kb.lucene.wikidata.directory directory where to store a dumpfiles directory containing downloaded Wikidata dumps. Default value : user.dir configuration variable.