FaceClient class

Package:

@azure/cognitiveservices-face

Extends

FaceClientContext

Constructors

FaceClient(ServiceClientCredentials, string, ServiceClientOptions)

Initializes a new instance of the FaceClient class.

Properties

face
faceList
largeFaceList
largePersonGroup
largePersonGroupPerson
personGroup
personGroupPerson
snapshot

Inherited Properties

credentials
endpoint

Inherited 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, ServiceClientOptions)

Initializes a new instance of the FaceClient class.

new FaceClient(credentials: ServiceClientCredentials, endpoint: string, options?: 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

ServiceClientOptions

The parameter options

Property Details

face

face: Face

Property Value

Face

faceList

faceList: FaceListOperations

Property Value

FaceListOperations

largeFaceList

largeFaceList: LargeFaceListOperations

Property Value

LargeFaceListOperations

largePersonGroup

largePersonGroup: LargePersonGroupOperations

Property Value

LargePersonGroupOperations

largePersonGroupPerson

largePersonGroupPerson: LargePersonGroupPerson

Property Value

LargePersonGroupPerson

personGroup

personGroup: PersonGroupOperations

Property Value

PersonGroupOperations

personGroupPerson

personGroupPerson: PersonGroupPerson

Property Value

PersonGroupPerson

snapshot

snapshot: SnapshotOperations

Property Value

SnapshotOperations

Inherited Property Details

credentials

credentials: ServiceClientCredentials

Property Value

ServiceClientCredentials

Inherited From FaceClientContext.credentials

endpoint

endpoint: string

Property Value

string

Inherited From FaceClientContext.endpoint

Inherited 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>): Promise<RestResponse>

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>

Inherited From FaceClientContext.sendOperationRequest

sendRequest(RequestPrepareOptions | WebResourceLike)

Send the provided httpRequest.

function sendRequest(options: RequestPrepareOptions | WebResourceLike): Promise<HttpOperationResponse>

Parameters

options

RequestPrepareOptions | WebResourceLike

Returns

Promise<HttpOperationResponse>

Inherited From FaceClientContext.sendRequest