https://github.com/lindera/lindera-tantivy
Lindera tokenizer for Tantivy.
https://github.com/lindera/lindera-tantivy
lindera tantivy tokenizer
Last synced: 6 months ago
JSON representation
Lindera tokenizer for Tantivy.
- Host: GitHub
- URL: https://github.com/lindera/lindera-tantivy
- Owner: lindera
- License: mit
- Created: 2020-02-19T01:37:00.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2024-12-06T06:54:50.000Z (10 months ago)
- Last Synced: 2025-03-28T19:06:47.076Z (6 months ago)
- Topics: lindera, tantivy, tokenizer
- Language: Rust
- Homepage:
- Size: 114 KB
- Stars: 57
- Watchers: 1
- Forks: 13
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Authors: AUTHORS
Awesome Lists containing this project
README
# Lindera tokenizer for Tantivy
[](https://opensource.org/licenses/MIT) [](https://gitter.im/lindera-morphology/lindera?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[Lindera](https://github.com/lindera-morphology/lindera) Tokenizer for [Tantivy](https://github.com/tantivy-search/tantivy).
## Usage
Make sure you have activated the required dictionaries for the Lindera in Cargo.toml.
The following example enables IPADIC.
```
[dependencies]
lindera = "0.38"
lindera-tantivy = { version = "0.38.0", features = ["ipadic"] }
```
### Basic example
```rust
fn main() -> tantivy::Result<()> {
use tantivy::{
collector::TopDocs,
doc,
query::QueryParser,
schema::{IndexRecordOption, Schema, TextFieldIndexing, TextOptions},
Document, Index, TantivyDocument,
};
use lindera::dictionary::DictionaryKind;
use lindera::{dictionary::load_dictionary_from_kind, mode::Mode, segmenter::Segmenter};
use lindera_tantivy::tokenizer::LinderaTokenizer;
// create schema builder
let mut schema_builder = Schema::builder();
// add id field
let id = schema_builder.add_text_field(
"id",
TextOptions::default()
.set_indexing_options(
TextFieldIndexing::default()
.set_tokenizer("raw")
.set_index_option(IndexRecordOption::Basic),
)
.set_stored(),
);
// add title field
let title = schema_builder.add_text_field(
"title",
TextOptions::default()
.set_indexing_options(
TextFieldIndexing::default()
.set_tokenizer("lang_ja")
.set_index_option(IndexRecordOption::WithFreqsAndPositions),
)
.set_stored(),
);
// add body field
let body = schema_builder.add_text_field(
"body",
TextOptions::default()
.set_indexing_options(
TextFieldIndexing::default()
.set_tokenizer("lang_ja")
.set_index_option(IndexRecordOption::WithFreqsAndPositions),
)
.set_stored(),
);
// build schema
let schema = schema_builder.build();
// create index on memory
let index = Index::create_in_ram(schema.clone());
// Tokenizer with IPADIC
let mode = Mode::Normal;
let dictionary = load_dictionary_from_kind(DictionaryKind::IPADIC).unwrap();
let user_dictionary = None;
let segmenter = Segmenter::new(mode, dictionary, user_dictionary);
let tokenizer = LinderaTokenizer::from_segmenter(segmenter);
// register Lindera tokenizer
index.tokenizers().register("lang_ja", tokenizer);
// create index writer
let mut index_writer = index.writer(50_000_000)?;
// add document
index_writer.add_document(doc!(
id => "1",
title => "成田国際空港",
body => "成田国際空港（なりたこくさいくうこう、英: Narita International Airport）は、千葉県成田市南東部から芝山町北部にかけて建設された日本最大の国際拠点空港である。首都圏東部（東京の東60km）に位置している。空港コードはNRT。"
)).unwrap();
// add document
index_writer.add_document(doc!(
id => "2",
title => "東京国際空港",
body => "東京国際空港（とうきょうこくさいくうこう、英語: Tokyo International Airport）は、東京都大田区にある日本最大の空港。通称は羽田空港（はねだくうこう、英語: Haneda Airport）であり、単に「羽田」と呼ばれる場合もある。空港コードはHND。"
)).unwrap();
// add document
index_writer.add_document(doc!(
id => "3",
title => "関西国際空港",
body => "関西国際空港（かんさいこくさいくうこう、英: Kansai International Airport）は大阪市の南西35㎞に位置する西日本の国際的な玄関口であり、関西三空港の一つとして大阪国際空港（伊丹空港）、神戸空港とともに関西エアポート株式会社によって一体運営が行われている。"
)).unwrap();
// commit
index_writer.commit()?;
// create reader
let reader = index.reader()?;
// create searcher
let searcher = reader.searcher();
// create querhy parser
let query_parser = QueryParser::for_index(&index, vec![title, body]);
// parse query
let query_str = "東京";
let query = query_parser.parse_query(query_str)?;
println!("Query String: {}", query_str);
// search
let top_docs = searcher.search(&query, &TopDocs::with_limit(10))?;
println!("Search Result:");
for (_, doc_address) in top_docs {
let retrieved_doc: TantivyDocument = searcher.doc(doc_address)?;
println!("{}", retrieved_doc.to_json(&schema));
}
Ok(())
}
```
### Config by YAML
```rust
use std::path::PathBuf;
fn main() -> tantivy::Result<()> {
use tantivy::{
collector::TopDocs,
doc,
query::QueryParser,
schema::{IndexRecordOption, Schema, TextFieldIndexing, TextOptions},
Document, Index, TantivyDocument,
};
use lindera_tantivy::tokenizer::LinderaTokenizer;
// create schema builder
let mut schema_builder = Schema::builder();
// add id field
let id = schema_builder.add_text_field(
"id",
TextOptions::default()
.set_indexing_options(
TextFieldIndexing::default()
.set_tokenizer("raw")
.set_index_option(IndexRecordOption::Basic),
)
.set_stored(),
);
// add title field
let title = schema_builder.add_text_field(
"title",
TextOptions::default()
.set_indexing_options(
TextFieldIndexing::default()
.set_tokenizer("lang_ja")
.set_index_option(IndexRecordOption::WithFreqsAndPositions),
)
.set_stored(),
);
// add body field
let body = schema_builder.add_text_field(
"body",
TextOptions::default()
.set_indexing_options(
TextFieldIndexing::default()
.set_tokenizer("lang_ja")
.set_index_option(IndexRecordOption::WithFreqsAndPositions),
)
.set_stored(),
);
// build schema
let schema = schema_builder.build();
// create index on memory
let index = Index::create_in_ram(schema.clone());
// Build tokenizer with config file
let config_file = PathBuf::from(env!("CARGO_MANIFEST_DIR"))
.join("./examples")
.join("lindera.yml");
let tokenizer = LinderaTokenizer::from_file(config_file.as_path())?;
// register Lindera tokenizer
index.tokenizers().register("lang_ja", tokenizer);
// create index writer
let mut index_writer = index.writer(50_000_000)?;
// add document
index_writer.add_document(doc!(
id => "1",
title => "成田国際空港",
body => "成田国際空港（なりたこくさいくうこう、英: Narita International Airport）は、千葉県成田市南東部から芝山町北部にかけて建設された日本最大の国際拠点空港である。首都圏東部（東京の東60km）に位置している。空港コードはNRT。"
)).unwrap();
// add document
index_writer.add_document(doc!(
id => "2",
title => "東京国際空港",
body => "東京国際空港（とうきょうこくさいくうこう、英語: Tokyo International Airport）は、東京都大田区にある日本最大の空港。通称は羽田空港（はねだくうこう、英語: Haneda Airport）であり、単に「羽田」と呼ばれる場合もある。空港コードはHND。"
)).unwrap();
// add document
index_writer.add_document(doc!(
id => "3",
title => "関西国際空港",
body => "関西国際空港（かんさいこくさいくうこう、英: Kansai International Airport）は大阪市の南西35㎞に位置する西日本の国際的な玄関口であり、関西三空港の一つとして大阪国際空港（伊丹空港）、神戸空港とともに関西エアポート株式会社によって一体運営が行われている。"
)).unwrap();
// commit
index_writer.commit()?;
// create reader
let reader = index.reader()?;
// create searcher
let searcher = reader.searcher();
// create querhy parser
let query_parser = QueryParser::for_index(&index, vec![title, body]);
// parse query
let query_str = "ＴＯＫＹＯ";
let query = query_parser.parse_query(query_str)?;
println!("Query String: {}", query_str);
// search
println!("Parsed Query: {:?}", query);
let top_docs = searcher.search(&query, &TopDocs::with_limit(10))?;
println!("Search Result:");
for (_, doc_address) in top_docs {
let retrieved_doc: TantivyDocument = searcher.doc(doc_address)?;
println!("{}", retrieved_doc.to_json(&schema));
}
Ok(())
}
```
## API reference
The API reference is available. Please see following URL:
- lindera-tantivy