File: types.go

package info (click to toggle)
golang-github-aws-aws-sdk-go-v2 1.17.1-3
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 384,244 kB
  • sloc: java: 13,538; makefile: 400; sh: 137
file content (57 lines) | stat: -rw-r--r-- 2,136 bytes parent folder | download
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
// Code generated by smithy-go-codegen DO NOT EDIT.

package types

import (
	smithydocument "github.com/aws/smithy-go/document"
)

// An object that identifies an item. The and APIs return a list of PredictedItems.
type PredictedItem struct {

	// The recommended item ID.
	ItemId *string

	// The name of the promotion that included the predicted item.
	PromotionName *string

	// A numeric representation of the model's certainty that the item will be the next
	// user selection. For more information on scoring logic, see how-scores-work.
	Score *float64

	noSmithyDocumentSerde
}

// Contains information on a promotion. A promotion defines additional business
// rules that apply to a configurable subset of recommended items.
type Promotion struct {

	// The Amazon Resource Name (ARN) of the filter used by the promotion. This filter
	// defines the criteria for promoted items. For more information, see Promotion
	// filters
	// (https://docs.aws.amazon.com/personalize/latest/dg/promoting-items.html#promotion-filters).
	FilterArn *string

	// The values to use when promoting items. For each placeholder parameter in your
	// promotion's 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 on creating filters, see Filtering
	// recommendations and user segments
	// (https://docs.aws.amazon.com/personalize/latest/dg/filter.html).
	FilterValues map[string]string

	// The name of the promotion.
	Name *string

	// The percentage of recommended items to apply the promotion to.
	PercentPromotedItems int32

	noSmithyDocumentSerde
}

type noSmithyDocumentSerde = smithydocument.NoSerde