OpenApiTypesense.Curation (OpenApiTypesense v1.0.1)

View Source

Provides API endpoints related to curation

Summary

Functions

Delete an override associated with a collection

List all collection overrides

Create or update an override to promote certain documents over others

Functions

delete_search_override(collectionName, overrideId, opts \\ [])

(since 0.4.0)
@spec delete_search_override(String.t(), String.t(), keyword()) ::
  {:ok, OpenApiTypesense.SearchOverrideDeleteResponse.t()}
  | {:error, OpenApiTypesense.ApiResponse.t()}

Delete an override associated with a collection

get_search_overrides(collectionName, opts \\ [])

(since 0.4.0)
@spec get_search_overrides(
  String.t(),
  keyword()
) ::
  {:ok, OpenApiTypesense.SearchOverridesResponse.t()}
  | {:error, OpenApiTypesense.ApiResponse.t()}

List all collection overrides

Options

  • limit: Limit results in paginating on collection listing.
  • offset: Skip a certain number of results and start after that.

upsert_search_override(collectionName, overrideId, body, opts \\ [])

(since 0.4.0)

Create or update an override to promote certain documents over others

Create or update an override to promote certain documents over others. Using overrides, you can include or exclude specific documents for a given query.