FaceClient class

Extends

Constructors

FaceClient(ServiceClientCredentials, string, msRest.ServiceClientOptions)

Initializes a new instance of the FaceClient class.

Properties

credentials
endpoint
face
faceList
largeFaceList
largePersonGroup
largePersonGroupPerson
personGroup
personGroupPerson
snapshot

Methods

sendOperationRequest(OperationArguments, OperationSpec, ServiceCallback<any>)

Send an HTTP request that is populated using the provided OperationSpec.

sendRequest(RequestPrepareOptions | WebResourceLike)

Send the provided httpRequest.

Constructor Details

FaceClient(ServiceClientCredentials, string, msRest.ServiceClientOptions)

Initializes a new instance of the FaceClient class.

new FaceClient(credentials: ServiceClientCredentials, endpoint: string, options?: msRest.ServiceClientOptions)

Parameters

credentials

ServiceClientCredentials

Subscription credentials which uniquely identify client subscription.

endpoint

string

Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com).

options
msRest.ServiceClientOptions

Property Details

credentials

credentials: ServiceClientCredentials

Property Value

ServiceClientCredentials

endpoint

endpoint: string

Property Value

string

face

face: Face

Property Value

faceList

faceList: FaceListOperations

Property Value

largeFaceList

largeFaceList: LargeFaceListOperations

Property Value

largePersonGroup

largePersonGroup: LargePersonGroupOperations

Property Value

largePersonGroupPerson

largePersonGroupPerson: LargePersonGroupPerson

Property Value

personGroup

personGroup: PersonGroupOperations

Property Value

personGroupPerson

personGroupPerson: PersonGroupPerson

Property Value

snapshot

snapshot: SnapshotOperations

Property Value

Method Details

sendOperationRequest(OperationArguments, OperationSpec, ServiceCallback<any>)

Send an HTTP request that is populated using the provided OperationSpec.

function sendOperationRequest(operationArguments: OperationArguments, operationSpec: OperationSpec, callback?: ServiceCallback<any>)

Parameters

operationArguments

OperationArguments

The arguments that the HTTP request's templated values will be populated from.

operationSpec

OperationSpec

The OperationSpec to use to populate the httpRequest.

callback

ServiceCallback<any>

The callback to call when the response is received.

Returns

Promise<RestResponse>

sendRequest(RequestPrepareOptions | WebResourceLike)

Send the provided httpRequest.

function sendRequest(options: RequestPrepareOptions | WebResourceLike)

Parameters

options

RequestPrepareOptions | WebResourceLike

Returns

Promise<HttpOperationResponse>