commonMain.com.algolia.search.endpoint.EndpointRecommend.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of algoliasearch-client-kotlin-jvm Show documentation

"Algolia is a powerful search-as-a-service solution, made easy to use with API clients, UI libraries, and pre-built integrations. Algolia API Client for Kotlin lets you easily use the Algolia Search REST API from your JVM project, such as Android or backend implementations."

There is a newer version: 3.12.2

Show newest version

package com.algolia.search.endpoint

import com.algolia.search.model.recommend.FrequentlyBoughtTogetherQuery
import com.algolia.search.model.recommend.RecommendationsQuery
import com.algolia.search.model.recommend.RelatedProductsQuery
import com.algolia.search.model.response.ResponseSearch
import com.algolia.search.transport.RequestOptions

public interface EndpointRecommend {

    /**
     * Returns recommendations for a specific model and objectID.
     */
    public suspend fun getRecommendations(
        requests: List,
        requestOptions: RequestOptions? = null
    ): List

    /**
     * Returns related products recommendations for a specific model and objectID.
     */
    public suspend fun getRelatedProducts(
        requests: List,
        requestOptions: RequestOptions? = null
    ): List

    /**
     * Returns frequently bought together recommendations for a specific model and objectID.
     */
    public suspend fun getFrequentlyBoughtTogether(
        requests: List,
        requestOptions: RequestOptions? = null
    ): List
}