novetta/clavin-rest repository overview

⁠CLAVIN-Rest Docker Image Introduction

CLAVIN-Rest is a containerized Spring Boot microservice wrapper for CLAVIN⁠. CLAVIN (Cartographic Location And Vicinity INdexer) is an open source software package for document geoparsing and georesolution that employs context-based geographic entity resolution. It combines a variety of open source tools with natural language processing techniques to extract location names from unstructured text documents and resolve them against gazetteer records. Importantly, CLAVIN does not simply "look up" location names; rather, it uses intelligent heuristics-based combinatorial optimization in an attempt to identify precisely which "Springfield" (for example) was intended by the author, based on the context of the document. CLAVIN also employs fuzzy search to handle incorrectly-spelled location names, and it recognizes alternative names (e.g., "Ivory Coast" and "Côte d'Ivoire") as referring to the same geographic entity. By enriching text documents with structured geo data, CLAVIN enables hierarchical geospatial search and advanced geospatial analytics on unstructured data.

The latest release contains CLAVIN 3.0.0, which uses Apache OpenNLP 1.9.2, and the GeoNames gazetteer from November 6th, 2020. Engage with us on GitHub at https://github.com/Novetta/CLAVIN-rest⁠. CLAVIN-Rest is licensed under the Apache 2.0 License⁠.

⁠Geotagging an article

The CLAVIN-Rest microservice provides two REST endpoints. Let's assume for a moment that you have a document entitled 'someDocument.txt' with some unstructured text that contains place names. After pulling and running the CLAVIN-Rest Docker image, you can execute the following curl command to retrieve all relevant geonames data for each location:

curl -s --data @someDocument.txt --header "Content-Type: text/plain" http://localhost:9090/api/v1/geotag

Run the following curl command to retrieve a minimized geonames dataset for each location:

curl -s --data @someDocument.txt --header "Content-Type: text/plain" http://localhost:9090/api/v1/geotagmin