models Package

Modules

active_learning_settings_dto
active_learning_settings_dto_py3
alterations_dto
alterations_dto_py3
answer_span_request_dto
answer_span_request_dto_py3
answer_span_response_dto
answer_span_response_dto_py3
context_dto
context_dto_py3
create_kb_dto
create_kb_dto_py3
create_kb_input_dto
create_kb_input_dto_py3
delete_kb_contents_dto
delete_kb_contents_dto_py3
endpoint_keys_dto
endpoint_keys_dto_py3
endpoint_settings_dto
endpoint_settings_dto_active_learning
endpoint_settings_dto_active_learning_py3
endpoint_settings_dto_py3
error
error_py3
error_response
error_response_error
error_response_error_py3
error_response_py3
feedback_record_dto
feedback_record_dto_py3
feedback_records_dto
feedback_records_dto_py3
file_dto
file_dto_py3
inner_error_model
inner_error_model_py3
knowledgebase_dto
knowledgebase_dto_py3
knowledgebases_dto
knowledgebases_dto_py3
metadata_dto
metadata_dto_py3
operation
operation_py3
prompt_dto
prompt_dto_py3
prompt_dto_qna
prompt_dto_qna_py3
qn_adocuments_dto
qn_adocuments_dto_py3
qn_adto
qn_adto_context
qn_adto_context_py3
qn_adto_py3
qn_amaker_client_enums
qn_asearch_result
qn_asearch_result_answer_span
qn_asearch_result_answer_span_py3
qn_asearch_result_context
qn_asearch_result_context_py3
qn_asearch_result_list
qn_asearch_result_list_py3
qn_asearch_result_py3
query_context_dto
query_context_dto_py3
query_dto
query_dto_answer_span_request
query_dto_answer_span_request_py3
query_dto_context
query_dto_context_py3
query_dto_py3
replace_kb_dto
replace_kb_dto_py3
update_context_dto
update_context_dto_py3
update_kb_contents_dto
update_kb_contents_dto_py3
update_kb_operation_dto
update_kb_operation_dto_add
update_kb_operation_dto_add_py3
update_kb_operation_dto_delete
update_kb_operation_dto_delete_py3
update_kb_operation_dto_py3
update_kb_operation_dto_update
update_kb_operation_dto_update_py3
update_metadata_dto
update_metadata_dto_py3
update_qna_dto
update_qna_dto_context
update_qna_dto_context_py3
update_qna_dto_metadata
update_qna_dto_metadata_py3
update_qna_dto_py3
update_qna_dto_questions
update_qna_dto_questions_py3
update_questions_dto
update_questions_dto_py3
word_alterations_dto
word_alterations_dto_py3

Classes

ActiveLearningSettingsDTO

Active Learning settings of the endpoint.

AlterationsDTO

Collection of words that are synonyms.

All required parameters must be populated in order to send to Azure.

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.

All required parameters must be populated in order to send to Azure.

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.

Error

The error object. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

All required parameters must be populated in order to send to Azure.

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.

All required parameters must be populated in order to send to Azure.

ErrorResponseException

Server responded with exception of type: 'ErrorResponse'.

FeedbackRecordDTO

Active learning feedback record.

FeedbackRecordsDTO

Active learning feedback records.

FileDTO

DTO to hold details of uploaded files.

All required parameters must be populated in order to send to Azure.

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.

KnowledgebaseDTO

Response schema for CreateKb operation.

KnowledgebasesDTO

Collection of knowledgebases owned by a user.

MetadataDTO

Name - value pair of metadata.

All required parameters must be populated in order to send to Azure.

Operation

Record to track long running operation.

PromptDTO

Prompt for an answer.

PromptDTOQna

QnADTO - Either QnaId or QnADTO needs to be present in a PromptDTO object.

All required parameters must be populated in order to send to Azure.

QnADTO

Q-A object.

All required parameters must be populated in order to send to Azure.

QnADTOContext

Context of a QnA.

QnADocumentsDTO

List of QnADTO.

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.

All required parameters must be populated in order to send to Azure.

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.

All required parameters must be populated in order to send to Azure.

Enums

EnvironmentType
ErrorCodeType
OperationStateType
StrictFiltersCompoundOperationType