OpenApiTypesense.Synonyms (OpenApiTypesense v1.0.1)
View SourceProvides API endpoints related to synonyms
Summary
Functions
Delete a synonym associated with a collection
Retrieve a single search synonym
List all collection synonyms
Create or update a synonym
Functions
@spec delete_search_synonym(String.t(), String.t(), keyword()) :: {:ok, OpenApiTypesense.SearchSynonymDeleteResponse.t()} | {:error, OpenApiTypesense.ApiResponse.t()}
Delete a synonym associated with a collection
@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.
@spec get_search_synonyms( String.t(), 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.
@spec upsert_search_synonym( String.t(), String.t(), OpenApiTypesense.SearchSynonymSchema.t(), 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.