FormRecognizerClientContext class

Package:

@azure/cognitiveservices-formrecognizer

Extends

ServiceClient

Constructors

FormRecognizerClientContext(ServiceClientCredentials, string, ServiceClientOptions)

Initializes a new instance of the FormRecognizerClientContext class.

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

FormRecognizerClientContext(ServiceClientCredentials, string, ServiceClientOptions)

Initializes a new instance of the FormRecognizerClientContext class.

new FormRecognizerClientContext(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://westus2.api.cognitive.microsoft.com).

options

ServiceClientOptions

The parameter options

Property Details

credentials

credentials: ServiceClientCredentials

Property Value

ServiceClientCredentials

endpoint

endpoint: string

Property Value

string

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 msRest.ServiceClient.sendOperationRequest

sendRequest(RequestPrepareOptions | WebResourceLike)

Send the provided httpRequest.

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

Parameters

options

RequestPrepareOptions | WebResourceLike

Returns

Promise<HttpOperationResponse>

Inherited From msRest.ServiceClient.sendRequest