AutoSuggestClient class

Package:

@azure/cognitiveservices-autosuggest

Extends

AutoSuggestClientContext

Constructors

AutoSuggestClient(ServiceClientCredentials, AutoSuggestClientOptions)

Initializes a new instance of the AutoSuggestClient class.

Inherited Properties

credentials
endpoint

Methods

autoSuggest(string, AutoSuggestClientAutoSuggestOptionalParams)
autoSuggest(string, AutoSuggestClientAutoSuggestOptionalParams, ServiceCallback<Suggestions>)
autoSuggest(string, ServiceCallback<Suggestions>)

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

AutoSuggestClient(ServiceClientCredentials, AutoSuggestClientOptions)

Initializes a new instance of the AutoSuggestClient class.

new AutoSuggestClient(credentials: ServiceClientCredentials, options?: AutoSuggestClientOptions)

Parameters

credentials

ServiceClientCredentials

Subscription credentials which uniquely identify client subscription.

options

AutoSuggestClientOptions

The parameter options

Inherited Property Details

credentials

credentials: ServiceClientCredentials

Property Value

ServiceClientCredentials

Inherited From AutoSuggestClientContext.credentials

endpoint

endpoint?: string

Property Value

string

Inherited From AutoSuggestClientContext.endpoint

Method Details

autoSuggest(string, AutoSuggestClientAutoSuggestOptionalParams)

function autoSuggest(query: string, options?: AutoSuggestClientAutoSuggestOptionalParams): Promise<AutoSuggestResponse>

Parameters

query

string

The user's search term.

options

AutoSuggestClientAutoSuggestOptionalParams

The optional parameters

Returns

Promise<AutoSuggestResponse>

Promise<Models.AutoSuggestResponse>

autoSuggest(string, AutoSuggestClientAutoSuggestOptionalParams, ServiceCallback<Suggestions>)

function autoSuggest(query: string, options: AutoSuggestClientAutoSuggestOptionalParams, callback: ServiceCallback<Suggestions>)

Parameters

query

string

The user's search term.

options

AutoSuggestClientAutoSuggestOptionalParams

The optional parameters

callback

ServiceCallback<Suggestions>

The callback

autoSuggest(string, ServiceCallback<Suggestions>)

function autoSuggest(query: string, callback: ServiceCallback<Suggestions>)

Parameters

query

string

The user's search term.

callback

ServiceCallback<Suggestions>

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>

Inherited From AutoSuggestClientContext.sendOperationRequest

sendRequest(RequestPrepareOptions | WebResourceLike)

Send the provided httpRequest.

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

Parameters

options

RequestPrepareOptions | WebResourceLike

Returns

Promise<HttpOperationResponse>

Inherited From AutoSuggestClientContext.sendRequest