OpenApiTypesense.Stemming (OpenApiTypesense v0.7.0)
View SourceProvides API endpoints related to stemming
Summary
Functions
Retrieve a stemming dictionary
Either one of
Either one of
Import a stemming dictionary
Either one of
List all stemming dictionaries
Types
@type list_stemming_dictionaries_200_json_resp() :: %{ dictionaries: [String.t()] | nil }
Functions
@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.
@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())
@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)
@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")
@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")
@spec list_stemming_dictionaries() :: {:ok, map()} | {:error, OpenApiTypesense.ApiResponse.t()}
List all stemming dictionaries
Retrieve a list of all available stemming dictionaries.
@spec list_stemming_dictionaries(map() | OpenApiTypesense.Connection.t() | keyword()) :: {:ok, map()} | {:error, OpenApiTypesense.ApiResponse.t()}
@spec list_stemming_dictionaries( map() | OpenApiTypesense.Connection.t(), keyword() ) :: {:ok, map()} | {:error, OpenApiTypesense.ApiResponse.t()}