OpenApiTypesense.Stemming (OpenApiTypesense v0.7.0)

View Source

Provides API endpoints related to stemming

Summary

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)

(since 0.7.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(dictionaryId, opts)

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

Either one of:

  • get_stemming_dictionary(dictionary_id, opts)
  • get_stemming_dictionary(dictionary_id, %{api_key: xyz, host: ...})
  • get_stemming_dictionary(dictionary_id, Connection.new())

get_stemming_dictionary(conn, dictionaryId, opts)

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

Either one of:

  • get_stemming_dictionary(dictionary_id, %{api_key: xyz, host: ...}, opts)
  • get_stemming_dictionary(dictionary_id, Connection.new(), opts)

import_stemming_dictionary(body, opts)

(since 0.7.0)
@spec import_stemming_dictionary(
  [map()],
  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")

import_stemming_dictionary(conn, body, opts)

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

Either one of:

  • import_stemming_dictionary(%{api_key: xyz, host: ...}, body, id: "something")
  • import_stemming_dictionary(dictionary_id, Connection.new(), body, id: "some-id")

list_stemming_dictionaries()

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

List all stemming dictionaries

Retrieve a list of all available stemming dictionaries.

list_stemming_dictionaries(opts)

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

list_stemming_dictionaries(conn, opts)

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