Package com.microsoft.azure.cognitiveservices.knowledge.qnamaker.models

This package contains the models classes for QnAMakerClient. An API for QnAMaker Service.

Class Summary

Class	Description
ActiveLearningSettingsDTO	Active Learning settings of the endpoint.
AlterationsDTO	Collection of words that are synonyms.
AnswerSpanRequestDTO	To configure Answer span prediction feature.
AnswerSpanResponseDTO	Answer span object of QnA.
ContextDTO	Context associated with Qna.
CreateKbDTO	Post body schema for CreateKb operation.
CreateKbInputDTO	Input to create KB.
DeleteKbContentsDTO	PATCH body schema of Delete Operation in UpdateKb.
DownloadOptionalParameter	The DownloadOptionalParameter model.
EndpointKeysDTO	Schema for EndpointKeys generate/refresh operations.
EndpointSettingsDTO	Endpoint settings.
EndpointSettingsDTOActiveLearning	Active Learning settings of the endpoint.
EnvironmentType	Defines values for EnvironmentType.
Error	The error object.
ErrorCodeType	Defines values for ErrorCodeType.
ErrorResponse	Error response.
ErrorResponseError	The error object.
FeedbackRecordDTO	Active learning feedback record.
FeedbackRecordsDTO	Active learning feedback records.
FileDTO	DTO to hold details of uploaded files.
InnerErrorModel	An object containing more specific information about the error.
KnowledgebaseDTO	Response schema for CreateKb operation.
KnowledgebasesDTO	Collection of knowledgebases owned by a user.
KnowledgebaseUpdateHeaders	Defines headers for Update operation.
MetadataDTO	Name - value pair of metadata.
Operation	Record to track long running operation.
OperationsGetDetailsHeaders	Defines headers for GetDetails operation.
OperationStateType	Defines values for OperationStateType.
PromptDTO	Prompt for an answer.
PromptDTOQna	QnADTO - Either QnaId or QnADTO needs to be present in a PromptDTO object.
QnADocumentsDTO	List of QnADTO.
QnADTO	Q-A object.
QnADTOContext	Context of a QnA.
QnASearchResult	Represents Search Result.
QnASearchResultAnswerSpan	Answer span object of QnA with respect to user's question.
QnASearchResultContext	Context object of the QnA.
QnASearchResultList	Represents List of Question Answers.
QueryContextDTO	Context object with previous QnA's information.
QueryDTO	POST body schema to query the knowledgebase.
QueryDTOAnswerSpanRequest	To configure Answer span prediction feature.
QueryDTOContext	Context object with previous QnA's information.
ReplaceKbDTO	Post body schema for Replace KB operation.
StrictFiltersCompoundOperationType	Defines values for StrictFiltersCompoundOperationType.
TrainOptionalParameter	The TrainOptionalParameter model.
UpdateContextDTO	Update Body schema to represent context to be updated.
UpdateKbContentsDTO	PATCH body schema for Update operation in Update Kb.
UpdateKbOperationDTO	Contains list of QnAs to be updated.
UpdateKbOperationDTOAdd	An instance of CreateKbInputDTO for add operation.
UpdateKbOperationDTODelete	An instance of DeleteKbContentsDTO for delete Operation.
UpdateKbOperationDTOUpdate	An instance of UpdateKbContentsDTO for Update Operation.
UpdateMetadataDTO	PATCH Body schema to represent list of Metadata to be updated.
UpdateQnaDTO	PATCH Body schema for Update Qna List.
UpdateQnaDTOContext	Context associated with Qna to be updated.
UpdateQnaDTOMetadata	List of metadata associated with the answer to be updated.
UpdateQnaDTOQuestions	List of questions associated with the answer.
UpdateQuestionsDTO	PATCH Body schema for Update Kb which contains list of questions to be added and deleted.
UpdateSettingsOptionalParameter	The UpdateSettingsOptionalParameter model.
WordAlterationsDTO	Collection of word alterations.

Exception Summary

Exception	Description
ErrorResponseException	Exception thrown for an invalid response with ErrorResponse information.