Change Summary

• add functionality to import plurals via end-point
• normalize plurals with stem_dictionary=true per field
• add test

adding dictionary via end-point

To add plurals, we need to import jsonl file to end-point /stemming/dictionaries/import via POST request like below,

curl -k -H 'Content-Type:' -H "X-TYPESENSE-API-KEY: ${TYPESENSE_API_KEY}" -X POST --data-binary @plurals.jsonl "http://localhost:8108/stemming/dictionaries/import?id=set1"

Here id is dictionary name we want to store.

jsonl file should contain plurals in below format

{"word": "meetings", "root":"meeting"}
{"word": "people", "root":"person"}
{"word": "attentions", "root":"attention"}
{"word": "leathers", "root":"leather"}
{"word": "qualities", "root":"quality"}

get specific dictionary

To get the stored dictionary, we need to request via GET request to end-point /stemming/dictionaries/:id like below,

curl "http://localhost:8108/stemming/dictionaries/set1" -X GET -H "Content-Type: application/json" -H "X-TYPESENSE-API-KEY: ${TYPESENSE_API_KEY}"

Here set1 is the id of dictionary given while storing the dictionary. We will get the response like below.

{"id":"set1","words":[{"root":"attention","word":"attentions"},{"root":"quality","word":"qualities"},{"root":"leather","word":"leathers"},{"root":"person","word":"people"},{"root":"meeting","word":"meetings"}]}

get all stored dictionaries

To fetch all dictionary sets stored on typesense server, we need to send a GET request to end-point /stemming/dictionaries like below,

curl "http://localhost:8108/stemming/dictionaries" -X GET -H "Content-Type: application/json" -H "X-TYPESENSE-API-KEY: ${TYPESENSE_API_KEY}"

Which will respond in below format,

{"dictionaries":["set1"]}

using the dictionary with collection search

We need to specify dictionary name while creating collection in order to use with searches in collection.
Here's how it can be created,

curl "http://localhost:8108/collections" \
       -X POST \
       -H "Content-Type: application/json" \
       -H "X-TYPESENSE-API-KEY: ${TYPESENSE_API_KEY}" \
       -d '{
         "name": "companies",
         "fields": [
           {"name": "country", "type": "string", "stem_dictionary": "set1" }
       }'

Here stem_dictionary param specifies which dictionary to use for normalizing words while searching.

PR Checklist

• I have read and signed the Contributor License Agreement.