02203f1cc8f199a3d687c30b926cdeec9d4308cb - KorAP/Krawfish-prototype

commit	02203f1cc8f199a3d687c30b926cdeec9d4308cb	[log] [tgz]
author	Akron <nils@diewald-online.de>	Sat Dec 09 13:55:34 2017 +0100
committer	Akron <nils@diewald-online.de>	Sat Dec 09 13:55:34 2017 +0100
tree	61dc33292ea13f1b789dfdcba5d842499e66c111
parent	7493e06f9571853d1d9e4b47186ebd8a96e401ea [diff]

tree: 61dc33292ea13f1b789dfdcba5d842499e66c111

README.md

Krawfish Prototype

The Krawfish Prototype is a testbed search backend for KorAP, to implement design concepts both for Kanalito and Krill.

Krawfish Prototype focusses on

Patterns for distribution (data aggregation, sorting, grouping ...)
Implementation of a forward index
Normalization and optimization of complex queries
Implementation of experimental features

Krawfish Prototype is still work in progress. The segment handling of Krawfish is based on Krill and therefore heavily inspired by Lucene and Lucy.

! This software is in its early stages and not stable yet! Use it on your own risk!

SETUP

Krawfish Prototype requires Perl of at least v5.10.1. The recommended environment is based on Perlbrew with App::cpanminus.

$ git clone https://github.com/KorAP/Krawfish-prototype
$ cd Krawfish-prototype
$ cpanm --installdeps .
$ perl Makefile.PL
$ make test

SYNOPSIS

use Krawfish::Koral;
use Krawfish::Index;

# Add documents to index
my $index = Krawfish::Index->new;
$index->introduce_field('docID' => 'de_DE');
$index->add_doc('t/data/doc1.jsonld');
$index->add_doc('t/data/doc2.jsonld');
$index->commit;

# Start KoralQuery object
my $koral = Krawfish::Koral->new;

# Define a query
# [einen|"d.*"][][Hut]
my $query = $koral->query_builder;
$koral->query(
  $query->seq(
    $query->token(
      $query->bool_or(
        'einen',
        $query->term_re('d.*')
      )
    ),
    $query->anywhere,
    $query->term('Hut')
  )
);

# Define a virtual corpus
my $corpus = $koral->corpus_builder;
$koral->corpus(
  $corpus->bool_and(
    $corpus->string('license=free'),
    $corpus->string('corpus=corpus-2')
  )
);

# Define a compilation target
my $compile = $koral->compilation_builder;
$koral->compilation(
  $compile->aggregate(
    $compile->a_fields('license'),
    $compile->a_frequencies
  ),
  $compile->enrich(
    $compile->e_fields('textLength')
  ),
  $compile->sort_by(
    $compile->s_field('docID')
  )
);

# Execute KoralQuery
my $request = $koral->to_query
  ->identify($index->dict)
  ->optimize($index->segment);

if ($request->next) {
  print $request->current_match->to_string;
};

COPYRIGHT AND LICENSE

Krawfish Prototype is free software published under the BSD-2 License.