@azure-rest/ai-vision-face 1.0.0-alpha.20241030.1 → 1.0.0-alpha.20241031.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +35 -0
- package/LICENSE +21 -0
- package/dist/browser/clientDefinitions.d.ts +401 -380
- package/dist/browser/clientDefinitions.d.ts.map +1 -1
- package/dist/browser/clientDefinitions.js.map +1 -1
- package/dist/browser/faceClient.d.ts +3 -1
- package/dist/browser/faceClient.d.ts.map +1 -1
- package/dist/browser/faceClient.js +4 -3
- package/dist/browser/faceClient.js.map +1 -1
- package/dist/browser/isUnexpected.d.ts +34 -32
- package/dist/browser/isUnexpected.d.ts.map +1 -1
- package/dist/browser/isUnexpected.js +30 -29
- package/dist/browser/isUnexpected.js.map +1 -1
- package/dist/browser/models.d.ts +92 -12
- package/dist/browser/models.d.ts.map +1 -1
- package/dist/browser/models.js.map +1 -1
- package/dist/browser/outputModels.d.ts +253 -161
- package/dist/browser/outputModels.d.ts.map +1 -1
- package/dist/browser/outputModels.js.map +1 -1
- package/dist/browser/parameters.d.ts +326 -297
- package/dist/browser/parameters.d.ts.map +1 -1
- package/dist/browser/parameters.js.map +1 -1
- package/dist/browser/pollingHelper.d.ts +5 -4
- package/dist/browser/pollingHelper.d.ts.map +1 -1
- package/dist/browser/pollingHelper.js +3 -3
- package/dist/browser/pollingHelper.js.map +1 -1
- package/dist/browser/responses.d.ts +573 -539
- package/dist/browser/responses.d.ts.map +1 -1
- package/dist/browser/responses.js.map +1 -1
- package/dist/commonjs/clientDefinitions.d.ts +401 -380
- package/dist/commonjs/clientDefinitions.d.ts.map +1 -1
- package/dist/commonjs/clientDefinitions.js.map +1 -1
- package/dist/commonjs/faceClient.d.ts +3 -1
- package/dist/commonjs/faceClient.d.ts.map +1 -1
- package/dist/commonjs/faceClient.js +4 -3
- package/dist/commonjs/faceClient.js.map +1 -1
- package/dist/commonjs/isUnexpected.d.ts +34 -32
- package/dist/commonjs/isUnexpected.d.ts.map +1 -1
- package/dist/commonjs/isUnexpected.js +30 -29
- package/dist/commonjs/isUnexpected.js.map +1 -1
- package/dist/commonjs/models.d.ts +92 -12
- package/dist/commonjs/models.d.ts.map +1 -1
- package/dist/commonjs/models.js.map +1 -1
- package/dist/commonjs/outputModels.d.ts +253 -161
- package/dist/commonjs/outputModels.d.ts.map +1 -1
- package/dist/commonjs/outputModels.js.map +1 -1
- package/dist/commonjs/parameters.d.ts +326 -297
- package/dist/commonjs/parameters.d.ts.map +1 -1
- package/dist/commonjs/parameters.js.map +1 -1
- package/dist/commonjs/pollingHelper.d.ts +5 -4
- package/dist/commonjs/pollingHelper.d.ts.map +1 -1
- package/dist/commonjs/pollingHelper.js +3 -3
- package/dist/commonjs/pollingHelper.js.map +1 -1
- package/dist/commonjs/responses.d.ts +573 -539
- package/dist/commonjs/responses.d.ts.map +1 -1
- package/dist/commonjs/responses.js.map +1 -1
- package/dist/esm/clientDefinitions.d.ts +401 -380
- package/dist/esm/clientDefinitions.d.ts.map +1 -1
- package/dist/esm/clientDefinitions.js.map +1 -1
- package/dist/esm/faceClient.d.ts +3 -1
- package/dist/esm/faceClient.d.ts.map +1 -1
- package/dist/esm/faceClient.js +4 -3
- package/dist/esm/faceClient.js.map +1 -1
- package/dist/esm/isUnexpected.d.ts +34 -32
- package/dist/esm/isUnexpected.d.ts.map +1 -1
- package/dist/esm/isUnexpected.js +30 -29
- package/dist/esm/isUnexpected.js.map +1 -1
- package/dist/esm/models.d.ts +92 -12
- package/dist/esm/models.d.ts.map +1 -1
- package/dist/esm/models.js.map +1 -1
- package/dist/esm/outputModels.d.ts +253 -161
- package/dist/esm/outputModels.d.ts.map +1 -1
- package/dist/esm/outputModels.js.map +1 -1
- package/dist/esm/parameters.d.ts +326 -297
- package/dist/esm/parameters.d.ts.map +1 -1
- package/dist/esm/parameters.js.map +1 -1
- package/dist/esm/pollingHelper.d.ts +5 -4
- package/dist/esm/pollingHelper.d.ts.map +1 -1
- package/dist/esm/pollingHelper.js +3 -3
- package/dist/esm/pollingHelper.js.map +1 -1
- package/dist/esm/responses.d.ts +573 -539
- package/dist/esm/responses.d.ts.map +1 -1
- package/dist/esm/responses.js.map +1 -1
- package/dist/react-native/clientDefinitions.d.ts +401 -380
- package/dist/react-native/clientDefinitions.d.ts.map +1 -1
- package/dist/react-native/clientDefinitions.js.map +1 -1
- package/dist/react-native/faceClient.d.ts +3 -1
- package/dist/react-native/faceClient.d.ts.map +1 -1
- package/dist/react-native/faceClient.js +4 -3
- package/dist/react-native/faceClient.js.map +1 -1
- package/dist/react-native/isUnexpected.d.ts +34 -32
- package/dist/react-native/isUnexpected.d.ts.map +1 -1
- package/dist/react-native/isUnexpected.js +30 -29
- package/dist/react-native/isUnexpected.js.map +1 -1
- package/dist/react-native/models.d.ts +92 -12
- package/dist/react-native/models.d.ts.map +1 -1
- package/dist/react-native/models.js.map +1 -1
- package/dist/react-native/outputModels.d.ts +253 -161
- package/dist/react-native/outputModels.d.ts.map +1 -1
- package/dist/react-native/outputModels.js.map +1 -1
- package/dist/react-native/parameters.d.ts +326 -297
- package/dist/react-native/parameters.d.ts.map +1 -1
- package/dist/react-native/parameters.js.map +1 -1
- package/dist/react-native/pollingHelper.d.ts +5 -4
- package/dist/react-native/pollingHelper.d.ts.map +1 -1
- package/dist/react-native/pollingHelper.js +3 -3
- package/dist/react-native/pollingHelper.js.map +1 -1
- package/dist/react-native/responses.d.ts +573 -539
- package/dist/react-native/responses.d.ts.map +1 -1
- package/dist/react-native/responses.js.map +1 -1
- package/package.json +39 -33
- package/review/ai-vision-face.api.md +375 -296
package/dist/browser/models.d.ts
CHANGED
|
@@ -1,38 +1,118 @@
|
|
|
1
|
-
/**
|
|
1
|
+
/** Model for creating face collection. */
|
|
2
|
+
export interface CreateCollectionRequest {
|
|
3
|
+
/** User defined name, maximum length is 128. */
|
|
4
|
+
name: string;
|
|
5
|
+
/** Optional user defined data. Length should not exceed 16K. */
|
|
6
|
+
userData?: string;
|
|
7
|
+
/**
|
|
8
|
+
* The 'recognitionModel' associated with this face list. Supported 'recognitionModel' values include 'recognition_01', 'recognition_02, 'recognition_03', and 'recognition_04'. The default value is 'recognition_01'. 'recognition_04' is recommended since its accuracy is improved on faces wearing masks compared with 'recognition_03', and its overall accuracy is improved compared with 'recognition_01' and 'recognition_02'.
|
|
9
|
+
*
|
|
10
|
+
* Possible values: "recognition_01", "recognition_02", "recognition_03", "recognition_04"
|
|
11
|
+
*/
|
|
12
|
+
recognitionModel?: RecognitionModel;
|
|
13
|
+
}
|
|
14
|
+
/** User defined fields for object update. */
|
|
15
|
+
export interface UserDefinedFieldsForUpdate {
|
|
16
|
+
/** User defined name, maximum length is 128. */
|
|
17
|
+
name?: string;
|
|
18
|
+
/** Optional user defined data. Length should not exceed 16K. */
|
|
19
|
+
userData?: string;
|
|
20
|
+
}
|
|
21
|
+
/** Add face from url request. */
|
|
22
|
+
export interface AddFaceFromUrlRequest {
|
|
23
|
+
/** URL of input image. */
|
|
24
|
+
url: string;
|
|
25
|
+
}
|
|
26
|
+
/** User defined data for persisted face. */
|
|
27
|
+
export interface FaceUserData {
|
|
28
|
+
/** User-provided data attached to the face. The length limit is 1K. */
|
|
29
|
+
userData?: string;
|
|
30
|
+
}
|
|
31
|
+
/** User defined fields for object creation. */
|
|
32
|
+
export interface UserDefinedFields {
|
|
33
|
+
/** User defined name, maximum length is 128. */
|
|
34
|
+
name: string;
|
|
35
|
+
/** Optional user defined data. Length should not exceed 16K. */
|
|
36
|
+
userData?: string;
|
|
37
|
+
}
|
|
38
|
+
/** Request model for creating liveness session. */
|
|
2
39
|
export interface CreateLivenessSessionContent {
|
|
3
|
-
/**
|
|
40
|
+
/**
|
|
41
|
+
* Type of liveness mode the client should follow.
|
|
42
|
+
*
|
|
43
|
+
* Possible values: "Passive", "PassiveActive"
|
|
44
|
+
*/
|
|
4
45
|
livenessOperationMode: LivenessOperationMode;
|
|
5
46
|
/** Whether or not to allow a '200 - Success' response body to be sent to the client, which may be undesirable for security reasons. Default is false, clients will receive a '204 - NoContent' empty body response. Regardless of selection, calling Session GetResult will always contain a response body enabling business logic to be implemented. */
|
|
6
47
|
sendResultsToClient?: boolean;
|
|
7
48
|
/** Whether or not to allow client to set their own 'deviceCorrelationId' via the Vision SDK. Default is false, and 'deviceCorrelationId' must be set in this request body. */
|
|
8
49
|
deviceCorrelationIdSetInClient?: boolean;
|
|
50
|
+
/** Whether or not store the session image. */
|
|
51
|
+
enableSessionImage?: boolean;
|
|
52
|
+
/**
|
|
53
|
+
* The model version used for liveness classification. This is an optional parameter, and if this is not specified, then the latest supported model version will be chosen
|
|
54
|
+
*
|
|
55
|
+
* Possible values: "2022-10-15-preview.04", "2023-12-20-preview.06"
|
|
56
|
+
*/
|
|
57
|
+
livenessSingleModalModel?: LivenessModel;
|
|
9
58
|
/** Unique Guid per each end-user device. This is to provide rate limiting and anti-hammering. If 'deviceCorrelationIdSetInClient' is true in this request, this 'deviceCorrelationId' must be null. */
|
|
10
59
|
deviceCorrelationId?: string;
|
|
11
60
|
/** Seconds the session should last for. Range is 60 to 86400 seconds. Default value is 600. */
|
|
12
61
|
authTokenTimeToLiveInSeconds?: number;
|
|
13
62
|
}
|
|
14
|
-
export interface
|
|
63
|
+
export interface CreateLivenessWithVerifySessionMultipartContentParametersPartDescriptor {
|
|
15
64
|
name: "Parameters";
|
|
16
|
-
body:
|
|
65
|
+
body: CreateLivenessWithVerifySessionJsonContent;
|
|
17
66
|
}
|
|
18
|
-
export interface
|
|
67
|
+
export interface CreateLivenessWithVerifySessionMultipartContentVerifyImagePartDescriptor {
|
|
19
68
|
name: "VerifyImage";
|
|
20
69
|
body: string | Uint8Array | ReadableStream<Uint8Array> | NodeJS.ReadableStream | File;
|
|
21
70
|
filename?: string;
|
|
22
71
|
contentType?: string;
|
|
23
72
|
}
|
|
73
|
+
/** Request for creating liveness with verify session. */
|
|
74
|
+
export interface CreateLivenessWithVerifySessionJsonContent {
|
|
75
|
+
/**
|
|
76
|
+
* Type of liveness mode the client should follow.
|
|
77
|
+
*
|
|
78
|
+
* Possible values: "Passive", "PassiveActive"
|
|
79
|
+
*/
|
|
80
|
+
livenessOperationMode: LivenessOperationMode;
|
|
81
|
+
/** Whether or not to allow a '200 - Success' response body to be sent to the client, which may be undesirable for security reasons. Default is false, clients will receive a '204 - NoContent' empty body response. Regardless of selection, calling Session GetResult will always contain a response body enabling business logic to be implemented. */
|
|
82
|
+
sendResultsToClient?: boolean;
|
|
83
|
+
/** Whether or not to allow client to set their own 'deviceCorrelationId' via the Vision SDK. Default is false, and 'deviceCorrelationId' must be set in this request body. */
|
|
84
|
+
deviceCorrelationIdSetInClient?: boolean;
|
|
85
|
+
/** Whether or not store the session image. */
|
|
86
|
+
enableSessionImage?: boolean;
|
|
87
|
+
/**
|
|
88
|
+
* The model version used for liveness classification. This is an optional parameter, and if this is not specified, then the latest supported model version will be chosen
|
|
89
|
+
*
|
|
90
|
+
* Possible values: "2022-10-15-preview.04", "2023-12-20-preview.06"
|
|
91
|
+
*/
|
|
92
|
+
livenessSingleModalModel?: LivenessModel;
|
|
93
|
+
/** Unique Guid per each end-user device. This is to provide rate limiting and anti-hammering. If 'deviceCorrelationIdSetInClient' is true in this request, this 'deviceCorrelationId' must be null. */
|
|
94
|
+
deviceCorrelationId?: string;
|
|
95
|
+
/** Seconds the session should last for. Range is 60 to 86400 seconds. Default value is 600. */
|
|
96
|
+
authTokenTimeToLiveInSeconds?: number;
|
|
97
|
+
/** Whether or not return the verify image hash. */
|
|
98
|
+
returnVerifyImageHash?: boolean;
|
|
99
|
+
/** Threshold for confidence of the face verification. */
|
|
100
|
+
verifyConfidenceThreshold?: number;
|
|
101
|
+
}
|
|
24
102
|
/** Alias for DetectionModel */
|
|
25
|
-
export type DetectionModel = string
|
|
103
|
+
export type DetectionModel = string;
|
|
26
104
|
/** Alias for RecognitionModel */
|
|
27
|
-
export type RecognitionModel = string
|
|
105
|
+
export type RecognitionModel = string;
|
|
28
106
|
/** Alias for FaceAttributeType */
|
|
29
|
-
export type FaceAttributeType = string
|
|
107
|
+
export type FaceAttributeType = string;
|
|
30
108
|
/** Alias for FindSimilarMatchMode */
|
|
31
|
-
export type FindSimilarMatchMode = string
|
|
109
|
+
export type FindSimilarMatchMode = string;
|
|
32
110
|
/** Alias for LivenessOperationMode */
|
|
33
|
-
export type LivenessOperationMode = string
|
|
111
|
+
export type LivenessOperationMode = string;
|
|
112
|
+
/** Alias for LivenessModel */
|
|
113
|
+
export type LivenessModel = string;
|
|
34
114
|
/** Request of liveness with verify session creation. */
|
|
35
|
-
export type
|
|
115
|
+
export type CreateLivenessWithVerifySessionMultipartContent = FormData | Array<CreateLivenessWithVerifySessionMultipartContentParametersPartDescriptor | CreateLivenessWithVerifySessionMultipartContentVerifyImagePartDescriptor>;
|
|
36
116
|
/** API versions for Azure AI Face API. */
|
|
37
|
-
export type Versions = "v1.
|
|
117
|
+
export type Versions = "v1.2-preview.1";
|
|
38
118
|
//# sourceMappingURL=models.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"models.d.ts","sourceRoot":"","sources":["../../src/models.ts"],"names":[],"mappings":"AAGA,6CAA6C;AAC7C,MAAM,WAAW,4BAA4B;IAC3C
|
|
1
|
+
{"version":3,"file":"models.d.ts","sourceRoot":"","sources":["../../src/models.ts"],"names":[],"mappings":"AAGA,0CAA0C;AAC1C,MAAM,WAAW,uBAAuB;IACtC,gDAAgD;IAChD,IAAI,EAAE,MAAM,CAAC;IACb,gEAAgE;IAChE,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;CACrC;AAED,6CAA6C;AAC7C,MAAM,WAAW,0BAA0B;IACzC,gDAAgD;IAChD,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,gEAAgE;IAChE,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,iCAAiC;AACjC,MAAM,WAAW,qBAAqB;IACpC,0BAA0B;IAC1B,GAAG,EAAE,MAAM,CAAC;CACb;AAED,4CAA4C;AAC5C,MAAM,WAAW,YAAY;IAC3B,uEAAuE;IACvE,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,+CAA+C;AAC/C,MAAM,WAAW,iBAAiB;IAChC,gDAAgD;IAChD,IAAI,EAAE,MAAM,CAAC;IACb,gEAAgE;IAChE,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,mDAAmD;AACnD,MAAM,WAAW,4BAA4B;IAC3C;;;;OAIG;IACH,qBAAqB,EAAE,qBAAqB,CAAC;IAC7C,yVAAyV;IACzV,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B,8KAA8K;IAC9K,8BAA8B,CAAC,EAAE,OAAO,CAAC;IACzC,8CAA8C;IAC9C,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B;;;;OAIG;IACH,wBAAwB,CAAC,EAAE,aAAa,CAAC;IACzC,uMAAuM;IACvM,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,+FAA+F;IAC/F,4BAA4B,CAAC,EAAE,MAAM,CAAC;CACvC;AAED,MAAM,WAAW,uEAAuE;IACtF,IAAI,EAAE,YAAY,CAAC;IACnB,IAAI,EAAE,0CAA0C,CAAC;CAClD;AAED,MAAM,WAAW,wEAAwE;IACvF,IAAI,EAAE,aAAa,CAAC;IACpB,IAAI,EAAE,MAAM,GAAG,UAAU,GAAG,cAAc,CAAC,UAAU,CAAC,GAAG,MAAM,CAAC,cAAc,GAAG,IAAI,CAAC;IACtF,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,yDAAyD;AACzD,MAAM,WAAW,0CAA0C;IACzD;;;;OAIG;IACH,qBAAqB,EAAE,qBAAqB,CAAC;IAC7C,yVAAyV;IACzV,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B,8KAA8K;IAC9K,8BAA8B,CAAC,EAAE,OAAO,CAAC;IACzC,8CAA8C;IAC9C,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B;;;;OAIG;IACH,wBAAwB,CAAC,EAAE,aAAa,CAAC;IACzC,uMAAuM;IACvM,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,+FAA+F;IAC/F,4BAA4B,CAAC,EAAE,MAAM,CAAC;IACtC,mDAAmD;IACnD,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC,yDAAyD;IACzD,yBAAyB,CAAC,EAAE,MAAM,CAAC;CACpC;AAED,+BAA+B;AAC/B,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC;AACpC,iCAAiC;AACjC,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC;AACtC,kCAAkC;AAClC,MAAM,MAAM,iBAAiB,GAAG,MAAM,CAAC;AACvC,qCAAqC;AACrC,MAAM,MAAM,oBAAoB,GAAG,MAAM,CAAC;AAC1C,sCAAsC;AACtC,MAAM,MAAM,qBAAqB,GAAG,MAAM,CAAC;AAC3C,8BAA8B;AAC9B,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC;AACnC,wDAAwD;AACxD,MAAM,MAAM,+CAA+C,GACvD,QAAQ,GACR,KAAK,CACD,uEAAuE,GACvE,wEAAwE,CAC3E,CAAC;AACN,0CAA0C;AAC1C,MAAM,MAAM,QAAQ,GAAG,gBAAgB,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"models.js","sourceRoot":"","sources":["../../src/models.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\n/** Request for creating liveness session. */\nexport interface CreateLivenessSessionContent {\n
|
|
1
|
+
{"version":3,"file":"models.js","sourceRoot":"","sources":["../../src/models.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\n/** Model for creating face collection. */\nexport interface CreateCollectionRequest {\n /** User defined name, maximum length is 128. */\n name: string;\n /** Optional user defined data. Length should not exceed 16K. */\n userData?: string;\n /**\n * The 'recognitionModel' associated with this face list. Supported 'recognitionModel' values include 'recognition_01', 'recognition_02, 'recognition_03', and 'recognition_04'. The default value is 'recognition_01'. 'recognition_04' is recommended since its accuracy is improved on faces wearing masks compared with 'recognition_03', and its overall accuracy is improved compared with 'recognition_01' and 'recognition_02'.\n *\n * Possible values: \"recognition_01\", \"recognition_02\", \"recognition_03\", \"recognition_04\"\n */\n recognitionModel?: RecognitionModel;\n}\n\n/** User defined fields for object update. */\nexport interface UserDefinedFieldsForUpdate {\n /** User defined name, maximum length is 128. */\n name?: string;\n /** Optional user defined data. Length should not exceed 16K. */\n userData?: string;\n}\n\n/** Add face from url request. */\nexport interface AddFaceFromUrlRequest {\n /** URL of input image. */\n url: string;\n}\n\n/** User defined data for persisted face. */\nexport interface FaceUserData {\n /** User-provided data attached to the face. The length limit is 1K. */\n userData?: string;\n}\n\n/** User defined fields for object creation. */\nexport interface UserDefinedFields {\n /** User defined name, maximum length is 128. */\n name: string;\n /** Optional user defined data. Length should not exceed 16K. */\n userData?: string;\n}\n\n/** Request model for creating liveness session. */\nexport interface CreateLivenessSessionContent {\n /**\n * Type of liveness mode the client should follow.\n *\n * Possible values: \"Passive\", \"PassiveActive\"\n */\n livenessOperationMode: LivenessOperationMode;\n /** Whether or not to allow a '200 - Success' response body to be sent to the client, which may be undesirable for security reasons. Default is false, clients will receive a '204 - NoContent' empty body response. Regardless of selection, calling Session GetResult will always contain a response body enabling business logic to be implemented. */\n sendResultsToClient?: boolean;\n /** Whether or not to allow client to set their own 'deviceCorrelationId' via the Vision SDK. Default is false, and 'deviceCorrelationId' must be set in this request body. */\n deviceCorrelationIdSetInClient?: boolean;\n /** Whether or not store the session image. */\n enableSessionImage?: boolean;\n /**\n * The model version used for liveness classification. This is an optional parameter, and if this is not specified, then the latest supported model version will be chosen\n *\n * Possible values: \"2022-10-15-preview.04\", \"2023-12-20-preview.06\"\n */\n livenessSingleModalModel?: LivenessModel;\n /** Unique Guid per each end-user device. This is to provide rate limiting and anti-hammering. If 'deviceCorrelationIdSetInClient' is true in this request, this 'deviceCorrelationId' must be null. */\n deviceCorrelationId?: string;\n /** Seconds the session should last for. Range is 60 to 86400 seconds. Default value is 600. */\n authTokenTimeToLiveInSeconds?: number;\n}\n\nexport interface CreateLivenessWithVerifySessionMultipartContentParametersPartDescriptor {\n name: \"Parameters\";\n body: CreateLivenessWithVerifySessionJsonContent;\n}\n\nexport interface CreateLivenessWithVerifySessionMultipartContentVerifyImagePartDescriptor {\n name: \"VerifyImage\";\n body: string | Uint8Array | ReadableStream<Uint8Array> | NodeJS.ReadableStream | File;\n filename?: string;\n contentType?: string;\n}\n\n/** Request for creating liveness with verify session. */\nexport interface CreateLivenessWithVerifySessionJsonContent {\n /**\n * Type of liveness mode the client should follow.\n *\n * Possible values: \"Passive\", \"PassiveActive\"\n */\n livenessOperationMode: LivenessOperationMode;\n /** Whether or not to allow a '200 - Success' response body to be sent to the client, which may be undesirable for security reasons. Default is false, clients will receive a '204 - NoContent' empty body response. Regardless of selection, calling Session GetResult will always contain a response body enabling business logic to be implemented. */\n sendResultsToClient?: boolean;\n /** Whether or not to allow client to set their own 'deviceCorrelationId' via the Vision SDK. Default is false, and 'deviceCorrelationId' must be set in this request body. */\n deviceCorrelationIdSetInClient?: boolean;\n /** Whether or not store the session image. */\n enableSessionImage?: boolean;\n /**\n * The model version used for liveness classification. This is an optional parameter, and if this is not specified, then the latest supported model version will be chosen\n *\n * Possible values: \"2022-10-15-preview.04\", \"2023-12-20-preview.06\"\n */\n livenessSingleModalModel?: LivenessModel;\n /** Unique Guid per each end-user device. This is to provide rate limiting and anti-hammering. If 'deviceCorrelationIdSetInClient' is true in this request, this 'deviceCorrelationId' must be null. */\n deviceCorrelationId?: string;\n /** Seconds the session should last for. Range is 60 to 86400 seconds. Default value is 600. */\n authTokenTimeToLiveInSeconds?: number;\n /** Whether or not return the verify image hash. */\n returnVerifyImageHash?: boolean;\n /** Threshold for confidence of the face verification. */\n verifyConfidenceThreshold?: number;\n}\n\n/** Alias for DetectionModel */\nexport type DetectionModel = string;\n/** Alias for RecognitionModel */\nexport type RecognitionModel = string;\n/** Alias for FaceAttributeType */\nexport type FaceAttributeType = string;\n/** Alias for FindSimilarMatchMode */\nexport type FindSimilarMatchMode = string;\n/** Alias for LivenessOperationMode */\nexport type LivenessOperationMode = string;\n/** Alias for LivenessModel */\nexport type LivenessModel = string;\n/** Request of liveness with verify session creation. */\nexport type CreateLivenessWithVerifySessionMultipartContent =\n | FormData\n | Array<\n | CreateLivenessWithVerifySessionMultipartContentParametersPartDescriptor\n | CreateLivenessWithVerifySessionMultipartContentVerifyImagePartDescriptor\n >;\n/** API versions for Azure AI Face API. */\nexport type Versions = \"v1.2-preview.1\";\n"]}
|