Runtime class

Package:

@azure/cognitiveservices-qnamaker-runtime

Class representing a Runtime.

Constructors

Runtime(QnAMakerRuntimeClientContext)

Create a Runtime.

Methods

generateAnswer(string, QueryDTO, RequestOptionsBase)
generateAnswer(string, QueryDTO, RequestOptionsBase, ServiceCallback<QnASearchResultList>)
generateAnswer(string, QueryDTO, ServiceCallback<QnASearchResultList>)
train(string, FeedbackRecordsDTO, RequestOptionsBase)
train(string, FeedbackRecordsDTO, RequestOptionsBase, ServiceCallback<void>)
train(string, FeedbackRecordsDTO, ServiceCallback<void>)

Constructor Details

Runtime(QnAMakerRuntimeClientContext)

Create a Runtime.

new Runtime(client: QnAMakerRuntimeClientContext)

Parameters

client

QnAMakerRuntimeClientContext

Reference to the service client.

Method Details

generateAnswer(string, QueryDTO, RequestOptionsBase)

function generateAnswer(kbId: string, generateAnswerPayload: QueryDTO, options?: RequestOptionsBase): Promise<RuntimeGenerateAnswerResponse>

Parameters

kbId

string

Knowledgebase id.

generateAnswerPayload

QueryDTO

Post body of the request.

options

RequestOptionsBase

The optional parameters

Returns

Promise<RuntimeGenerateAnswerResponse>

Promise<Models.RuntimeGenerateAnswerResponse>

generateAnswer(string, QueryDTO, RequestOptionsBase, ServiceCallback<QnASearchResultList>)

function generateAnswer(kbId: string, generateAnswerPayload: QueryDTO, options: RequestOptionsBase, callback: ServiceCallback<QnASearchResultList>)

Parameters

kbId

string

Knowledgebase id.

generateAnswerPayload

QueryDTO

Post body of the request.

options

RequestOptionsBase

The optional parameters

callback

ServiceCallback<QnASearchResultList>

The callback

generateAnswer(string, QueryDTO, ServiceCallback<QnASearchResultList>)

function generateAnswer(kbId: string, generateAnswerPayload: QueryDTO, callback: ServiceCallback<QnASearchResultList>)

Parameters

kbId

string

Knowledgebase id.

generateAnswerPayload

QueryDTO

Post body of the request.

callback

ServiceCallback<QnASearchResultList>

The callback

train(string, FeedbackRecordsDTO, RequestOptionsBase)

function train(kbId: string, trainPayload: FeedbackRecordsDTO, options?: RequestOptionsBase): Promise<RestResponse>

Parameters

kbId

string

Knowledgebase id.

trainPayload

FeedbackRecordsDTO

Post body of the request.

options

RequestOptionsBase

The optional parameters

Returns

Promise<RestResponse>

Promise<msRest.RestResponse>

train(string, FeedbackRecordsDTO, RequestOptionsBase, ServiceCallback<void>)

function train(kbId: string, trainPayload: FeedbackRecordsDTO, options: RequestOptionsBase, callback: ServiceCallback<void>)

Parameters

kbId

string

Knowledgebase id.

trainPayload

FeedbackRecordsDTO

Post body of the request.

options

RequestOptionsBase

The optional parameters

callback

ServiceCallback<void>

The callback

train(string, FeedbackRecordsDTO, ServiceCallback<void>)

function train(kbId: string, trainPayload: FeedbackRecordsDTO, callback: ServiceCallback<void>)

Parameters

kbId

string

Knowledgebase id.

trainPayload

FeedbackRecordsDTO

Post body of the request.

callback

ServiceCallback<void>

The callback