OpenApiTypesense.Synonyms (OpenApiTypesense v1.0.4)

View Source

Provides API endpoints related to synonyms

Summary

Functions

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

(since 0.4.0)
@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

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

(since 0.4.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)
@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.

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

(since 0.4.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.