OpenApiTypesense.Stopwords (OpenApiTypesense v1.0.1)

View Source

Provides API endpoints related to stopwords

Summary

Types

delete_stopwords_set_200_json_resp()

(since 0.4.0)
@type delete_stopwords_set_200_json_resp() :: %{id: String.t()}

Functions

delete_stopwords_set(setId, opts \\ [])

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

retrieve_stopwords_set(setId, opts \\ [])

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

retrieve_stopwords_sets(opts \\ [])

(since 0.4.0)
@spec retrieve_stopwords_sets(keyword()) ::
  {:ok, OpenApiTypesense.StopwordsSetsRetrieveAllSchema.t()}
  | {:error, OpenApiTypesense.ApiResponse.t()}

Retrieves all stopwords sets.

Retrieve the details of all stopwords sets

upsert_stopwords_set(setId, body, opts \\ [])

(since 0.4.0)

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.