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
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package kendra
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/service/kendra/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Updates the settings of query suggestions for an index.
//
// Amazon Kendra supports partial updates, so you only need to provide the fields
// you want to update.
//
// If an update is currently processing, you need to wait for the update to finish
// before making another update.
//
// Updates to query suggestions settings might not take effect right away. The
// time for your updated settings to take effect depends on the updates made and
// the number of search queries in your index.
//
// You can still enable/disable query suggestions at any time.
//
// UpdateQuerySuggestionsConfig is currently not supported in the Amazon Web
// Services GovCloud (US-West) region.
func (c *Client) UpdateQuerySuggestionsConfig(ctx context.Context, params *UpdateQuerySuggestionsConfigInput, optFns ...func(*Options)) (*UpdateQuerySuggestionsConfigOutput, error) {
if params == nil {
params = &UpdateQuerySuggestionsConfigInput{}
}
result, metadata, err := c.invokeOperation(ctx, "UpdateQuerySuggestionsConfig", params, optFns, c.addOperationUpdateQuerySuggestionsConfigMiddlewares)
if err != nil {
return nil, err
}
out := result.(*UpdateQuerySuggestionsConfigOutput)
out.ResultMetadata = metadata
return out, nil
}
type UpdateQuerySuggestionsConfigInput struct {
// The identifier of the index with query suggestions you want to update.
//
// This member is required.
IndexId *string
// Configuration information for the document fields/attributes that you want to
// base query suggestions on.
AttributeSuggestionsConfig *types.AttributeSuggestionsUpdateConfig
// TRUE to include queries without user information (i.e. all queries,
// irrespective of the user), otherwise FALSE to only include queries with user
// information.
//
// If you pass user information to Amazon Kendra along with the queries, you can
// set this flag to FALSE and instruct Amazon Kendra to only consider queries with
// user information.
//
// If you set to FALSE , Amazon Kendra only considers queries searched at least
// MinimumQueryCount times across MinimumNumberOfQueryingUsers unique users for
// suggestions.
//
// If you set to TRUE , Amazon Kendra ignores all user information and learns from
// all queries.
IncludeQueriesWithoutUserInformation *bool
// The minimum number of unique users who must search a query in order for the
// query to be eligible to suggest to your users.
//
// Increasing this number might decrease the number of suggestions. However, this
// ensures a query is searched by many users and is truly popular to suggest to
// users.
//
// How you tune this setting depends on your specific needs.
MinimumNumberOfQueryingUsers *int32
// The the minimum number of times a query must be searched in order to be
// eligible to suggest to your users.
//
// Decreasing this number increases the number of suggestions. However, this
// affects the quality of suggestions as it sets a low bar for a query to be
// considered popular to suggest to users.
//
// How you tune this setting depends on your specific needs.
MinimumQueryCount *int32
// Set the mode to ENABLED or LEARN_ONLY .
//
// By default, Amazon Kendra enables query suggestions. LEARN_ONLY mode allows you
// to turn off query suggestions. You can to update this at any time.
//
// In LEARN_ONLY mode, Amazon Kendra continues to learn from new queries to keep
// suggestions up to date for when you are ready to switch to ENABLED mode again.
Mode types.Mode
// How recent your queries are in your query log time window.
//
// The time window is the number of days from current day to past days.
//
// By default, Amazon Kendra sets this to 180.
QueryLogLookBackWindowInDays *int32
noSmithyDocumentSerde
}
type UpdateQuerySuggestionsConfigOutput struct {
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationUpdateQuerySuggestionsConfigMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsAwsjson11_serializeOpUpdateQuerySuggestionsConfig{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpUpdateQuerySuggestionsConfig{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "UpdateQuerySuggestionsConfig"); 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 = addOpUpdateQuerySuggestionsConfigValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opUpdateQuerySuggestionsConfig(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_opUpdateQuerySuggestionsConfig(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "UpdateQuerySuggestionsConfig",
}
}
|
