تحرير

PersonalizerClient class

  • Reference
Package:
@azure/cognitiveservices-personalizer
Extends
PersonalizerClientContext

Constructors

PersonalizerClient(ServiceClientCredentials, string, msRest.ServiceClientOptions)

Initializes a new instance of the PersonalizerClient class.

Properties

credentials
endpoint
events

Methods

rank(RankRequest, msRest.RequestOptionsBase)
rank(RankRequest, RequestOptionsBase, ServiceCallback<RankResponse>)
rank(RankRequest, ServiceCallback<RankResponse>)

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

PersonalizerClient(ServiceClientCredentials, string, msRest.ServiceClientOptions)

Initializes a new instance of the PersonalizerClient class.

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

Parameters

credentials

ServiceClientCredentials

Subscription credentials which uniquely identify client subscription.

endpoint

string

Supported Cognitive Services endpoint.

options
msRest.ServiceClientOptions

Property Details

credentials 

credentials: ServiceClientCredentials

Property Value

ServiceClientCredentials

endpoint 

endpoint: string

Property Value

string

events 

events: Events

Property Value

Events

Method Details

rank(RankRequest, msRest.RequestOptionsBase) 

function rank(rankRequest: RankRequest, options?: msRest.RequestOptionsBase): Promise<Models.RankResponse2>

Parameters

rankRequest
RankRequest

A Personalizer request.

options
msRest.RequestOptionsBase

Returns

Promise<Models.RankResponse2>

Promise<Models.RankResponse2>

rank(RankRequest, RequestOptionsBase, ServiceCallback<RankResponse>) 

function rank(rankRequest: RankRequest, options: RequestOptionsBase, callback: ServiceCallback<RankResponse>)

Parameters

rankRequest
RankRequest

A Personalizer request.

options

RequestOptionsBase

The optional parameters

callback

ServiceCallback<RankResponse>

The callback

rank(RankRequest, ServiceCallback<RankResponse>) 

function rank(rankRequest: RankRequest, callback: ServiceCallback<RankResponse>)

Parameters

rankRequest
RankRequest

A Personalizer request.

callback

ServiceCallback<RankResponse>

The callback

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>

sendRequest(RequestPrepareOptions | WebResourceLike)

Send the provided httpRequest.

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

Parameters

options

RequestPrepareOptions | WebResourceLike

Returns

Promise<HttpOperationResponse>