Knowledgebase class

Pacchetto:

@azure/cognitiveservices-qnamaker

Classe che rappresenta una Knowledgebase.

Costruttori

Knowledgebase(QnAMakerClientContext)

Creare una Knowledge Base.

Metodi

create(CreateKbDTO, RequestOptionsBase)
create(CreateKbDTO, RequestOptionsBase, ServiceCallback<Operation>)
create(CreateKbDTO, ServiceCallback<Operation>)
deleteMethod(string, RequestOptionsBase)
deleteMethod(string, RequestOptionsBase, ServiceCallback<void>)
deleteMethod(string, ServiceCallback<void>)
download(string, EnvironmentType, KnowledgebaseDownloadOptionalParams)
download(string, EnvironmentType, KnowledgebaseDownloadOptionalParams, ServiceCallback<QnADocumentsDTO>)
download(string, EnvironmentType, ServiceCallback<QnADocumentsDTO>)
generateAnswer(string, QueryDTO, RequestOptionsBase)
generateAnswer(string, QueryDTO, RequestOptionsBase, ServiceCallback<QnASearchResultList>)
generateAnswer(string, QueryDTO, ServiceCallback<QnASearchResultList>)
getDetails(string, RequestOptionsBase)
getDetails(string, RequestOptionsBase, ServiceCallback<KnowledgebaseDTO>)
getDetails(string, ServiceCallback<KnowledgebaseDTO>)
listAll(RequestOptionsBase)
listAll(RequestOptionsBase, ServiceCallback<KnowledgebasesDTO>)
listAll(ServiceCallback<KnowledgebasesDTO>)
publish(string, RequestOptionsBase)
publish(string, RequestOptionsBase, ServiceCallback<void>)
publish(string, ServiceCallback<void>)
replace(string, ReplaceKbDTO, RequestOptionsBase)
replace(string, ReplaceKbDTO, RequestOptionsBase, ServiceCallback<void>)
replace(string, ReplaceKbDTO, ServiceCallback<void>)
train(string, FeedbackRecordsDTO, RequestOptionsBase)
train(string, FeedbackRecordsDTO, RequestOptionsBase, ServiceCallback<void>)
train(string, FeedbackRecordsDTO, ServiceCallback<void>)
update(string, UpdateKbOperationDTO, RequestOptionsBase)
update(string, UpdateKbOperationDTO, RequestOptionsBase, ServiceCallback<Operation>)
update(string, UpdateKbOperationDTO, ServiceCallback<Operation>)

Dettagli costruttore

Knowledgebase(QnAMakerClientContext)

Creare una Knowledge Base.

new Knowledgebase(client: QnAMakerClientContext)

Parametri

client

QnAMakerClientContext

Riferimento al client del servizio.

Dettagli metodo

create(CreateKbDTO, RequestOptionsBase)

function create(createKbPayload: CreateKbDTO, options?: RequestOptionsBase): Promise<KnowledgebaseCreateResponse>

Parametri

createKbPayload

CreateKbDTO

Inserire il corpo della richiesta.

options

RequestOptionsBase

Parametri facoltativi

Restituisce

Promise<KnowledgebaseCreateResponse>

Promise<Models.KnowledgebaseCreateResponse>

create(CreateKbDTO, RequestOptionsBase, ServiceCallback<Operation>)

function create(createKbPayload: CreateKbDTO, options: RequestOptionsBase, callback: ServiceCallback<Operation>)

Parametri

createKbPayload

CreateKbDTO

Inserire il corpo della richiesta.

options

RequestOptionsBase

Parametri facoltativi

callback

ServiceCallback<Operation>

Callback

create(CreateKbDTO, ServiceCallback<Operation>)

function create(createKbPayload: CreateKbDTO, callback: ServiceCallback<Operation>)

Parametri

createKbPayload

CreateKbDTO

Inserire il corpo della richiesta.

callback

ServiceCallback<Operation>

Callback

deleteMethod(string, RequestOptionsBase)

function deleteMethod(kbId: string, options?: RequestOptionsBase): Promise<RestResponse>

Parametri

kbId

string

ID knowledgebase.

options

RequestOptionsBase

Parametri facoltativi

Restituisce

Promise<RestResponse>

Promise<msRest.RestResponse>

deleteMethod(string, RequestOptionsBase, ServiceCallback<void>)

function deleteMethod(kbId: string, options: RequestOptionsBase, callback: ServiceCallback<void>)

Parametri

kbId

string

ID knowledgebase.

options

RequestOptionsBase

Parametri facoltativi

callback

ServiceCallback<void>

Callback

deleteMethod(string, ServiceCallback<void>)

