021292239aa57ca56a7c196e8ae8f655da1359bb - KorAP/Koral

commit	021292239aa57ca56a7c196e8ae8f655da1359bb	[log] [tgz]
author	Bodmo <Bodmer@ids-mannheim.de>	Mon May 27 14:14:33 2024 +0200
committer	Bodmo <Bodmer@ids-mannheim.de>	Mon May 27 14:14:33 2024 +0200
tree	7ce4ced624de8dd12463e1cf4d8d78ccfff3ab1b
parent	2f5e9e138261972f2aa74a442d30b86c21071267 [diff]

tree: 7ce4ced624de8dd12463e1cf4d8d78ccfff3ab1b

README.md

Koral

Koral is a translator tool for converting different corpus query languages to KoralQuery, a JSON-LD-based protocol for the common representation of linguistic queries. KoralQuery specifications are described extensively in Bingel (2015). This work has been carried out within the KorAP project.

Koral supports the following corpus query languages (QLs):

Cosmas-II QL
ANNIS QL
Poliqarp QL (extended by numerous operators to "PoliqarpPlus" QL)
CQL (for basic search as described in the CLARIN FCS 1.0 Specification )
CQP
FCSQL (based on CQP, for advanced search as described in the CLARIN FCS 2.0 specification draft)

Usage Example

You can use the main class QuerySerializer to translate and serialize queries. Valid QL identifiers are cosmas2, annis, poliqarp, poliqarpplus, cql, cqp, and fcsql.

import de.ids_mannheim.korap.query.serialize.QuerySerialzer;

QuerySerializer qs = new QuerySerializer();
String query = "contains(<s>,[orth=zu][pos=ADJA])";
qs.setQuery(query, "poliqarpplus");
System.out.println(qs.toJSON());

This will print out the following JSON-LD string for the Koralized query. The query asks for a sentence element (<s>) contained in a sequence of the surface form zu and a token with the part-of-speech tag ADJA. In the KoralQuery string, a containment relation is defined over two operands, an s span and a sequence of two tokens.

{
  "@context": "http://korap.ids-mannheim.de/ns/KoralQuery/v0.2/context.jsonld",
  "query": {
    "@type": "koral:group",
    "operation": "operation:position",
    "frames": [
      "frames:isAround"
    ],
    "operands": [
      {
        "@type": "koral:span",
        "key": "s"
      },
      {
        "@type": "koral:group",
        "operation": "operation:sequence",
        "operands": [
          {
            "@type": "koral:token",
            "wrap": {
              "@type": "koral:term",
              "layer": "orth",
              "key": "zu",
              "match": "match:eq"
            }
          },
          {
            "@type": "koral:token",
            "wrap": {
              "@type": "koral:term",
              "layer": "pos",
              "key": "ADJA",
              "match": "match:eq"
            }
          }
        ]
      }
    ]
  }
}

Motivation

Koral allows designing and implementating corpus query systems independent of any specific query languages. The systems only need to have Koral translate a query to a KoralQuery (see usage) and feed the translated query to their search engine. Several query languages can be supported without further adjustments to the search engine.

Koral and KoralQuery have been designed and developed within the KorAP Project, and are used in KorAP to translate queries to a common format before sending them to its search engine.

Setup

Setup is straightforward (Maven3 required):

git clone https://github.com/korap/Koral [install-dir]
cd [install-dir]
mvn test -Dhttps.protocols=TLSv1.2
mvn package

There is also a command line version. After setup, simply run

java -jar target/Koral-0.2.jar [query] [queryLanguage]

Build a Koral library and install it in your local Maven repository (needed for Kustvakt)

mvn install -Dhttps.protocols=TLSv1.2

To update an existing installation, pull the latest version at [install-dir]

git pull origin master

Afterwards, rerun the test suite and package or install the library.

Prerequisites

Java 11 (OpenJDK or Oracle JDK with JCE)
Git
At least Maven 3.2.1
Further dependencies are resolved by Maven.

Publications

J. Bingel, "Instantiation and implementation of a corpus query lingua franca," M.S. thesis, University of Heidelberg, Heidelberg, 2015.

J. Bingel and N. Diewald, "KoralQuery – a General Corpus Query Protocol," in Proceedings of the Workshop on Innovative Corpus Query and Visualization Tools at NODALIDA 2015, Vilnius, 2015, pp. 1-5.

Authorship

Koral and KoralQuery were developed by Joachim Bingel, Nils Diewald, Michael Hanl, Eliza Margaretha, and Franck Bodmer at the Leibniz Institute for the German Language (IDS), member of the Leibniz Association.

The CQP implementation was authored by Elena Irimia.

The ANTLR grammars for parsing ANNIS QL and COSMAS II QL were developed by Thomas Krause (HU Berlin) and Franck Bodmer (IDS Mannheim), respectively. Minor adaptations of those grammars were implemented by the Koral authors.

The authors wish to thank Piotr Bański, Elena Frick and Carsten Schnober for their valuable input.

License

Koral is published under the BSD-2 License. See also the attached LICENSE.

The ANNIS grammar is licensed under the Apache License 2.0.