OpenApiTypesense.Stopwords (OpenApiTypesense v0.6.5)
View SourceProvides API endpoints related to stopwords
Summary
Functions
Delete a stopwords set.
Either one of
Either one of
Retrieves a stopwords set.
Either one of
Either one of
Retrieves all stopwords sets.
Either one of
Either one of
Upserts a stopwords set.
Either one of
Either one of
Types
@type delete_stopwords_set_200_json_resp() :: %{id: String.t()}
Functions
@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.
@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)
@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)
@spec retrieve_stopwords_set(String.t()) :: {: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( map() | OpenApiTypesense.Connection.t() | String.t(), keyword() ) :: {:ok, OpenApiTypesense.StopwordsSetRetrieveSchema.t()} | {:error, OpenApiTypesense.ApiResponse.t()}
Either one of:
retrieve_stopwords_set(setId, opts)
retrieve_stopwords_set(%{api_key: xyz, host: ...}, setId)
retrieve_stopwords_set(Connection.new(), setId)
@spec retrieve_stopwords_set( map() | OpenApiTypesense.Connection.t(), String.t(), keyword() ) :: {:ok, OpenApiTypesense.StopwordsSetRetrieveSchema.t()} | {:error, OpenApiTypesense.ApiResponse.t()}
Either one of:
retrieve_stopwords_set(%{api_key: xyz, host: ...}, setId, conn, opts)
retrieve_stopwords_set(Connection.new(), setId, conn, opts)
@spec retrieve_stopwords_sets() :: {:ok, OpenApiTypesense.StopwordsSetsRetrieveAllSchema.t()} | {:error, OpenApiTypesense.ApiResponse.t()}
Retrieves all stopwords sets.
Retrieve the details of all stopwords sets
@spec retrieve_stopwords_sets(map() | OpenApiTypesense.Connection.t() | keyword()) :: {:ok, OpenApiTypesense.StopwordsSetsRetrieveAllSchema.t()} | {:error, OpenApiTypesense.ApiResponse.t()}
Either one of:
retrieve_stopwords_sets(opts)
retrieve_stopwords_sets(%{api_key: xyz, host: ...})
retrieve_stopwords_sets(Connection.new())
@spec retrieve_stopwords_sets( map() | OpenApiTypesense.Connection.t(), keyword() ) :: {:ok, OpenApiTypesense.StopwordsSetsRetrieveAllSchema.t()} | {:error, OpenApiTypesense.ApiResponse.t()}
Either one of:
retrieve_stopwords_sets(%{api_key: xyz, host: ...}, opts)
retrieve_stopwords_sets(Connection.new(), opts)
@spec upsert_stopwords_set(String.t(), map()) :: {: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( map() | OpenApiTypesense.Connection.t() | String.t(), String.t() | map(), map() | keyword() ) :: {:ok, OpenApiTypesense.StopwordsSetSchema.t()} | {:error, OpenApiTypesense.ApiResponse.t()}
Either one of:
upsert_stopwords_set(setId, body, opts)
upsert_stopwords_set(%{api_key: xyz, host: ...}, setId, body)
upsert_stopwords_set(Connection.new(), setId, body)
@spec upsert_stopwords_set( map() | OpenApiTypesense.Connection.t(), String.t(), map(), keyword() ) :: {:ok, OpenApiTypesense.StopwordsSetSchema.t()} | {:error, OpenApiTypesense.ApiResponse.t()}
Either one of:
upsert_stopwords_set(%{api_key: xyz, host: ...}, setId, body, opts)
upsert_stopwords_set(Connection.new(), setId, body, opts)