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 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562
|
package face
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License. See License.txt in the project root for license information.
//
// Code generated by Microsoft (R) AutoRest Code Generator.
// Changes may cause incorrect behavior and will be lost if the code is regenerated.
import (
"github.com/Azure/go-autorest/autorest"
"github.com/Azure/go-autorest/autorest/date"
"github.com/gofrs/uuid"
)
// The package's fully qualified name.
const fqdn = "github.com/Azure/azure-sdk-for-go/services/cognitiveservices/v1.0/face"
// Accessory accessory item and corresponding confidence level.
type Accessory struct {
// Type - Type of an accessory. Possible values include: 'HeadWear', 'Glasses', 'Mask'
Type AccessoryType `json:"type,omitempty"`
// Confidence - Confidence level of an accessory
Confidence *float64 `json:"confidence,omitempty"`
}
// APIError error information returned by the API
type APIError struct {
Error *Error `json:"error,omitempty"`
}
// ApplySnapshotRequest request body for applying snapshot operation.
type ApplySnapshotRequest struct {
// ObjectID - User specified target object id to be created from the snapshot.
ObjectID *string `json:"objectId,omitempty"`
// Mode - Snapshot applying mode. Currently only CreateNew is supported, which means the apply operation will fail if target subscription already contains an object of same type and using the same objectId. Users can specify the "objectId" in request body to avoid such conflicts. Possible values include: 'CreateNew'
Mode SnapshotApplyMode `json:"mode,omitempty"`
}
// Attributes face Attributes
type Attributes struct {
// Age - Age in years
Age *float64 `json:"age,omitempty"`
// Gender - Possible gender of the face. Possible values include: 'Male', 'Female'
Gender Gender `json:"gender,omitempty"`
// Smile - Smile intensity, a number between [0,1]
Smile *float64 `json:"smile,omitempty"`
// FacialHair - Properties describing facial hair attributes.
FacialHair *FacialHair `json:"facialHair,omitempty"`
// Glasses - Glasses type if any of the face. Possible values include: 'NoGlasses', 'ReadingGlasses', 'Sunglasses', 'SwimmingGoggles'
Glasses GlassesType `json:"glasses,omitempty"`
// HeadPose - Properties indicating head pose of the face.
HeadPose *HeadPose `json:"headPose,omitempty"`
// Emotion - Properties describing facial emotion in form of confidence ranging from 0 to 1.
Emotion *Emotion `json:"emotion,omitempty"`
// Hair - Properties describing hair attributes.
Hair *Hair `json:"hair,omitempty"`
// Makeup - Properties describing present makeups on a given face.
Makeup *Makeup `json:"makeup,omitempty"`
// Occlusion - Properties describing occlusions on a given face.
Occlusion *Occlusion `json:"occlusion,omitempty"`
// Accessories - Properties describing any accessories on a given face.
Accessories *[]Accessory `json:"accessories,omitempty"`
// Blur - Properties describing any presence of blur within the image.
Blur *Blur `json:"blur,omitempty"`
// Exposure - Properties describing exposure level of the image.
Exposure *Exposure `json:"exposure,omitempty"`
// Noise - Properties describing noise level of the image.
Noise *Noise `json:"noise,omitempty"`
}
// Blur properties describing any presence of blur within the image.
type Blur struct {
// BlurLevel - An enum value indicating level of blurriness. Possible values include: 'Low', 'Medium', 'High'
BlurLevel BlurLevel `json:"blurLevel,omitempty"`
// Value - A number indicating level of blurriness ranging from 0 to 1.
Value *float64 `json:"value,omitempty"`
}
// Coordinate coordinates within an image
type Coordinate struct {
// X - The horizontal component, in pixels.
X *float64 `json:"x,omitempty"`
// Y - The vertical component, in pixels.
Y *float64 `json:"y,omitempty"`
}
// DetectedFace detected Face object.
type DetectedFace struct {
FaceID *uuid.UUID `json:"faceId,omitempty"`
// RecognitionModel - Possible values include: 'Recognition01', 'Recognition02', 'Recognition03'
RecognitionModel RecognitionModel `json:"recognitionModel,omitempty"`
FaceRectangle *Rectangle `json:"faceRectangle,omitempty"`
FaceLandmarks *Landmarks `json:"faceLandmarks,omitempty"`
FaceAttributes *Attributes `json:"faceAttributes,omitempty"`
}
// Emotion properties describing facial emotion in form of confidence ranging from 0 to 1.
type Emotion struct {
Anger *float64 `json:"anger,omitempty"`
Contempt *float64 `json:"contempt,omitempty"`
Disgust *float64 `json:"disgust,omitempty"`
Fear *float64 `json:"fear,omitempty"`
Happiness *float64 `json:"happiness,omitempty"`
Neutral *float64 `json:"neutral,omitempty"`
Sadness *float64 `json:"sadness,omitempty"`
Surprise *float64 `json:"surprise,omitempty"`
}
// Error error body.
type Error struct {
Code *string `json:"code,omitempty"`
Message *string `json:"message,omitempty"`
}
// Exposure properties describing exposure level of the image.
type Exposure struct {
// ExposureLevel - An enum value indicating level of exposure. Possible values include: 'UnderExposure', 'GoodExposure', 'OverExposure'
ExposureLevel ExposureLevel `json:"exposureLevel,omitempty"`
// Value - A number indicating level of exposure level ranging from 0 to 1. [0, 0.25) is under exposure. [0.25, 0.75) is good exposure. [0.75, 1] is over exposure.
Value *float64 `json:"value,omitempty"`
}
// FacialHair properties describing facial hair attributes.
type FacialHair struct {
Moustache *float64 `json:"moustache,omitempty"`
Beard *float64 `json:"beard,omitempty"`
Sideburns *float64 `json:"sideburns,omitempty"`
}
// FindSimilarRequest request body for find similar operation.
type FindSimilarRequest struct {
// FaceID - FaceId of the query face. User needs to call Face - Detect first to get a valid faceId. Note that this faceId is not persisted and will expire 24 hours after the detection call
FaceID *uuid.UUID `json:"faceId,omitempty"`
// FaceListID - An existing user-specified unique candidate face list, created in Face List - Create a Face List. Face list contains a set of persistedFaceIds which are persisted and will never expire. Parameter faceListId, largeFaceListId and faceIds should not be provided at the same time.
FaceListID *string `json:"faceListId,omitempty"`
// LargeFaceListID - An existing user-specified unique candidate large face list, created in LargeFaceList - Create. Large face list contains a set of persistedFaceIds which are persisted and will never expire. Parameter faceListId, largeFaceListId and faceIds should not be provided at the same time.
LargeFaceListID *string `json:"largeFaceListId,omitempty"`
// FaceIds - An array of candidate faceIds. All of them are created by Face - Detect and the faceIds will expire 24 hours after the detection call. The number of faceIds is limited to 1000. Parameter faceListId, largeFaceListId and faceIds should not be provided at the same time.
FaceIds *[]uuid.UUID `json:"faceIds,omitempty"`
// MaxNumOfCandidatesReturned - The number of top similar faces returned. The valid range is [1, 1000].
MaxNumOfCandidatesReturned *int32 `json:"maxNumOfCandidatesReturned,omitempty"`
// Mode - Similar face searching mode. It can be "matchPerson" or "matchFace". Possible values include: 'MatchPerson', 'MatchFace'
Mode FindSimilarMatchMode `json:"mode,omitempty"`
}
// GroupRequest request body for group request.
type GroupRequest struct {
// FaceIds - Array of candidate faceId created by Face - Detect. The maximum is 1000 faces
FaceIds *[]uuid.UUID `json:"faceIds,omitempty"`
}
// GroupResult an array of face groups based on face similarity.
type GroupResult struct {
autorest.Response `json:"-"`
// Groups - A partition of the original faces based on face similarity. Groups are ranked by number of faces
Groups *[][]uuid.UUID `json:"groups,omitempty"`
// MessyGroup - Face ids array of faces that cannot find any similar faces from original faces.
MessyGroup *[]uuid.UUID `json:"messyGroup,omitempty"`
}
// Hair properties describing hair attributes.
type Hair struct {
// Bald - A number describing confidence level of whether the person is bald.
Bald *float64 `json:"bald,omitempty"`
// Invisible - A boolean value describing whether the hair is visible in the image.
Invisible *bool `json:"invisible,omitempty"`
// HairColor - An array of candidate colors and confidence level in the presence of each.
HairColor *[]HairColor `json:"hairColor,omitempty"`
}
// HairColor hair color and associated confidence
type HairColor struct {
// Color - Name of the hair color. Possible values include: 'Unknown', 'White', 'Gray', 'Blond', 'Brown', 'Red', 'Black', 'Other'
Color HairColorType `json:"color,omitempty"`
// Confidence - Confidence level of the color
Confidence *float64 `json:"confidence,omitempty"`
}
// HeadPose properties indicating head pose of the face.
type HeadPose struct {
Roll *float64 `json:"roll,omitempty"`
Yaw *float64 `json:"yaw,omitempty"`
Pitch *float64 `json:"pitch,omitempty"`
}
// IdentifyCandidate all possible faces that may qualify.
type IdentifyCandidate struct {
// PersonID - Id of candidate
PersonID *uuid.UUID `json:"personId,omitempty"`
// Confidence - Confidence threshold of identification, used to judge whether one face belong to one person. The range of confidenceThreshold is [0, 1] (default specified by algorithm).
Confidence *float64 `json:"confidence,omitempty"`
}
// IdentifyRequest request body for identify face operation.
type IdentifyRequest struct {
// FaceIds - Array of query faces faceIds, created by the Face - Detect. Each of the faces are identified independently. The valid number of faceIds is between [1, 10].
FaceIds *[]uuid.UUID `json:"faceIds,omitempty"`
// PersonGroupID - PersonGroupId of the target person group, created by PersonGroup - Create. Parameter personGroupId and largePersonGroupId should not be provided at the same time.
PersonGroupID *string `json:"personGroupId,omitempty"`
// LargePersonGroupID - LargePersonGroupId of the target large person group, created by LargePersonGroup - Create. Parameter personGroupId and largePersonGroupId should not be provided at the same time.
LargePersonGroupID *string `json:"largePersonGroupId,omitempty"`
// MaxNumOfCandidatesReturned - The range of maxNumOfCandidatesReturned is between 1 and 5 (default is 1).
MaxNumOfCandidatesReturned *int32 `json:"maxNumOfCandidatesReturned,omitempty"`
// ConfidenceThreshold - Confidence threshold of identification, used to judge whether one face belong to one person. The range of confidenceThreshold is [0, 1] (default specified by algorithm).
ConfidenceThreshold *float64 `json:"confidenceThreshold,omitempty"`
}
// IdentifyResult response body for identify face operation.
type IdentifyResult struct {
// FaceID - FaceId of the query face
FaceID *uuid.UUID `json:"faceId,omitempty"`
// Candidates - Identified person candidates for that face (ranked by confidence). Array size should be no larger than input maxNumOfCandidatesReturned. If no person is identified, will return an empty array.
Candidates *[]IdentifyCandidate `json:"candidates,omitempty"`
}
// ImageURL ...
type ImageURL struct {
// URL - Publicly reachable URL of an image
URL *string `json:"url,omitempty"`
}
// Landmarks a collection of 27-point face landmarks pointing to the important positions of face
// components.
type Landmarks struct {
PupilLeft *Coordinate `json:"pupilLeft,omitempty"`
PupilRight *Coordinate `json:"pupilRight,omitempty"`
NoseTip *Coordinate `json:"noseTip,omitempty"`
MouthLeft *Coordinate `json:"mouthLeft,omitempty"`
MouthRight *Coordinate `json:"mouthRight,omitempty"`
EyebrowLeftOuter *Coordinate `json:"eyebrowLeftOuter,omitempty"`
EyebrowLeftInner *Coordinate `json:"eyebrowLeftInner,omitempty"`
EyeLeftOuter *Coordinate `json:"eyeLeftOuter,omitempty"`
EyeLeftTop *Coordinate `json:"eyeLeftTop,omitempty"`
EyeLeftBottom *Coordinate `json:"eyeLeftBottom,omitempty"`
EyeLeftInner *Coordinate `json:"eyeLeftInner,omitempty"`
EyebrowRightInner *Coordinate `json:"eyebrowRightInner,omitempty"`
EyebrowRightOuter *Coordinate `json:"eyebrowRightOuter,omitempty"`
EyeRightInner *Coordinate `json:"eyeRightInner,omitempty"`
EyeRightTop *Coordinate `json:"eyeRightTop,omitempty"`
EyeRightBottom *Coordinate `json:"eyeRightBottom,omitempty"`
EyeRightOuter *Coordinate `json:"eyeRightOuter,omitempty"`
NoseRootLeft *Coordinate `json:"noseRootLeft,omitempty"`
NoseRootRight *Coordinate `json:"noseRootRight,omitempty"`
NoseLeftAlarTop *Coordinate `json:"noseLeftAlarTop,omitempty"`
NoseRightAlarTop *Coordinate `json:"noseRightAlarTop,omitempty"`
NoseLeftAlarOutTip *Coordinate `json:"noseLeftAlarOutTip,omitempty"`
NoseRightAlarOutTip *Coordinate `json:"noseRightAlarOutTip,omitempty"`
UpperLipTop *Coordinate `json:"upperLipTop,omitempty"`
UpperLipBottom *Coordinate `json:"upperLipBottom,omitempty"`
UnderLipTop *Coordinate `json:"underLipTop,omitempty"`
UnderLipBottom *Coordinate `json:"underLipBottom,omitempty"`
}
// LargeFaceList large face list object.
type LargeFaceList struct {
autorest.Response `json:"-"`
// LargeFaceListID - LargeFaceListId of the target large face list.
LargeFaceListID *string `json:"largeFaceListId,omitempty"`
// RecognitionModel - Possible values include: 'Recognition01', 'Recognition02', 'Recognition03'
RecognitionModel RecognitionModel `json:"recognitionModel,omitempty"`
// Name - User defined name, maximum length is 128.
Name *string `json:"name,omitempty"`
// UserData - User specified data. Length should not exceed 16KB.
UserData *string `json:"userData,omitempty"`
}
// LargePersonGroup large person group object.
type LargePersonGroup struct {
autorest.Response `json:"-"`
// LargePersonGroupID - LargePersonGroupId of the target large person groups
LargePersonGroupID *string `json:"largePersonGroupId,omitempty"`
// RecognitionModel - Possible values include: 'Recognition01', 'Recognition02', 'Recognition03'
RecognitionModel RecognitionModel `json:"recognitionModel,omitempty"`
// Name - User defined name, maximum length is 128.
Name *string `json:"name,omitempty"`
// UserData - User specified data. Length should not exceed 16KB.
UserData *string `json:"userData,omitempty"`
}
// List face list object.
type List struct {
autorest.Response `json:"-"`
// FaceListID - FaceListId of the target face list.
FaceListID *string `json:"faceListId,omitempty"`
// PersistedFaces - Persisted faces within the face list.
PersistedFaces *[]PersistedFace `json:"persistedFaces,omitempty"`
// RecognitionModel - Possible values include: 'Recognition01', 'Recognition02', 'Recognition03'
RecognitionModel RecognitionModel `json:"recognitionModel,omitempty"`
// Name - User defined name, maximum length is 128.
Name *string `json:"name,omitempty"`
// UserData - User specified data. Length should not exceed 16KB.
UserData *string `json:"userData,omitempty"`
}
// ListDetectedFace ...
type ListDetectedFace struct {
autorest.Response `json:"-"`
Value *[]DetectedFace `json:"value,omitempty"`
}
// ListIdentifyResult ...
type ListIdentifyResult struct {
autorest.Response `json:"-"`
Value *[]IdentifyResult `json:"value,omitempty"`
}
// ListLargeFaceList ...
type ListLargeFaceList struct {
autorest.Response `json:"-"`
Value *[]LargeFaceList `json:"value,omitempty"`
}
// ListLargePersonGroup ...
type ListLargePersonGroup struct {
autorest.Response `json:"-"`
Value *[]LargePersonGroup `json:"value,omitempty"`
}
// ListList ...
type ListList struct {
autorest.Response `json:"-"`
Value *[]List `json:"value,omitempty"`
}
// ListPersistedFace ...
type ListPersistedFace struct {
autorest.Response `json:"-"`
Value *[]PersistedFace `json:"value,omitempty"`
}
// ListPerson ...
type ListPerson struct {
autorest.Response `json:"-"`
Value *[]Person `json:"value,omitempty"`
}
// ListPersonGroup ...
type ListPersonGroup struct {
autorest.Response `json:"-"`
Value *[]PersonGroup `json:"value,omitempty"`
}
// ListSimilarFace ...
type ListSimilarFace struct {
autorest.Response `json:"-"`
Value *[]SimilarFace `json:"value,omitempty"`
}
// ListSnapshot ...
type ListSnapshot struct {
autorest.Response `json:"-"`
Value *[]Snapshot `json:"value,omitempty"`
}
// Makeup properties describing present makeups on a given face.
type Makeup struct {
// EyeMakeup - A boolean value describing whether eye makeup is present on a face.
EyeMakeup *bool `json:"eyeMakeup,omitempty"`
// LipMakeup - A boolean value describing whether lip makeup is present on a face.
LipMakeup *bool `json:"lipMakeup,omitempty"`
}
// MetaDataContract a combination of user defined name and user specified data and recognition model name
// for largePersonGroup/personGroup, and largeFaceList/faceList.
type MetaDataContract struct {
// RecognitionModel - Possible values include: 'Recognition01', 'Recognition02', 'Recognition03'
RecognitionModel RecognitionModel `json:"recognitionModel,omitempty"`
// Name - User defined name, maximum length is 128.
Name *string `json:"name,omitempty"`
// UserData - User specified data. Length should not exceed 16KB.
UserData *string `json:"userData,omitempty"`
}
// NameAndUserDataContract a combination of user defined name and user specified data for the person,
// largePersonGroup/personGroup, and largeFaceList/faceList.
type NameAndUserDataContract struct {
// Name - User defined name, maximum length is 128.
Name *string `json:"name,omitempty"`
// UserData - User specified data. Length should not exceed 16KB.
UserData *string `json:"userData,omitempty"`
}
// Noise properties describing noise level of the image.
type Noise struct {
// NoiseLevel - An enum value indicating level of noise. Possible values include: 'NoiseLevelLow', 'NoiseLevelMedium', 'NoiseLevelHigh'
NoiseLevel NoiseLevel `json:"noiseLevel,omitempty"`
// Value - A number indicating level of noise level ranging from 0 to 1. [0, 0.25) is under exposure. [0.25, 0.75) is good exposure. [0.75, 1] is over exposure. [0, 0.3) is low noise level. [0.3, 0.7) is medium noise level. [0.7, 1] is high noise level.
Value *float64 `json:"value,omitempty"`
}
// Occlusion properties describing occlusions on a given face.
type Occlusion struct {
// ForeheadOccluded - A boolean value indicating whether forehead is occluded.
ForeheadOccluded *bool `json:"foreheadOccluded,omitempty"`
// EyeOccluded - A boolean value indicating whether eyes are occluded.
EyeOccluded *bool `json:"eyeOccluded,omitempty"`
// MouthOccluded - A boolean value indicating whether the mouth is occluded.
MouthOccluded *bool `json:"mouthOccluded,omitempty"`
}
// OperationStatus operation status object. Operation refers to the asynchronous backend task including
// taking a snapshot and applying a snapshot.
type OperationStatus struct {
autorest.Response `json:"-"`
// Status - Operation status: notstarted, running, succeeded, failed. If the operation is requested and waiting to perform, the status is notstarted. If the operation is ongoing in backend, the status is running. Status succeeded means the operation is completed successfully, specifically for snapshot taking operation, it illustrates the snapshot is well taken and ready to apply, and for snapshot applying operation, it presents the target object has finished creating by the snapshot and ready to be used. Status failed is often caused by editing the source object while taking the snapshot or editing the target object while applying the snapshot before completion, see the field "message" to check the failure reason. Possible values include: 'Notstarted', 'Running', 'Succeeded', 'Failed'
Status OperationStatusType `json:"status,omitempty"`
// CreatedTime - A combined UTC date and time string that describes the time when the operation (take or apply a snapshot) is requested. E.g. 2018-12-25T11:41:02.2331413Z.
CreatedTime *date.Time `json:"createdTime,omitempty"`
// LastActionTime - A combined UTC date and time string that describes the last time the operation (take or apply a snapshot) is actively migrating data. The lastActionTime will keep increasing until the operation finishes. E.g. 2018-12-25T11:51:27.8705696Z.
LastActionTime *date.Time `json:"lastActionTime,omitempty"`
// ResourceLocation - When the operation succeeds successfully, for snapshot taking operation the snapshot id will be included in this field, and for snapshot applying operation, the path to get the target object will be returned in this field.
ResourceLocation *string `json:"resourceLocation,omitempty"`
// Message - Show failure message when operation fails (omitted when operation succeeds).
Message *string `json:"message,omitempty"`
}
// PersistedFace personFace object.
type PersistedFace struct {
autorest.Response `json:"-"`
// PersistedFaceID - The persistedFaceId of the target face, which is persisted and will not expire. Different from faceId created by Face - Detect and will expire in 24 hours after the detection call.
PersistedFaceID *uuid.UUID `json:"persistedFaceId,omitempty"`
// UserData - User-provided data attached to the face. The size limit is 1KB.
UserData *string `json:"userData,omitempty"`
}
// Person person object.
type Person struct {
autorest.Response `json:"-"`
// PersonID - PersonId of the target face list.
PersonID *uuid.UUID `json:"personId,omitempty"`
// PersistedFaceIds - PersistedFaceIds of registered faces in the person. These persistedFaceIds are returned from Person - Add a Person Face, and will not expire.
PersistedFaceIds *[]uuid.UUID `json:"persistedFaceIds,omitempty"`
// Name - User defined name, maximum length is 128.
Name *string `json:"name,omitempty"`
// UserData - User specified data. Length should not exceed 16KB.
UserData *string `json:"userData,omitempty"`
}
// PersonGroup person group object.
type PersonGroup struct {
autorest.Response `json:"-"`
// PersonGroupID - PersonGroupId of the target person group.
PersonGroupID *string `json:"personGroupId,omitempty"`
// RecognitionModel - Possible values include: 'Recognition01', 'Recognition02', 'Recognition03'
RecognitionModel RecognitionModel `json:"recognitionModel,omitempty"`
// Name - User defined name, maximum length is 128.
Name *string `json:"name,omitempty"`
// UserData - User specified data. Length should not exceed 16KB.
UserData *string `json:"userData,omitempty"`
}
// Rectangle a rectangle within which a face can be found
type Rectangle struct {
// Width - The width of the rectangle, in pixels.
Width *int32 `json:"width,omitempty"`
// Height - The height of the rectangle, in pixels.
Height *int32 `json:"height,omitempty"`
// Left - The distance from the left edge if the image to the left edge of the rectangle, in pixels.
Left *int32 `json:"left,omitempty"`
// Top - The distance from the top edge if the image to the top edge of the rectangle, in pixels.
Top *int32 `json:"top,omitempty"`
}
// SimilarFace response body for find similar face operation.
type SimilarFace struct {
// FaceID - FaceId of candidate face when find by faceIds. faceId is created by Face - Detect and will expire 24 hours after the detection call
FaceID *uuid.UUID `json:"faceId,omitempty"`
// PersistedFaceID - PersistedFaceId of candidate face when find by faceListId. persistedFaceId in face list is persisted and will not expire. As showed in below response
PersistedFaceID *uuid.UUID `json:"persistedFaceId,omitempty"`
// Confidence - Similarity confidence of the candidate face. The higher confidence, the more similar. Range between [0,1].
Confidence *float64 `json:"confidence,omitempty"`
}
// Snapshot snapshot object.
type Snapshot struct {
autorest.Response `json:"-"`
// ID - Snapshot id.
ID *uuid.UUID `json:"id,omitempty"`
// Account - Azure Cognitive Service Face account id of the subscriber who created the snapshot by Snapshot - Take.
Account *string `json:"account,omitempty"`
// Type - Type of the source object in the snapshot, specified by the subscriber who created the snapshot when calling Snapshot - Take. Currently FaceList, PersonGroup, LargeFaceList and LargePersonGroup are supported. Possible values include: 'SnapshotObjectTypeFaceList', 'SnapshotObjectTypeLargeFaceList', 'SnapshotObjectTypeLargePersonGroup', 'SnapshotObjectTypePersonGroup'
Type SnapshotObjectType `json:"type,omitempty"`
// ApplyScope - Array of the target Face subscription ids for the snapshot, specified by the user who created the snapshot when calling Snapshot - Take. For each snapshot, only subscriptions included in the applyScope of Snapshot - Take can apply it.
ApplyScope *[]uuid.UUID `json:"applyScope,omitempty"`
// UserData - User specified data about the snapshot for any purpose. Length should not exceed 16KB.
UserData *string `json:"userData,omitempty"`
// CreatedTime - A combined UTC date and time string that describes the created time of the snapshot. E.g. 2018-12-25T11:41:02.2331413Z.
CreatedTime *date.Time `json:"createdTime,omitempty"`
// LastUpdateTime - A combined UTC date and time string that describes the last time when the snapshot was created or updated by Snapshot - Update. E.g. 2018-12-25T11:51:27.8705696Z.
LastUpdateTime *date.Time `json:"lastUpdateTime,omitempty"`
}
// TakeSnapshotRequest request body for taking snapshot operation.
type TakeSnapshotRequest struct {
// Type - User specified type for the source object to take snapshot from. Currently FaceList, PersonGroup, LargeFaceList and LargePersonGroup are supported. Possible values include: 'SnapshotObjectTypeFaceList', 'SnapshotObjectTypeLargeFaceList', 'SnapshotObjectTypeLargePersonGroup', 'SnapshotObjectTypePersonGroup'
Type SnapshotObjectType `json:"type,omitempty"`
// ObjectID - User specified source object id to take snapshot from.
ObjectID *string `json:"objectId,omitempty"`
// ApplyScope - User specified array of target Face subscription ids for the snapshot. For each snapshot, only subscriptions included in the applyScope of Snapshot - Take can apply it.
ApplyScope *[]uuid.UUID `json:"applyScope,omitempty"`
// UserData - User specified data about the snapshot for any purpose. Length should not exceed 16KB.
UserData *string `json:"userData,omitempty"`
}
// TrainingStatus training status object.
type TrainingStatus struct {
autorest.Response `json:"-"`
// Status - Training status: notstarted, running, succeeded, failed. If the training process is waiting to perform, the status is notstarted. If the training is ongoing, the status is running. Status succeed means this person group or large person group is ready for Face - Identify, or this large face list is ready for Face - Find Similar. Status failed is often caused by no person or no persisted face exist in the person group or large person group, or no persisted face exist in the large face list. Possible values include: 'TrainingStatusTypeNonstarted', 'TrainingStatusTypeRunning', 'TrainingStatusTypeSucceeded', 'TrainingStatusTypeFailed'
Status TrainingStatusType `json:"status,omitempty"`
// Created - A combined UTC date and time string that describes the created time of the person group, large person group or large face list.
Created *date.Time `json:"createdDateTime,omitempty"`
// LastAction - A combined UTC date and time string that describes the last modify time of the person group, large person group or large face list, could be null value when the group is not successfully trained.
LastAction *date.Time `json:"lastActionDateTime,omitempty"`
// LastSuccessfulTraining - A combined UTC date and time string that describes the last successful training time of the person group, large person group or large face list.
LastSuccessfulTraining *date.Time `json:"lastSuccessfulTrainingDateTime,omitempty"`
// Message - Show failure message when training failed (omitted when training succeed).
Message *string `json:"message,omitempty"`
}
// UpdateFaceRequest request to update face data.
type UpdateFaceRequest struct {
// UserData - User-provided data attached to the face. The size limit is 1KB.
UserData *string `json:"userData,omitempty"`
}
// UpdateSnapshotRequest request body for updating a snapshot, with a combination of user defined apply
// scope and user specified data.
type UpdateSnapshotRequest struct {
// ApplyScope - Array of the target Face subscription ids for the snapshot, specified by the user who created the snapshot when calling Snapshot - Take. For each snapshot, only subscriptions included in the applyScope of Snapshot - Take can apply it.
ApplyScope *[]uuid.UUID `json:"applyScope,omitempty"`
// UserData - User specified data about the snapshot for any purpose. Length should not exceed 16KB.
UserData *string `json:"userData,omitempty"`
}
// VerifyFaceToFaceRequest request body for face to face verification.
type VerifyFaceToFaceRequest struct {
// FaceID1 - FaceId of the first face, comes from Face - Detect
FaceID1 *uuid.UUID `json:"faceId1,omitempty"`
// FaceID2 - FaceId of the second face, comes from Face - Detect
FaceID2 *uuid.UUID `json:"faceId2,omitempty"`
}
// VerifyFaceToPersonRequest request body for face to person verification.
type VerifyFaceToPersonRequest struct {
// FaceID - FaceId of the face, comes from Face - Detect
FaceID *uuid.UUID `json:"faceId,omitempty"`
// PersonGroupID - Using existing personGroupId and personId for fast loading a specified person. personGroupId is created in PersonGroup - Create. Parameter personGroupId and largePersonGroupId should not be provided at the same time.
PersonGroupID *string `json:"personGroupId,omitempty"`
// LargePersonGroupID - Using existing largePersonGroupId and personId for fast loading a specified person. largePersonGroupId is created in LargePersonGroup - Create. Parameter personGroupId and largePersonGroupId should not be provided at the same time.
LargePersonGroupID *string `json:"largePersonGroupId,omitempty"`
// PersonID - Specify a certain person in a person group or a large person group. personId is created in PersonGroup Person - Create or LargePersonGroup Person - Create.
PersonID *uuid.UUID `json:"personId,omitempty"`
}
// VerifyResult result of the verify operation.
type VerifyResult struct {
autorest.Response `json:"-"`
// IsIdentical - True if the two faces belong to the same person or the face belongs to the person, otherwise false.
IsIdentical *bool `json:"isIdentical,omitempty"`
// Confidence - A number indicates the similarity confidence of whether two faces belong to the same person, or whether the face belongs to the person. By default, isIdentical is set to True if similarity confidence is greater than or equal to 0.5. This is useful for advanced users to override "isIdentical" and fine-tune the result on their own data.
Confidence *float64 `json:"confidence,omitempty"`
}
|