personalizeruntime/aws.sdk.kotlin.services.personalizeruntime

Package-level declarations

Types

PersonalizeRuntimeClient

interface PersonalizeRuntimeClient : SdkClient

Properties

SdkVersion

const val SdkVersion: String

ServiceApiVersion

const val ServiceApiVersion: String

ServiceId

const val ServiceId: String

Inherited functions

getActionRecommendations

inline suspend fun PersonalizeRuntimeClient.getActionRecommendations(crossinline block: GetActionRecommendationsRequest.Builder.() -> Unit): GetActionRecommendationsResponse

Returns a list of recommended actions in sorted in descending order by prediction score. Use the GetActionRecommendations API if you have a custom campaign that deploys a solution version trained with a PERSONALIZED_ACTIONS recipe.

getPersonalizedRanking

inline suspend fun PersonalizeRuntimeClient.getPersonalizedRanking(crossinline block: GetPersonalizedRankingRequest.Builder.() -> Unit): GetPersonalizedRankingResponse

Re-ranks a list of recommended items for the given user. The first item in the list is deemed the most likely item to be of interest to the user.

getRecommendations

inline suspend fun PersonalizeRuntimeClient.getRecommendations(crossinline block: GetRecommendationsRequest.Builder.() -> Unit): GetRecommendationsResponse

Returns a list of recommended items. For campaigns, the campaign's Amazon Resource Name (ARN) is required and the required user and item input depends on the recipe type used to create the solution backing the campaign as follows:

withConfig

fun PersonalizeRuntimeClient.withConfig(block: PersonalizeRuntimeClient.Config.Builder.() -> Unit): PersonalizeRuntimeClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.