function deleteMethod(kbId: string, callback: ServiceCallback<void>)

Parametri

kbId

string

ID knowledgebase.

callback

ServiceCallback<void>

Callback

download(string, EnvironmentType, KnowledgebaseDownloadOptionalParams)

function download(kbId: string, environment: EnvironmentType, options?: KnowledgebaseDownloadOptionalParams): Promise<KnowledgebaseDownloadResponse>

Parametri

kbId

string

ID knowledgebase.

environment

EnvironmentType

Specifica se l'ambiente è Test o Prod. I valori possibili includono: 'Prod', 'Test'

options

KnowledgebaseDownloadOptionalParams

Parametri facoltativi

Restituisce

Promise<KnowledgebaseDownloadResponse>

Promise<Models.KnowledgebaseDownloadResponse>

download(string, EnvironmentType, KnowledgebaseDownloadOptionalParams, ServiceCallback<QnADocumentsDTO>)

function download(kbId: string, environment: EnvironmentType, options: KnowledgebaseDownloadOptionalParams, callback: ServiceCallback<QnADocumentsDTO>)

Parametri

kbId

string

ID knowledgebase.

environment

EnvironmentType

Specifica se l'ambiente è Test o Prod. I valori possibili includono: 'Prod', 'Test'

options

KnowledgebaseDownloadOptionalParams

Parametri facoltativi

callback

ServiceCallback<QnADocumentsDTO>

Callback

download(string, EnvironmentType, ServiceCallback<QnADocumentsDTO>)

function download(kbId: string, environment: EnvironmentType, callback: ServiceCallback<QnADocumentsDTO>)

Parametri

kbId

string

ID knowledgebase.

environment

EnvironmentType

Specifica se l'ambiente è Test o Prod. I valori possibili includono: 'Prod', 'Test'

callback

ServiceCallback<QnADocumentsDTO>

Callback

generateAnswer(string, QueryDTO, RequestOptionsBase)

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

Parametri

kbId

string

ID knowledgebase.

generateAnswerPayload

QueryDTO

Inserire il corpo della richiesta.

options

RequestOptionsBase

Parametri facoltativi

Restituisce

Promise<KnowledgebaseGenerateAnswerResponse>

Promise<Models.KnowledgebaseGenerateAnswerResponse>

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

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

Parametri

kbId

string

ID knowledgebase.

generateAnswerPayload

QueryDTO

Inserire il corpo della richiesta.

options

RequestOptionsBase

Parametri facoltativi

callback

ServiceCallback<QnASearchResultList>

Callback

generateAnswer(string, QueryDTO, ServiceCallback<QnASearchResultList>)

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

Parametri

kbId

string

ID knowledgebase.

generateAnswerPayload

QueryDTO

Inserire il corpo della richiesta.

callback

ServiceCallback<QnASearchResultList>

Callback

getDetails(string, RequestOptionsBase)

function getDetails(kbId: string, options?: RequestOptionsBase): Promise<KnowledgebaseGetDetailsResponse>

Parametri

kbId

string

ID knowledgebase.

options

RequestOptionsBase

Parametri facoltativi

Restituisce

Promise<KnowledgebaseGetDetailsResponse>

Promise<Models.KnowledgebaseGetDetailsResponse>

getDetails(string, RequestOptionsBase, ServiceCallback<KnowledgebaseDTO>)

function getDetails(kbId: string, options: RequestOptionsBase, callback: ServiceCallback<KnowledgebaseDTO>)

Parametri

kbId

string

ID knowledgebase.

options

RequestOptionsBase

Parametri facoltativi

callback

ServiceCallback<KnowledgebaseDTO>

Callback

getDetails(string, ServiceCallback<KnowledgebaseDTO>)

function getDetails(kbId: string, callback: ServiceCallback<KnowledgebaseDTO>)

Parametri

kbId

string

ID knowledgebase.

callback

ServiceCallback<KnowledgebaseDTO>

Callback

listAll(RequestOptionsBase)

function listAll(options?: RequestOptionsBase): Promise<KnowledgebaseListAllResponse>

Parametri

options

RequestOptionsBase

Parametri facoltativi

Restituisce

Promise<KnowledgebaseListAllResponse>

Promise<Models.KnowledgebaseListAllResponse>

listAll(RequestOptionsBase, ServiceCallback<KnowledgebasesDTO>)

function listAll(options: RequestOptionsBase, callback: ServiceCallback<KnowledgebasesDTO>)

Parametri

options

RequestOptionsBase

Parametri facoltativi

callback

ServiceCallback<KnowledgebasesDTO>

Callback

listAll(ServiceCallback<KnowledgebasesDTO>)

