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
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package personalizeruntime
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/service/personalizeruntime/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// 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.
//
// For more information about PERSONALIZED_ACTIONS recipes, see [PERSONALIZED_ACTIONS recipes]. For more
// information about getting action recommendations, see [Getting action recommendations].
//
// [Getting action recommendations]: https://docs.aws.amazon.com/personalize/latest/dg/get-action-recommendations.html
// [PERSONALIZED_ACTIONS recipes]: https://docs.aws.amazon.com/personalize/latest/dg/nexts-best-action-recipes.html
func (c *Client) GetActionRecommendations(ctx context.Context, params *GetActionRecommendationsInput, optFns ...func(*Options)) (*GetActionRecommendationsOutput, error) {
if params == nil {
params = &GetActionRecommendationsInput{}
}
result, metadata, err := c.invokeOperation(ctx, "GetActionRecommendations", params, optFns, c.addOperationGetActionRecommendationsMiddlewares)
if err != nil {
return nil, err
}
out := result.(*GetActionRecommendationsOutput)
out.ResultMetadata = metadata
return out, nil
}
type GetActionRecommendationsInput struct {
// The Amazon Resource Name (ARN) of the campaign to use for getting action
// recommendations. This campaign must deploy a solution version trained with a
// PERSONALIZED_ACTIONS recipe.
CampaignArn *string
// The ARN of the filter to apply to the returned recommendations. For more
// information, see [Filtering Recommendations].
//
// When using this parameter, be sure the filter resource is ACTIVE .
//
// [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 actions, you must
// provide values for all parameters that are defined in the expression. For
// filters with expressions that use an EXCLUDE element to exclude actions, 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 and user segments].
//
// [Filtering recommendations and user segments]: https://docs.aws.amazon.com/personalize/latest/dg/filter.html
FilterValues map[string]string
// The number of results to return. The default is 5. The maximum is 100.
NumResults int32
// The user ID of the user to provide action recommendations for.
UserId *string
noSmithyDocumentSerde
}
type GetActionRecommendationsOutput struct {
// A list of action recommendations sorted in descending order by prediction
// score. There can be a maximum of 100 actions in the list. For information about
// action scores, see [How action recommendation scoring works].
//
// [How action recommendation scoring works]: https://docs.aws.amazon.com/personalize/latest/dg/how-action-recommendation-scoring-works.html
ActionList []types.PredictedAction
// The ID of the recommendation.
RecommendationId *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationGetActionRecommendationsMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsRestjson1_serializeOpGetActionRecommendations{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpGetActionRecommendations{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "GetActionRecommendations"); err != nil {
return fmt.Errorf("add protocol finalizers: %v", err)
}
if err = addlegacyEndpointContextSetter(stack, options); err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = addClientRequestID(stack); err != nil {
return err
}
if err = addComputeContentLength(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = addComputePayloadSHA256(stack); err != nil {
return err
}
if err = addRetry(stack, options); err != nil {
return err
}
if err = addRawResponseToMetadata(stack); err != nil {
return err
}
if err = addRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack, options); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addSetLegacyContextSigningOptionsMiddleware(stack); err != nil {
return err
}
if err = addTimeOffsetBuild(stack, c); err != nil {
return err
}
if err = addUserAgentRetryMode(stack, options); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opGetActionRecommendations(options.Region), middleware.Before); err != nil {
return err
}
if err = addRecursionDetection(stack); 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
}
if err = addDisableHTTPSMiddleware(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opGetActionRecommendations(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "GetActionRecommendations",
}
}
|
