View Source OpenApiTypesense.Synonyms (OpenApiTypesense v0.3.0)

Provides API endpoints related to synonyms

Summary

Functions

delete_search_synonym(collectionName, synonymId, opts \\ [])

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

Delete a synonym associated with a collection

delete_search_synonym(conn, collectionName, synonymId, opts)

get_search_synonym(collectionName, synonymId, opts \\ [])

@spec get_search_synonym(String.t(), String.t(), 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_synonym(conn, collectionName, synonymId, opts)

get_search_synonyms(collectionName, opts \\ [])

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

List all collection synonyms

get_search_synonyms(conn, collectionName, opts)

upsert_search_synonym(collectionName, synonymId, body, opts \\ [])

Create or update a synonym

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

upsert_search_synonym(conn, collectionName, synonymId, body, opts)