OpenApiTypesense.Synonyms (OpenApiTypesense v1.3.2)

@spec delete_search_synonym(
  collection_name :: String.t(),
  synonym_id :: String.t(),
  opts :: keyword()
) ::
  {:ok, OpenApiTypesense.SearchSynonymDeleteResponse.t()}
  | {:error, OpenApiTypesense.ApiResponse.t()}

Delete a synonym associated with a collection

delete_synonym_set(synonym_set_name, opts \\ [])

(since 1.2.0)

@spec delete_synonym_set(synonym_set_name :: String.t(), opts :: keyword()) ::
  {:ok, OpenApiTypesense.SynonymSetDeleteSchema.t()}
  | {:error, OpenApiTypesense.ApiResponse.t()}

Delete a synonym set

Delete a specific synonym set by its name

delete_synonym_set_item(synonym_set_name, item_id, opts \\ [])

(since 1.2.0)

@spec delete_synonym_set_item(
  synonym_set_name :: String.t(),
  item_id :: String.t(),
  opts :: keyword()
) ::
  {:ok, OpenApiTypesense.SynonymItemDeleteSchema.t()}
  | {:error, OpenApiTypesense.ApiResponse.t()}

Delete a synonym set item

Delete a specific synonym item by its id

get_search_synonym(collection_name, synonym_id, opts \\ [])

(since 0.4.0)

This function is deprecated. Please use retrieve_synonym_set/2 or retrieve_synonym_set_item/3 when using Typesense v30.0+.

@spec get_search_synonym(
  collection_name :: String.t(),
  synonym_id :: String.t(),
  opts :: keyword()
) ::
  {:ok, OpenApiTypesense.SearchSynonym.t()}
  | {:error, OpenApiTypesense.ApiResponse.t()}

Retrieve a single search synonym

Retrieve the details of a search synonym, given its id.

get_search_synonyms(collection_name, opts \\ [])

(since 0.4.0)

This function is deprecated. Please use retrieve_synonym_set_items/2 or retrieve_synonym_sets/1 when using Typesense v30.0+.

@spec get_search_synonyms(collection_name :: String.t(), opts :: keyword()) ::
  {:ok, OpenApiTypesense.SearchSynonymsResponse.t()}
  | {:error, OpenApiTypesense.ApiResponse.t()}

List all collection synonyms

Options

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

retrieve_synonym_set(synonym_set_name, opts \\ [])

(since 1.2.0)

@spec retrieve_synonym_set(synonym_set_name :: String.t(), opts :: keyword()) ::
  {:ok, OpenApiTypesense.SynonymSetSchema.t()}
  | {:error, OpenApiTypesense.ApiResponse.t()}

Retrieve a synonym set

Retrieve a specific synonym set by its name

retrieve_synonym_set_item(synonym_set_name, item_id, opts \\ [])

(since 1.2.0)

@spec retrieve_synonym_set_item(
  synonym_set_name :: String.t(),
  item_id :: String.t(),
  opts :: keyword()
) ::
  {:ok, OpenApiTypesense.SynonymItemSchema.t()}
  | {:error, OpenApiTypesense.ApiResponse.t()}

Retrieve a synonym set item

Retrieve a specific synonym item by its id

retrieve_synonym_set_items(synonym_set_name, opts \\ [])

(since 1.2.0)

@spec retrieve_synonym_set_items(synonym_set_name :: String.t(), opts :: keyword()) ::
  {:ok, [OpenApiTypesense.SynonymItemSchema.t()]}
  | {:error, OpenApiTypesense.ApiResponse.t()}

List items in a synonym set

Retrieve all synonym items in a set

retrieve_synonym_sets(opts \\ [])

(since 1.2.0)

@spec retrieve_synonym_sets(opts :: keyword()) ::
  {:ok, [OpenApiTypesense.SynonymSetSchema.t()]} | :error

List all synonym sets

Retrieve all synonym sets

upsert_search_synonym(collection_name, synonym_id, body, opts \\ [])

(since 0.4.0)

This function is deprecated. Please use upsert_synonym_set/3 or upsert_synonym_set_item/4 when using Typesense v30.0+.

@spec upsert_search_synonym(
  collection_name :: String.t(),
  synonym_id :: String.t(),
  body :: OpenApiTypesense.SearchSynonymSchema.t(),
  opts :: keyword()
) ::
  {:ok, OpenApiTypesense.SearchSynonym.t()}
  | {:error, OpenApiTypesense.ApiResponse.t()}

Create or update a synonym

Create or update a synonym to define search terms that should be considered equivalent.

Request Body

Content Types: application/json

The search synonym object to be created/updated

upsert_synonym_set(synonym_set_name, body, opts \\ [])

(since 1.2.0)

@spec upsert_synonym_set(
  synonym_set_name :: String.t(),
  body :: OpenApiTypesense.SynonymSetCreateSchema.t(),
  opts :: keyword()
) ::
  {:ok, OpenApiTypesense.SynonymSetSchema.t()}
  | {:error, OpenApiTypesense.ApiResponse.t()}

Create or update a synonym set

Create or update a synonym set with the given name

Request Body

Content Types: application/json

The synonym set to be created/updated

upsert_synonym_set_item(synonym_set_name, item_id, body, opts \\ [])

(since 1.2.0)

@spec upsert_synonym_set_item(
  synonym_set_name :: String.t(),
  item_id :: String.t(),
  body :: OpenApiTypesense.SynonymItemUpsertSchema.t(),
  opts :: keyword()
) ::
  {:ok, OpenApiTypesense.SynonymItemSchema.t()}
  | {:error, OpenApiTypesense.ApiResponse.t()}

Create or update a synonym set item

Create or update a synonym set item with the given id

Request Body

Content Types: application/json

The synonym item to be created/updated