1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package personalizeruntime
import (
"context"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/personalizeruntime/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// 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 (c *Client) GetPersonalizedRanking(ctx context.Context, params *GetPersonalizedRankingInput, optFns ...func(*Options)) (*GetPersonalizedRankingOutput, error) {
if params == nil {
params = &GetPersonalizedRankingInput{}
}
result, metadata, err := c.invokeOperation(ctx, "GetPersonalizedRanking", params, optFns, c.addOperationGetPersonalizedRankingMiddlewares)
if err != nil {
return nil, err
}
out := result.(*GetPersonalizedRankingOutput)
out.ResultMetadata = metadata
return out, nil
}
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 items or
// exclude items from recommendations for a given user. For more information, see
// Filtering Recommendations
// (https://docs.aws.amazon.com/personalize/latest/dg/filter.html).
FilterArn *string
// The values to use when filtering recommendations. For each placeholder parameter
// in your filter expression, provide the parameter name (in matching case) as a
// key and the filter value(s) as the corresponding value. Separate multiple values
// for one parameter with a comma. For filter expressions that use an INCLUDE
// element to include items, you must provide values for all parameters that are
// defined in the expression. For filters with expressions that use an EXCLUDE
// element to exclude items, you can omit the filter-values.In this case, Amazon
// Personalize doesn't use that portion of the expression to filter
// recommendations. For more information, see Filtering Recommendations
// (https://docs.aws.amazon.com/personalize/latest/dg/filter.html).
FilterValues map[string]string
noSmithyDocumentSerde
}
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
noSmithyDocumentSerde
}
func (c *Client) addOperationGetPersonalizedRankingMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsRestjson1_serializeOpGetPersonalizedRanking{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpGetPersonalizedRanking{}, middleware.After)
if err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = addHTTPSignerV4Middleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addOpGetPersonalizedRankingValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opGetPersonalizedRanking(options.Region), middleware.Before); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opGetPersonalizedRanking(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "personalize",
OperationName: "GetPersonalizedRanking",
}
}
|