Knowledgebase class

Pacote:

@azure/cognitiveservices-qnamaker

Classe que representa uma Base de Dados de Conhecimento.

Construtores

Knowledgebase(QnAMakerClientContext)

Criar uma Base de Dados de Conhecimento.

Métodos

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>)

Detalhes do Construtor

Knowledgebase(QnAMakerClientContext)

Criar uma Base de Dados de Conhecimento.

new Knowledgebase(client: QnAMakerClientContext)

Parâmetros

client

QnAMakerClientContext

Referência ao cliente de serviço.

Detalhes de Método

create(CreateKbDTO, RequestOptionsBase)

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

Parâmetros

createKbPayload

CreateKbDTO

Corpo da publicação do pedido.

options

RequestOptionsBase

Os parâmetros opcionais

Devoluções

Promise<KnowledgebaseCreateResponse>

Promise<Models.KnowledgebaseCreateResponse>

create(CreateKbDTO, RequestOptionsBase, ServiceCallback<Operation>)

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

Parâmetros

createKbPayload

CreateKbDTO

Corpo da publicação do pedido.

options

RequestOptionsBase

Os parâmetros opcionais

callback

ServiceCallback<Operation>

A chamada de retorno

create(CreateKbDTO, ServiceCallback<Operation>)

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

Parâmetros

createKbPayload

CreateKbDTO

Corpo da publicação do pedido.

callback

ServiceCallback<Operation>

A chamada de retorno

deleteMethod(string, RequestOptionsBase)

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

Parâmetros

kbId

string

ID da base de dados de conhecimento.

options

RequestOptionsBase

Os parâmetros opcionais

Devoluções

Promise<RestResponse>

Promise<msRest.RestResponse>

deleteMethod(string, RequestOptionsBase, ServiceCallback<void>)

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

Parâmetros

kbId

string

ID da base de dados de conhecimento.

options

RequestOptionsBase

Os parâmetros opcionais

callback

ServiceCallback<void>

A chamada de retorno

deleteMethod(string, ServiceCallback<void>)

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

Parâmetros

kbId

string

ID da base de dados de conhecimento.

callback

ServiceCallback<void>

A chamada de retorno

download(string, EnvironmentType, KnowledgebaseDownloadOptionalParams)

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

Parâmetros

kbId

string

ID da base de dados de conhecimento.

environment

EnvironmentType

Especifica se o ambiente é Test ou Prod. Os valores possíveis incluem: "Prod", "Test"

options

KnowledgebaseDownloadOptionalParams

Os parâmetros opcionais

Devoluções

Promise<KnowledgebaseDownloadResponse>

Promise<Models.KnowledgebaseDownloadResponse>

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

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

Parâmetros

kbId

string

ID da base de dados de conhecimento.

environment

EnvironmentType

Especifica se o ambiente é Test ou Prod. Os valores possíveis incluem: "Prod", "Test"

options

KnowledgebaseDownloadOptionalParams

Os parâmetros opcionais

callback

ServiceCallback<QnADocumentsDTO>

A chamada de retorno

download(string, EnvironmentType, ServiceCallback<QnADocumentsDTO>)

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

Parâmetros

kbId

string

ID da base de dados de conhecimento.

environment

EnvironmentType

Especifica se o ambiente é Test ou Prod. Os valores possíveis incluem: "Prod", "Test"

callback

ServiceCallback<QnADocumentsDTO>

A chamada de retorno

generateAnswer(string, QueryDTO, RequestOptionsBase)

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

Parâmetros

kbId

string

ID da base de dados de conhecimento.

generateAnswerPayload

QueryDTO

Corpo da publicação do pedido.

options

RequestOptionsBase

Os parâmetros opcionais

Devoluções

Promise<KnowledgebaseGenerateAnswerResponse>

Promise<Models.KnowledgebaseGenerateAnswerResponse>

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

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

Parâmetros

kbId

string

ID da base de dados de conhecimento.

generateAnswerPayload

QueryDTO

Corpo da publicação do pedido.

options

RequestOptionsBase

Os parâmetros opcionais

callback

ServiceCallback<QnASearchResultList>

A chamada de retorno

generateAnswer(string, QueryDTO, ServiceCallback<QnASearchResultList>)

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

Parâmetros

kbId

string

ID da base de dados de conhecimento.

generateAnswerPayload

QueryDTO

Corpo da publicação do pedido.

callback

ServiceCallback<QnASearchResultList>

A chamada de retorno

getDetails(string, RequestOptionsBase)

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

Parâmetros

kbId

string

ID da base de dados de conhecimento.

options

RequestOptionsBase

Os parâmetros opcionais

Devoluções

Promise<KnowledgebaseGetDetailsResponse>

Promise<Models.KnowledgebaseGetDetailsResponse>

getDetails(string, RequestOptionsBase, ServiceCallback<KnowledgebaseDTO>)

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

