Skip to content
Orama Docs

Using Japanese with Orama

At the time of writing, Orama supports Japanese via a custom tokenizer, which is part of the @orama/tokenizers package.

To get started, make sure to install all the dependencies you need:

Terminal window
npm install @orama/orama @orama/tokenizers

If you want to add Japanese stop-words as well, install the @orama/stopwords package too:

Terminal window
npm install @orama/stopwords

Now you’re ready to get started with Orama:

import { create, insert, search } from "@orama/orama";
import { createTokenizer } from '@orama/tokenizers/japanese'
import { stopwords as japaneseStopwords } from "@orama/stopwords/japanese";


const db = create({
  schema: {
    name: "string",
  },
  components: {
    tokenizer: createTokenizer({
      stopWords: japaneseStopwords,
    }),
  },
});


insert(db, { name: "東京" }); // Tokyo
insert(db, { name: "大阪" }); // Osaka
insert(db, { name: "京都" }); // Kyoto
insert(db, { name: "横浜" }); // Yokohama
insert(db, { name: "札幌" }); // Sapporo
insert(db, { name: "仙台" }); // Sendai
insert(db, { name: "広島" }); // Hiroshima
insert(db, { name: "東京大学" }); // University of Tokyo
insert(db, { name: "京都大学" }); // Kyoto University
insert(db, { name: "大阪大学" }); // Osaka University


const results = search(db, {
  term: "大阪",
  threshold: 0,
});


console.log(results);


// {
//   "elapsed": {
//     "raw": 89554625,
//     "formatted": "89ms"
//   },
//   "hits": [
//     {
//       "id": "36666208-3",
//       "score": 4.210224897276653,
//       "document": {
//         "name": "大阪"
//       }
//     },
//     {
//       "id": "36666208-10",
//       "score": 1.9335268122510698,
//       "document": {
//         "name": "大阪大学"
//       }
//     }
//   ],
//   "count": 2
// }