function listAll(callback: ServiceCallback<KnowledgebasesDTO>)

Parametri

callback

ServiceCallback<KnowledgebasesDTO>

Callback

publish(string, RequestOptionsBase)

function publish(kbId: string, options?: RequestOptionsBase): Promise<RestResponse>

Parametri

kbId

string

ID knowledgebase.

options

RequestOptionsBase

Parametri facoltativi

Restituisce

Promise<RestResponse>

Promise<msRest.RestResponse>

publish(string, RequestOptionsBase, ServiceCallback<void>)

function publish(kbId: string, options: RequestOptionsBase, callback: ServiceCallback<void>)

Parametri

kbId

string

ID knowledgebase.

options

RequestOptionsBase

Parametri facoltativi

callback

ServiceCallback<void>

Callback

publish(string, ServiceCallback<void>)

function publish(kbId: string, callback: ServiceCallback<void>)

Parametri

kbId

string

ID knowledgebase.

callback

ServiceCallback<void>

Callback

replace(string, ReplaceKbDTO, RequestOptionsBase)

function replace(kbId: string, replaceKb: ReplaceKbDTO, options?: RequestOptionsBase): Promise<RestResponse>

Parametri

kbId

string

ID knowledgebase.

replaceKb

ReplaceKbDTO

Istanza di ReplaceKbDTO che contiene l'elenco di qnas da caricare

options

RequestOptionsBase

Parametri facoltativi

Restituisce

Promise<RestResponse>

Promise<msRest.RestResponse>

replace(string, ReplaceKbDTO, RequestOptionsBase, ServiceCallback<void>)

function replace(kbId: string, replaceKb: ReplaceKbDTO, options: RequestOptionsBase, callback: ServiceCallback<void>)

Parametri

kbId

string

ID knowledgebase.

replaceKb

ReplaceKbDTO

Istanza di ReplaceKbDTO che contiene l'elenco di qnas da caricare

options

RequestOptionsBase

Parametri facoltativi

callback

ServiceCallback<void>

Callback

replace(string, ReplaceKbDTO, ServiceCallback<void>)

function replace(kbId: string, replaceKb: ReplaceKbDTO, callback: ServiceCallback<void>)

Parametri

kbId

string

ID knowledgebase.

replaceKb

ReplaceKbDTO

Istanza di ReplaceKbDTO che contiene l'elenco di qnas da caricare

callback

ServiceCallback<void>

Callback

train(string, FeedbackRecordsDTO, RequestOptionsBase)

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

Parametri

kbId

string

ID knowledgebase.

trainPayload

FeedbackRecordsDTO

Inserire il corpo della richiesta.

options

RequestOptionsBase

Parametri facoltativi

Restituisce

Promise<RestResponse>

Promise<msRest.RestResponse>

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

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

Parametri

kbId

string

ID knowledgebase.

trainPayload

FeedbackRecordsDTO

Inserire il corpo della richiesta.

options

RequestOptionsBase

Parametri facoltativi

callback

ServiceCallback<void>

Callback

train(string, FeedbackRecordsDTO, ServiceCallback<void>)

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

Parametri

kbId

string

ID knowledgebase.

trainPayload

FeedbackRecordsDTO

Inserire il corpo della richiesta.

callback

ServiceCallback<void>

Callback

update(string, UpdateKbOperationDTO, RequestOptionsBase)

function update(kbId: string, updateKb: UpdateKbOperationDTO, options?: RequestOptionsBase): Promise<KnowledgebaseUpdateResponse>

Parametri

kbId

string

ID knowledgebase.

updateKb

UpdateKbOperationDTO

Inserire il corpo della richiesta.

options

RequestOptionsBase

Parametri facoltativi

Restituisce

Promise<KnowledgebaseUpdateResponse>

Promise<Models.KnowledgebaseUpdateResponse>

update(string, UpdateKbOperationDTO, RequestOptionsBase, ServiceCallback<Operation>)

function update(kbId: string, updateKb: UpdateKbOperationDTO, options: RequestOptionsBase, callback: ServiceCallback<Operation>)

Parametri

kbId

string

ID knowledgebase.

updateKb

UpdateKbOperationDTO

Inserire il corpo della richiesta.

options

RequestOptionsBase

Parametri facoltativi

callback

ServiceCallback<Operation>

Callback

update(string, UpdateKbOperationDTO, ServiceCallback<Operation>)

function update(kbId: string, updateKb: UpdateKbOperationDTO, callback: ServiceCallback<Operation>)

Parametri

kbId

string

ID knowledgebase.

updateKb

UpdateKbOperationDTO

Inserire il corpo della richiesta.

callback

ServiceCallback<Operation>

Callback