Parâmetros

kbId

string

ID da base de dados de conhecimento.

options

RequestOptionsBase

Os parâmetros opcionais

callback

ServiceCallback<KnowledgebaseDTO>

A chamada de retorno

getDetails(string, ServiceCallback<KnowledgebaseDTO>)

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

Parâmetros

kbId

string

ID da base de dados de conhecimento.

callback

ServiceCallback<KnowledgebaseDTO>

A chamada de retorno

listAll(RequestOptionsBase)

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

Parâmetros

options

RequestOptionsBase

Os parâmetros opcionais

Devoluções

Promise<KnowledgebaseListAllResponse>

Promise<Models.KnowledgebaseListAllResponse>

listAll(RequestOptionsBase, ServiceCallback<KnowledgebasesDTO>)

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

Parâmetros

options

RequestOptionsBase

Os parâmetros opcionais

callback

ServiceCallback<KnowledgebasesDTO>

A chamada de retorno

listAll(ServiceCallback<KnowledgebasesDTO>)

function listAll(callback: ServiceCallback<KnowledgebasesDTO>)

Parâmetros

callback

ServiceCallback<KnowledgebasesDTO>

A chamada de retorno

publish(string, RequestOptionsBase)

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

Parâmetros

kbId

string

ID da base de dados de conhecimento.

options

RequestOptionsBase

Os parâmetros opcionais

Devoluções

Promise<RestResponse>

Promise<msRest.RestResponse>

publish(string, RequestOptionsBase, ServiceCallback<void>)

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

Parâmetros

kbId

string

ID da base de dados de conhecimento.

options

RequestOptionsBase

Os parâmetros opcionais

callback

ServiceCallback<void>

A chamada de retorno

publish(string, ServiceCallback<void>)

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

Parâmetros

kbId

string

ID da base de dados de conhecimento.

callback

ServiceCallback<void>

A chamada de retorno

replace(string, ReplaceKbDTO, RequestOptionsBase)

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

Parâmetros

kbId

string

ID da base de dados de conhecimento.

replaceKb

ReplaceKbDTO

Uma instância de ReplaceKbDTO que contém a lista de qnas a carregar

options

RequestOptionsBase

Os parâmetros opcionais

Devoluções

Promise<RestResponse>

Promise<msRest.RestResponse>

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

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

Parâmetros

kbId

string

ID da base de dados de conhecimento.

replaceKb

ReplaceKbDTO

Uma instância de ReplaceKbDTO que contém a lista de qnas a carregar

options

RequestOptionsBase

Os parâmetros opcionais

callback

ServiceCallback<void>

A chamada de retorno

replace(string, ReplaceKbDTO, ServiceCallback<void>)

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

Parâmetros

kbId

string

ID da base de dados de conhecimento.

replaceKb

ReplaceKbDTO

Uma instância de ReplaceKbDTO que contém a lista de qnas a carregar

callback

ServiceCallback<void>

A chamada de retorno

train(string, FeedbackRecordsDTO, RequestOptionsBase)

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

Parâmetros

kbId

string

ID da base de dados de conhecimento.

trainPayload

FeedbackRecordsDTO

Corpo da publicação do pedido.

options

RequestOptionsBase

Os parâmetros opcionais

Devoluções

Promise<RestResponse>

Promise<msRest.RestResponse>

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

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

Parâmetros

kbId

string

ID da base de dados de conhecimento.

trainPayload

FeedbackRecordsDTO

Corpo da publicação do pedido.

options

RequestOptionsBase

Os parâmetros opcionais

callback

ServiceCallback<void>

A chamada de retorno

train(string, FeedbackRecordsDTO, ServiceCallback<void>)

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

Parâmetros

kbId

string

ID da base de dados de conhecimento.

trainPayload

FeedbackRecordsDTO

Corpo da publicação do pedido.

callback

ServiceCallback<void>

A chamada de retorno

update(string, UpdateKbOperationDTO, RequestOptionsBase)

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

Parâmetros

kbId

string

ID da base de dados de conhecimento.

updateKb

UpdateKbOperationDTO

Corpo da publicação do pedido.

options

RequestOptionsBase

Os parâmetros opcionais

Devoluções

Promise<KnowledgebaseUpdateResponse>

Promise<Models.KnowledgebaseUpdateResponse>

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

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

Parâmetros

kbId

string

ID da base de dados de conhecimento.

updateKb

UpdateKbOperationDTO

Corpo da publicação do pedido.

options

RequestOptionsBase

Os parâmetros opcionais

callback

ServiceCallback<Operation>

A chamada de retorno

update(string, UpdateKbOperationDTO, ServiceCallback<Operation>)

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

Parâmetros

kbId

string

ID da base de dados de conhecimento.

updateKb

UpdateKbOperationDTO

Corpo da publicação do pedido.

callback

ServiceCallback<Operation>

A chamada de retorno