ExTypesense.Stemming (ExTypesense v2.0.0)

View Source

Stemming specific operations.

More here: https://typesense.org/docs/latest/api/stemming.html

Summary

Functions

get_stemming_dictionary(dictionary_id)

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

Retrieve a stemming dictionary

Fetch details of a specific stemming dictionary.

get_stemming_dictionary(dictionary_id, opts)

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

Same as get_stemming_dictionary/1

Options

  • conn: The custom connection map or struct you passed

Examples

iex> conn = %{api_key: xyz, host: ...}
iex> ExTypesense.get_stemming_dictionary(dictionary_id, conn: conn)

iex> conn = OpenApiTypesense.Connection.new()
iex> ExTypesense.get_stemming_dictionary(dictionary_id, conn: conn)

iex> opts = [conn: conn]
iex> ExTypesense.get_stemming_dictionary(dictionary_id, opts)

import_stemming_dictionary(body, opts)

(since 1.2.0)
@spec import_stemming_dictionary(
  [map()],
  keyword()
) :: {:ok, String.t()} | {:error, OpenApiTypesense.ApiResponse.t()}

Import a stemming dictionary

Options

  • conn: The custom connection map or struct you passed
  • id: The ID to assign to the dictionary

Example

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

iex> conn = %{api_key: xyz, host: ...}
iex> ExTypesense.import_stemming_dictionary(body, id: "irregular-plurals", conn: conn)

iex> conn = OpenApiTypesense.Connection.new()
iex> ExTypesense.import_stemming_dictionary(body, id: "irregular-plurals", conn: conn)

iex> opts = [id: "irregular-plurals", conn: conn]
iex> ExTypesense.import_stemming_dictionary(body, opts)

list_stemming_dictionaries()

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

List all stemming dictionaries

list_stemming_dictionaries(opts)

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

Same as list_stemming_dictionaries/0

Options

  • conn: The custom connection map or struct you passed

Examples

iex> conn = %{api_key: xyz, host: ...}
iex> ExTypesense.list_stemming_dictionaries(conn: conn)

iex> conn = OpenApiTypesense.Connection.new()
iex> ExTypesense.list_stemming_dictionaries(conn: conn)

iex> opts = [conn: conn]
iex> ExTypesense.list_stemming_dictionaries(opts)