ExTypesense.Synonym (ExTypesense v2.0.1)

View Source

The synonyms feature allows you to define search terms that should be considered equivalent. For eg: when you define a synonym for sneaker as shoe, searching for sneaker will now return all records with the word shoe in them, in addition to records with the word sneaker.

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

Summary

Functions

delete_synonym(coll_name, syn_id)

(since 1.0.0)

Delete a single synonym from a collection.

delete_synonym(module, syn_id, opts)

(since 1.0.0)

Same as delete_synonym/2.

Options

  • conn: The custom connection map or struct you passed

Examples

iex> conn = %{api_key: xyz, host: ...}
iex> ExTypesense.delete_synonym("cars", "sedan-synonym", conn: conn)

iex> conn = OpenApiTypesense.Connection.new()
iex> ExTypesense.delete_synonym("cars", "sedan-synonym", conn: conn)

iex> opts = [conn: conn]
iex> ExTypesense.delete_synonym(MyApp.Vehicle.Car, "sedan-synonym", opts)

get_synonym(coll_name, syn_id)

(since 1.0.0)
@spec get_synonym(String.t() | module(), String.t()) ::
  {:ok, OpenApiTypesense.SearchSynonym.t()}
  | {:error, OpenApiTypesense.ApiResponse.t()}

Retrieve a single synonym from a collection.

get_synonym(module, syn_id, opts)

(since 1.0.0)
@spec get_synonym(String.t() | module(), String.t(), keyword()) ::
  {:ok, OpenApiTypesense.SearchSynonym.t()}
  | {:error, OpenApiTypesense.ApiResponse.t()}

Same as get_synonym/2.

Options

  • conn: The custom connection map or struct you passed

Examples

iex> conn = %{api_key: xyz, host: ...}
iex> ExTypesense.get_synonym("cars", "sedan-synonym", conn: conn)

iex> conn = OpenApiTypesense.Connection.new()
iex> ExTypesense.get_synonym("cars", "sedan-synonym", conn: conn)

iex> opts = [conn: conn]
iex> ExTypesense.get_synonym(MyApp.Vehicle.Car, "sedan-synonym", opts)

list_synonyms(collection_name)

(since 1.0.0)
@spec list_synonyms(String.t() | module()) ::
  {:ok, OpenApiTypesense.SearchSynonymsResponse.t()}
  | {:error, OpenApiTypesense.ApiResponse.t()}

List all synonyms associated with a given collection.

Error

By default, ALL synonyms are returned, but you can use the offset and limit parameters to paginate on the listing.

Options

  • limit: Limit results in paginating on collection listing.
  • offset: Skip a certain number of results and start after that.

list_synonyms(module, opts)

(since 1.0.0)
@spec list_synonyms(
  String.t() | module(),
  keyword()
) ::
  {:ok, OpenApiTypesense.SearchSynonymsResponse.t()}
  | {:error, OpenApiTypesense.ApiResponse.t()}

Same as list_synonyms/1.

Options

  • conn: The custom connection map or struct you passed

Examples

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

iex> conn = OpenApiTypesense.Connection.new()
iex> ExTypesense.list_synonyms("persons", conn: conn)

iex> opts = [conn: conn]
iex> ExTypesense.list_synonyms(MyApp.Accounts.Person, opts)

upsert_synonym(coll_name, syn_id, body)

(since 1.0.0)
@spec upsert_synonym(String.t() | module(), String.t(), map()) ::
  {:ok, OpenApiTypesense.SearchSynonym.t()}
  | {:error, OpenApiTypesense.ApiResponse.t()}

Create or update a synonym

Examples

iex> body = %{
...>   "synonyms" => ["blazer", "coat", "jacket"],
...> }

iex> ExTypesense.upsert_synonym("products", "coat-synonyms", body)

upsert_synonym(module, syn_id, body, opts)

(since 1.0.0)
@spec upsert_synonym(String.t() | module(), String.t(), map(), keyword()) ::
  {:ok, OpenApiTypesense.SearchSynonym.t()}
  | {:error, OpenApiTypesense.ApiResponse.t()}

Same as upsert_synonym/3.

Options

  • conn: The custom connection map or struct you passed

Examples

iex> conn = %{api_key: xyz, host: ...}
iex> ExTypesense.upsert_synonym("persons", "coat-synonyms", body, conn: conn)

iex> conn = OpenApiTypesense.Connection.new()
iex> ExTypesense.upsert_synonym("persons", "coat-synonyms", body, conn: conn)

iex> opts = [conn: conn]
iex> ExTypesense.upsert_synonym(MyApp.Accounts.Person, "coat-synonyms", body, opts)