PersonalizeRuntime
Service object for interacting with AWS PersonalizeRuntime service.
public struct PersonalizeRuntime: AWSService
Inheritance
AWSService
Initializers
init(client:region:partition:endpoint:timeout:byteBufferAllocator:options:)
Initialize the PersonalizeRuntime client
public init(client: AWSClient, region: SotoCore.Region? = nil, partition: AWSPartition = .aws, endpoint: String? = nil, timeout: TimeAmount? = nil, byteBufferAllocator: ByteBufferAllocator = ByteBufferAllocator(), options: AWSServiceConfig.Options = [])
Parameters
- client: AWSClient used to process requests
- region: Region of server you want to communicate with. This will override the partition parameter.
- partition: AWS partition where service resides, standard (.aws), china (.awscn), government (.awsusgov).
- endpoint: Custom endpoint URL to use instead of standard AWS servers
- timeout: Timeout value for HTTP requests
init(from:patch:)
Initializer required by AWSService.with(middlewares:timeout:byteBufferAllocator:options)
. You are not able to use this initializer directly as there are no public initializers for AWSServiceConfig.Patch
. Please use AWSService.with(middlewares:timeout:byteBufferAllocator:options)
instead.
public init(from: PersonalizeRuntime, patch: AWSServiceConfig.Patch)
Properties
client
Client used for communication with AWS
let client: AWSClient
config
Service configuration
let config: AWSServiceConfig
Methods
getPersonalizedRanking(_:logger:on:)
public func getPersonalizedRanking(_ input: GetPersonalizedRankingRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<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.
The solution backing the campaign must have been created using a recipe of type PERSONALIZED_RANKING.
getRecommendations(_:logger:on:)
public func getRecommendations(_ input: GetRecommendationsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetRecommendationsResponse>
Returns a list of recommended items. The required input depends on the recipe type used to create the solution backing the campaign, as follows:
-
RELATED_ITEMS -
itemId
required,userId
not used -
USER_PERSONALIZATION -
itemId
optional,userId
required
Campaigns that are backed by a solution created using a recipe of type PERSONALIZED_RANKING use the API.