ExTypesense.Stopwords (ExTypesense v1.1.1)
View SourceStopwords are keywords which will be removed from search query while searching.
During indexing
Stopwords are NOT dropped during indexing.
More here: https://typesense.org/docs/latest/api/stopwords.html
Summary
Functions
Permanently deletes a stopwords set, given it's name.
Same as delete_stopword/2 but passes another connection.
Retrieve the details of a stopwords set, given it's name.
Same as get_stopword/2 but passes another connection.
Retrieves all stopwords sets.
Same as list_stopwords/0
Same as list_stopwords/1 but passes another connection.
Upserts a stopwords set.
Same as upsert_stopword/3 but passes another connection.
Functions
@spec delete_stopword(String.t()) :: {:ok, map()} | {:error, OpenApiTypesense.ApiResponse.t()}
Permanently deletes a stopwords set, given it's name.
@spec delete_stopword( map() | OpenApiTypesense.Connection.t() | String.t(), String.t() | keyword() ) :: {:ok, map()} | {:error, OpenApiTypesense.ApiResponse.t()}
Same as delete_stopword/1
ExTypesense.delete_stopword("stopword_set_countries", [])
ExTypesense.delete_stopword(%{api_key: xyz, host: ...}, "stopword_set_countries")
ExTypesense.delete_stopword(OpenApiTypesense.Connection.new(), "stopword_set_countries")
@spec delete_stopword(map() | OpenApiTypesense.Connection.t(), String.t(), keyword()) :: {:ok, map()} | {:error, OpenApiTypesense.ApiResponse.t()}
Same as delete_stopword/2 but passes another connection.
ExTypesense.delete_stopword(%{api_key: xyz, host: ...}, "stopword_set_countries", [])
ExTypesense.delete_stopword(OpenApiTypesense.Connection.new(), "stopword_set_countries", [])
@spec get_stopword(String.t()) :: {:ok, OpenApiTypesense.StopwordsSetRetrieveSchema.t()} | {:error, OpenApiTypesense.ApiResponse.t()}
Retrieve the details of a stopwords set, given it's name.
@spec get_stopword( map() | OpenApiTypesense.Connection.t() | String.t(), String.t() | keyword() ) :: {:ok, OpenApiTypesense.StopwordsSetRetrieveSchema.t()} | {:error, OpenApiTypesense.ApiResponse.t()}
Same as get_stopword/1
ExTypesense.get_stopword("stopword_set_countries", [])
ExTypesense.get_stopword(%{api_key: xyz, host: ...}, "stopword_set_countries")
ExTypesense.get_stopword(OpenApiTypesense.Connection.new(), "stopword_set_countries")
@spec get_stopword(map() | OpenApiTypesense.Connection.t(), String.t(), keyword()) :: {:ok, OpenApiTypesense.StopwordsSetRetrieveSchema.t()} | {:error, OpenApiTypesense.ApiResponse.t()}
Same as get_stopword/2 but passes another connection.
ExTypesense.get_stopword(%{api_key: xyz, host: ...}, "stopword_set_countries", [])
ExTypesense.get_stopword(OpenApiTypesense.Connection.new(), "stopword_set_countries", [])
@spec list_stopwords() :: {:ok, OpenApiTypesense.StopwordsSetsRetrieveAllSchema.t()} | :error
Retrieves all stopwords sets.
@spec list_stopwords(map() | OpenApiTypesense.Connection.t() | keyword()) :: {:ok, OpenApiTypesense.StopwordsSetsRetrieveAllSchema.t()} | :error
Same as list_stopwords/0
ExTypesense.list_stopwords([])
ExTypesense.list_stopwords(%{api_key: xyz, host: ...})
ExTypesense.list_stopwords(OpenApiTypesense.Connection.new())
@spec list_stopwords( map() | OpenApiTypesense.Connection.t(), keyword() ) :: {:ok, OpenApiTypesense.StopwordsSetsRetrieveAllSchema.t()} | :error
Same as list_stopwords/1 but passes another connection.
ExTypesense.list_stopwords(%{api_key: xyz, host: ...}, [])
ExTypesense.list_stopwords(OpenApiTypesense.Connection.new(), [])
@spec upsert_stopword(String.t(), map()) :: {:ok, OpenApiTypesense.StopwordsSetSchema.t()} | {:error, OpenApiTypesense.ApiResponse.t()}
Upserts a stopwords set.
Examples
iex> body = %{
...> "stopwords" => [
...> "Bustin Jieber",
...> "Pelvis Presly",
...> "Tinus Lorvalds",
...> "Britney Smears"
...> ],
...> "locale" => "en"
...> }
iex> ExTypesense.upsert_override("stopwords-famous-person", body)
@spec upsert_stopword( map() | OpenApiTypesense.Connection.t() | String.t(), String.t() | map(), map() | keyword() ) :: {:ok, OpenApiTypesense.StopwordsSetSchema.t()} | {:error, OpenApiTypesense.ApiResponse.t()}
Same as upsert_stopword/2
ExTypesense.upsert_stopword("stopword_set_countries", body, [])
ExTypesense.upsert_stopword(%{api_key: xyz, host: ...}, "stopword_set_countries", body)
ExTypesense.upsert_stopword(OpenApiTypesense.Connection.new(), "stopword_set_countries", body)
@spec upsert_stopword( map() | OpenApiTypesense.Connection.t(), String.t(), map(), keyword() ) :: {:ok, OpenApiTypesense.StopwordsSetSchema.t()} | {:error, OpenApiTypesense.ApiResponse.t()}
Same as upsert_stopword/3 but passes another connection.
ExTypesense.upsert_stopword(%{api_key: xyz, host: ...}, "stopword_set_countries", body, [])
ExTypesense.upsert_stopword(OpenApiTypesense.Connection.new(), "stopword_set_countries", body, [])