OpenApiTypesense.Stemming (OpenApiTypesense v1.0.0)

View Source

Provides API endpoints related to stemming

Summary

Functions

Retrieve a stemming dictionary

Import a stemming dictionary

List all stemming dictionaries

Types

list_stemming_dictionaries_200_json_resp()

(since 0.7.0)
@type list_stemming_dictionaries_200_json_resp() :: %{
  dictionaries: [String.t()] | nil
}

Functions

get_stemming_dictionary(dictionaryId, opts \\ [])

(since 0.7.0)
@spec get_stemming_dictionary(
  String.t(),
  keyword()
) ::
  {:ok, OpenApiTypesense.StemmingDictionary.t()}
  | {:error, OpenApiTypesense.ApiResponse.t()}

Retrieve a stemming dictionary

Fetch details of a specific stemming dictionary.

import_stemming_dictionary(body, opts \\ [])

(since 0.7.0)
@spec import_stemming_dictionary(
  String.t(),
  keyword()
) :: {:ok, String.t()} | {:error, OpenApiTypesense.ApiResponse.t()}

Import a stemming dictionary

Upload a JSONL file containing word mappings to create or update a stemming dictionary.

Options

  • id: The ID to assign to the dictionary

Example

iex> body = [
...>   %{"word" => "people", "root" => "person"}
...>   %{"word" => "children", "root" => "child"}
...>   %{"word" => "geese", "root" => "goose"}
...> ]
iex> OpenApiTypesense.Stemming.import_stemming_dictionary(body, id: "irregular-plurals")

list_stemming_dictionaries(opts \\ [])

(since 0.7.0)
@spec list_stemming_dictionaries(keyword()) ::
  {:ok, map()} | {:error, OpenApiTypesense.ApiResponse.t()}

List all stemming dictionaries

Retrieve a list of all available stemming dictionaries.