View Source OpenApiTypesense.Stopwords (OpenApiTypesense v0.3.0)
Provides API endpoints related to stopwords
Summary
Functions
Delete a stopwords set.
Retrieves a stopwords set.
Retrieves all stopwords sets.
Upserts a stopwords set.
Types
@type delete_stopwords_set_200_json_resp() :: %{id: String.t()}
Functions
@spec delete_stopwords_set( String.t(), keyword() ) :: {:ok, map()} | {:error, OpenApiTypesense.ApiResponse.t()}
Delete a stopwords set.
Permanently deletes a stopwords set, given it's name.
@spec delete_stopwords_set(OpenApiTypesense.Connection.t(), String.t(), keyword()) :: {:ok, map()} | {:error, OpenApiTypesense.ApiResponse.t()}
@spec retrieve_stopwords_set( String.t(), keyword() ) :: {:ok, OpenApiTypesense.StopwordsSetRetrieveSchema.t()} | {:error, OpenApiTypesense.ApiResponse.t()}
Retrieves a stopwords set.
Retrieve the details of a stopwords set, given it's name.
@spec retrieve_stopwords_set(OpenApiTypesense.Connection.t(), String.t(), keyword()) :: {:ok, OpenApiTypesense.StopwordsSetRetrieveSchema.t()} | {:error, OpenApiTypesense.ApiResponse.t()}
@spec retrieve_stopwords_sets(keyword()) :: {:ok, OpenApiTypesense.StopwordsSetsRetrieveAllSchema.t()} | :error
Retrieves all stopwords sets.
Retrieve the details of all stopwords sets
@spec retrieve_stopwords_sets( OpenApiTypesense.Connection.t(), keyword() ) :: {:ok, OpenApiTypesense.StopwordsSetsRetrieveAllSchema.t()} | :error
@spec upsert_stopwords_set( String.t(), OpenApiTypesense.StopwordsSetUpsertSchema.t(), keyword() ) :: {:ok, OpenApiTypesense.StopwordsSetSchema.t()} | {:error, OpenApiTypesense.ApiResponse.t()}
Upserts a stopwords set.
When an analytics rule is created, we give it a name and describe the type, the source collections and the destination collection.
@spec upsert_stopwords_set( OpenApiTypesense.Connection.t(), String.t(), OpenApiTypesense.StopwordsSetUpsertSchema.t(), keyword() ) :: {:ok, OpenApiTypesense.StopwordsSetSchema.t()} | {:error, OpenApiTypesense.ApiResponse.t()}