package personalizeruntime
import "github.com/aws/aws-sdk-go-v2/service/personalizeruntime"
Package personalizeruntime provides the API client, operations, and parameter types for Amazon Personalize Runtime.
Index ¶
- Constants
- func NewDefaultEndpointResolver() *internalendpoints.Resolver
- type Client
- func New(options Options, optFns ...func(*Options)) *Client
- func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client
- func (c *Client) GetPersonalizedRanking(ctx context.Context, params *GetPersonalizedRankingInput, optFns ...func(*Options)) (*GetPersonalizedRankingOutput, error)
- func (c *Client) GetRecommendations(ctx context.Context, params *GetRecommendationsInput, optFns ...func(*Options)) (*GetRecommendationsOutput, error)
- type EndpointResolver
- type EndpointResolverFunc
- type EndpointResolverOptions
- type GetPersonalizedRankingInput
- type GetPersonalizedRankingOutput
- type GetRecommendationsInput
- type GetRecommendationsOutput
- type HTTPClient
- type HTTPSignerV4
- type Options
- type ResolveEndpoint
Constants ¶
const ServiceAPIVersion = "2018-05-22"
const ServiceID = "Personalize Runtime"
Functions ¶
func NewDefaultEndpointResolver ¶
func NewDefaultEndpointResolver() *internalendpoints.Resolver
NewDefaultEndpointResolver constructs a new service endpoint resolver
Types ¶
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client provides the API client to make operations call for Amazon Personalize Runtime.
func New ¶
New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.
func NewFromConfig ¶
NewFromConfig returns a new client from the provided config.
func (*Client) GetPersonalizedRanking ¶
func (c *Client) GetPersonalizedRanking(ctx context.Context, params *GetPersonalizedRankingInput, optFns ...func(*Options)) (*GetPersonalizedRankingOutput, error)
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.
func (*Client) GetRecommendations ¶
func (c *Client) GetRecommendations(ctx context.Context, params *GetRecommendationsInput, optFns ...func(*Options)) (*GetRecommendationsOutput, error)
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.
type EndpointResolver ¶
type EndpointResolver interface { ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error) }
EndpointResolver interface for resolving service endpoints.
func WithEndpointResolver ¶
func WithEndpointResolver(awsResolver aws.EndpointResolver, fallbackResolver EndpointResolver) EndpointResolver
WithEndpointResolver returns an EndpointResolver that first delegates endpoint resolution to the awsResolver. If awsResolver returns aws.EndpointNotFoundError error, the resolver will use the the provided fallbackResolver for resolution. awsResolver and fallbackResolver must not be nil
type EndpointResolverFunc ¶
type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)
EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.
func (EndpointResolverFunc) ResolveEndpoint ¶
func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)
type EndpointResolverOptions ¶
type EndpointResolverOptions = internalendpoints.Options
EndpointResolverOptions is the service endpoint resolver options
type GetPersonalizedRankingInput ¶
type GetPersonalizedRankingInput struct { // The Amazon Resource Name (ARN) of the campaign to use for generating the // personalized ranking. // // This member is required. CampaignArn *string // A list of items (by itemId) to rank. If an item was not included in the training // dataset, the item is appended to the end of the reranked list. The maximum is // 500. // // This member is required. InputList []*string // The user for which you want the campaign to provide a personalized ranking. // // This member is required. UserId *string // The contextual metadata to use when getting recommendations. Contextual metadata // includes any interaction information that might be relevant when getting a // user's recommendations, such as the user's current location or device type. Context map[string]*string // The Amazon Resource Name (ARN) of a filter you created to include or exclude // items from recommendations for a given user. FilterArn *string }
type GetPersonalizedRankingOutput ¶
type GetPersonalizedRankingOutput struct { // A list of items in order of most likely interest to the user. The maximum is // 500. PersonalizedRanking []*types.PredictedItem // The ID of the recommendation. RecommendationId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type GetRecommendationsInput ¶
type GetRecommendationsInput struct { // The Amazon Resource Name (ARN) of the campaign to use for getting // recommendations. // // This member is required. CampaignArn *string // The contextual metadata to use when getting recommendations. Contextual metadata // includes any interaction information that might be relevant when getting a // user's recommendations, such as the user's current location or device type. Context map[string]*string // The ARN of the filter to apply to the returned recommendations. For more // information, see Using Filters with Amazon Personalize // (https://docs.aws.amazon.com/personalize/latest/dg/filters.html). When using // this parameter, be sure the filter resource is ACTIVE. FilterArn *string // The item ID to provide recommendations for. Required for RELATED_ITEMS recipe // type. ItemId *string // The number of results to return. The default is 25. The maximum is 500. NumResults *int32 // The user ID to provide recommendations for. Required for USER_PERSONALIZATION // recipe type. UserId *string }
type GetRecommendationsOutput ¶
type GetRecommendationsOutput struct { // A list of recommendations sorted in ascending order by prediction score. There // can be a maximum of 500 items in the list. ItemList []*types.PredictedItem // The ID of the recommendation. RecommendationId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type HTTPClient ¶
type HTTPSignerV4 ¶
type HTTPSignerV4 interface { SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time) error }
type Options ¶
type Options struct { // Set of options to modify how an operation is invoked. These apply to all // operations invoked for this client. Use functional options on operation call to // modify this list for per operation behavior. APIOptions []func(*middleware.Stack) error // The credentials object to use when signing requests. Credentials aws.CredentialsProvider // The endpoint options to be used when attempting to resolve an endpoint. EndpointOptions EndpointResolverOptions // The service endpoint resolver. EndpointResolver EndpointResolver // Signature Version 4 (SigV4) Signer HTTPSignerV4 HTTPSignerV4 // The region to send requests to. (Required) Region string // Retryer guides how HTTP requests should be retried in case of recoverable // failures. When nil the API client will use a default retryer. Retryer retry.Retryer // The HTTP client to invoke API calls with. Defaults to client's default HTTP // implementation if nil. HTTPClient HTTPClient }
func (Options) Copy ¶
Copy creates a clone where the APIOptions list is deep copied.
type ResolveEndpoint ¶
type ResolveEndpoint struct { Resolver EndpointResolver Options EndpointResolverOptions }
func (*ResolveEndpoint) HandleSerialize ¶
func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) ( out middleware.SerializeOutput, metadata middleware.Metadata, err error, )
func (*ResolveEndpoint) ID ¶
func (*ResolveEndpoint) ID() string
Source Files ¶
api_client.go api_op_GetPersonalizedRanking.go api_op_GetRecommendations.go deserializers.go doc.go endpoints.go serializers.go validators.go
Directories ¶
Path | Synopsis |
---|---|
internal | |
types |
- Version
- v0.29.0
- Published
- Oct 31, 2020
- Platform
- js/wasm
- Imports
- 24 packages
- Last checked
- now –
Tools for package owners.