/
api_op_DetectCustomLabels.go
174 lines (157 loc) · 6.88 KB
/
api_op_DetectCustomLabels.go
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
// Code generated by smithy-go-codegen DO NOT EDIT.
package rekognition
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/rekognition/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Detects custom labels in a supplied image by using an Amazon Rekognition Custom
// Labels model. You specify which version of a model version to use by using the
// ProjectVersionArn input parameter. You pass the input image as base64-encoded
// image bytes or as a reference to an image in an Amazon S3 bucket. If you use the
// AWS CLI to call Amazon Rekognition operations, passing image bytes is not
// supported. The image must be either a PNG or JPEG formatted file. For each
// object that the model version detects on an image, the API returns a
// (CustomLabel) object in an array (CustomLabels). Each CustomLabel object
// provides the label name (Name), the level of confidence that the image contains
// the object (Confidence), and object location information, if it exists, for the
// label on the image (Geometry). During training model calculates a threshold
// value that determines if a prediction for a label is true. By default,
// DetectCustomLabels doesn't return labels whose confidence value is below the
// model's calculated threshold value. To filter labels that are returned, specify
// a value for MinConfidence that is higher than the model's calculated threshold.
// You can get the model's calculated threshold from the model's training results
// shown in the Amazon Rekognition Custom Labels console. To get all labels,
// regardless of confidence, specify a MinConfidence value of 0. You can also add
// the MaxResults parameter to limit the number of labels returned. This is a
// stateless API operation. That is, the operation does not persist any data. This
// operation requires permissions to perform the rekognition:DetectCustomLabels
// action.
func (c *Client) DetectCustomLabels(ctx context.Context, params *DetectCustomLabelsInput, optFns ...func(*Options)) (*DetectCustomLabelsOutput, error) {
if params == nil {
params = &DetectCustomLabelsInput{}
}
result, metadata, err := c.invokeOperation(ctx, "DetectCustomLabels", params, optFns, c.addOperationDetectCustomLabelsMiddlewares)
if err != nil {
return nil, err
}
out := result.(*DetectCustomLabelsOutput)
out.ResultMetadata = metadata
return out, nil
}
type DetectCustomLabelsInput struct {
// Provides the input image either as bytes or an S3 object. You pass image bytes
// to an Amazon Rekognition API operation by using the Bytes property. For example,
// you would use the Bytes property to pass an image loaded from a local file
// system. Image bytes passed by using the Bytes property must be base64-encoded.
// Your code may not need to encode image bytes if you are using an AWS SDK to call
// Amazon Rekognition API operations. For more information, see Analyzing an Image
// Loaded from a Local File System in the Amazon Rekognition Developer Guide. You
// pass images stored in an S3 bucket to an Amazon Rekognition API operation by
// using the S3Object property. Images stored in an S3 bucket do not need to be
// base64-encoded. The region for the S3 bucket containing the S3 object must match
// the region you use for Amazon Rekognition operations. If you use the AWS CLI to
// call Amazon Rekognition operations, passing image bytes using the Bytes property
// is not supported. You must first upload the image to an Amazon S3 bucket and
// then call the operation using the S3Object property. For Amazon Rekognition to
// process an S3 object, the user must have permission to access the S3 object. For
// more information, see Resource Based Policies in the Amazon Rekognition
// Developer Guide.
//
// This member is required.
Image *types.Image
// The ARN of the model version that you want to use.
//
// This member is required.
ProjectVersionArn *string
// Maximum number of results you want the service to return in the response. The
// service returns the specified number of highest confidence labels ranked from
// highest confidence to lowest.
MaxResults *int32
// Specifies the minimum confidence level for the labels to return. Amazon
// Rekognition doesn't return any labels with a confidence lower than this
// specified value. If you specify a value of 0, all labels are return, regardless
// of the default thresholds that the model version applies.
MinConfidence *float32
noSmithyDocumentSerde
}
type DetectCustomLabelsOutput struct {
// An array of custom labels detected in the input image.
CustomLabels []types.CustomLabel
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationDetectCustomLabelsMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsAwsjson11_serializeOpDetectCustomLabels{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpDetectCustomLabels{}, 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 = addOpDetectCustomLabelsValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opDetectCustomLabels(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_opDetectCustomLabels(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "rekognition",
OperationName: "DetectCustomLabels",
}
}