View Source OpenApiTypesense.Curation (OpenApiTypesense v0.2.0)
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
@spec delete_search_override(String.t(), String.t(), keyword()) :: {:ok, OpenApiTypesense.SearchOverrideDeleteResponse.t()} | {:error, OpenApiTypesense.ApiResponse.t()}
Delete an override associated with a collection
@spec delete_search_override( OpenApiTypesense.Connection.t(), String.t(), String.t(), keyword() ) :: {:ok, OpenApiTypesense.SearchOverrideDeleteResponse.t()} | {:error, OpenApiTypesense.ApiResponse.t()}
@spec get_search_overrides( String.t(), keyword() ) :: {:ok, OpenApiTypesense.SearchOverridesResponse.t()} | :error
List all collection overrides
@spec get_search_overrides(OpenApiTypesense.Connection.t(), String.t(), keyword()) :: {:ok, OpenApiTypesense.SearchOverridesResponse.t()} | :error
@spec upsert_search_override( String.t(), String.t(), OpenApiTypesense.SearchOverrideSchema.t(), keyword() ) :: {:ok, OpenApiTypesense.SearchOverride.t()} | {:error, OpenApiTypesense.ApiResponse.t()}
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.
@spec upsert_search_override( OpenApiTypesense.Connection.t(), String.t(), String.t(), OpenApiTypesense.SearchOverrideSchema.t(), keyword() ) :: {:ok, OpenApiTypesense.SearchOverride.t()} | {:error, OpenApiTypesense.ApiResponse.t()}