View Source OpenApiTypesense.Stopwords (OpenApiTypesense v0.4.1)

Provides API endpoints related to stopwords

Summary

Types

delete_stopwords_set_200_json_resp()

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

Functions

delete_stopwords_set(setId)

@spec delete_stopwords_set(String.t()) ::
  {:ok, map()} | {:error, OpenApiTypesense.ApiResponse.t()}

Delete a stopwords set.

Permanently deletes a stopwords set, given it's name.

delete_stopwords_set(setId, opts)

@spec delete_stopwords_set(
  map() | OpenApiTypesense.Connection.t() | String.t(),
  String.t() | keyword()
) ::
  {:ok, map()} | {:error, OpenApiTypesense.ApiResponse.t()}

Either one of:

  • delete_stopwords_set(setId, opts)
  • delete_stopwords_set(%{api_key: xyz, host: ...}, setId)
  • delete_stopwords_set(Connection.new(), setId)

delete_stopwords_set(conn, setId, opts)

@spec delete_stopwords_set(
  map() | OpenApiTypesense.Connection.t(),
  String.t(),
  keyword()
) ::
  {:ok, map()} | {:error, OpenApiTypesense.ApiResponse.t()}

Either one of:

  • delete_stopwords_set(%{api_key: xyz, host: ...}, setId, opts)
  • delete_stopwords_set(Connection.new(), setId, opts)

retrieve_stopwords_set(setId, opts \\ [])

@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_set(conn, setId, opts)

retrieve_stopwords_sets(opts \\ [])

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

Retrieves all stopwords sets.

Retrieve the details of all stopwords sets

retrieve_stopwords_sets(conn, opts)

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

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

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.

upsert_stopwords_set(conn, setId, body, opts)