@azure/cognitiveservices-qnamaker package
Classes
| Alterations |
Class representing a Alterations. |
| EndpointKeys |
Class representing a EndpointKeys. |
| EndpointSettings |
Class representing a EndpointSettings. |
| Knowledgebase |
Class representing a Knowledgebase. |
| Operations |
Class representing a Operations. |
| QnAMakerClient | |
| QnAMakerClientContext | |
Interfaces
| 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 |
| EndpointKeysDTO |
Schema for EndpointKeys generate/refresh operations. |
| EndpointSettingsDTO |
Endpoint settings. |
| EndpointSettingsDTOActiveLearning |
Active Learning settings of the endpoint. |
| ErrorModel |
The error object. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses. |
| ErrorResponse |
Error response. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses. |
| 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. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses. |
| KnowledgebaseDownloadOptionalParams |
Optional Parameters. |
| 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. |
| 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. |
| 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 |
| WordAlterationsDTO |
Collection of word alterations. |
Type Aliases
| AlterationsGetAlterationsForKbResponse |
Contains response data for the getAlterationsForKb operation. |
| AlterationsGetResponse |
Contains response data for the get operation. |
| EndpointKeysGetKeysResponse |
Contains response data for the getKeys operation. |
| EndpointKeysRefreshKeysResponse |
Contains response data for the refreshKeys operation. |
| EndpointSettingsGetSettingsResponse |
Contains response data for the getSettings operation. |
| EnvironmentType |
Defines values for EnvironmentType. Possible values include: 'Prod', 'Test' |
| ErrorCodeType |
Defines values for ErrorCodeType. Possible values include: 'BadArgument', 'Forbidden', 'NotFound', 'KbNotFound', 'Unauthorized', 'Unspecified', 'EndpointKeysError', 'QuotaExceeded', 'QnaRuntimeError', 'SKULimitExceeded', 'OperationNotFound', 'ServiceError', 'ValidationFailure', 'ExtractionFailure' |
| KnowledgebaseCreateResponse |
Contains response data for the create operation. |
| KnowledgebaseDownloadResponse |
Contains response data for the download operation. |
| KnowledgebaseGenerateAnswerResponse |
Contains response data for the generateAnswer operation. |
| KnowledgebaseGetDetailsResponse |
Contains response data for the getDetails operation. |
| KnowledgebaseListAllResponse |
Contains response data for the listAll operation. |
| KnowledgebaseUpdateResponse |
Contains response data for the update operation. |
| OperationsGetDetailsResponse |
Contains response data for the getDetails operation. |
| OperationStateType |
Defines values for OperationStateType. Possible values include: 'Failed', 'NotStarted', 'Running', 'Succeeded' |
| StrictFiltersCompoundOperationType |
Defines values for StrictFiltersCompoundOperationType. Possible values include: 'AND', 'OR' |