Generated from 70d1ba468a6326d9c7a2ac7db2d7d0a7438896d1 (#6457)

update readme

sdk/cognitiveservices/azure-cognitiveservices-knowledge-qnamaker/azure/cognitiveservices/knowledge/qnamaker/__init__.py

@@ -9,10 +9,10 @@
 # regenerated.
 # --------------------------------------------------------------------------
 
-from .qn_amaker_client import QnAMakerClient
+from .qn_amaker_runtime_client import QnAMakerRuntimeClient
 from .version import VERSION
 
-__all__ = ['QnAMakerClient']
+__all__ = ['QnAMakerRuntimeClient']
 
 __version__ = VERSION
 

sdk/cognitiveservices/azure-cognitiveservices-knowledge-qnamaker/azure/cognitiveservices/knowledge/qnamaker/models/__init__.py

@@ -10,128 +10,65 @@
 # --------------------------------------------------------------------------
 
 try:
-    from .update_kb_operation_dto_add_py3 import UpdateKbOperationDTOAdd
-    from .update_kb_operation_dto_delete_py3 import UpdateKbOperationDTODelete
-    from .update_kb_operation_dto_update_py3 import UpdateKbOperationDTOUpdate
-    from .update_kb_operation_dto_py3 import UpdateKbOperationDTO
-    from .update_qna_dto_questions_py3 import UpdateQnaDTOQuestions
-    from .update_qna_dto_metadata_py3 import UpdateQnaDTOMetadata
-    from .update_qna_dto_context_py3 import UpdateQnaDTOContext
-    from .update_qna_dto_py3 import UpdateQnaDTO
-    from .update_kb_contents_dto_py3 import UpdateKbContentsDTO
-    from .update_questions_dto_py3 import UpdateQuestionsDTO
     from .metadata_dto_py3 import MetadataDTO
-    from .update_metadata_dto_py3 import UpdateMetadataDTO
-    from .prompt_dto_qna_py3 import PromptDTOQna
-    from .prompt_dto_py3 import PromptDTO
-    from .update_context_dto_py3 import UpdateContextDTO
-    from .delete_kb_contents_dto_py3 import DeleteKbContentsDTO
     from .qn_adto_context_py3 import QnADTOContext
     from .qn_adto_py3 import QnADTO
-    from .file_dto_py3 import FileDTO
-    from .create_kb_input_dto_py3 import CreateKbInputDTO
-    from .qn_adocuments_dto_py3 import QnADocumentsDTO
-    from .create_kb_dto_py3 import CreateKbDTO
-    from .replace_kb_dto_py3 import ReplaceKbDTO
+    from .prompt_dto_qna_py3 import PromptDTOQna
+    from .prompt_dto_py3 import PromptDTO
     from .context_dto_py3 import ContextDTO
     from .error_response_error_py3 import ErrorResponseError
     from .error_response_py3 import ErrorResponse, ErrorResponseException
     from .inner_error_model_py3 import InnerErrorModel
     from .error_py3 import Error
-    from .operation_py3 import Operation
-    from .knowledgebase_dto_py3 import KnowledgebaseDTO
-    from .knowledgebases_dto_py3 import KnowledgebasesDTO
-    from .endpoint_settings_dto_active_learning_py3 import EndpointSettingsDTOActiveLearning
-    from .endpoint_settings_dto_py3 import EndpointSettingsDTO
-    from .active_learning_settings_dto_py3 import ActiveLearningSettingsDTO
-    from .alterations_dto_py3 import AlterationsDTO
-    from .word_alterations_dto_py3 import WordAlterationsDTO
-    from .endpoint_keys_dto_py3 import EndpointKeysDTO
+    from .query_dto_context_py3 import QueryDTOContext
+    from .query_dto_py3 import QueryDTO
+    from .query_context_dto_py3 import QueryContextDTO
+    from .qn_asearch_result_context_py3 import QnASearchResultContext
+    from .qn_asearch_result_py3 import QnASearchResult
+    from .qn_asearch_result_list_py3 import QnASearchResultList
+    from .feedback_record_dto_py3 import FeedbackRecordDTO
+    from .feedback_records_dto_py3 import FeedbackRecordsDTO
 except (SyntaxError, ImportError):
-    from .update_kb_operation_dto_add import UpdateKbOperationDTOAdd
-    from .update_kb_operation_dto_delete import UpdateKbOperationDTODelete
-    from .update_kb_operation_dto_update import UpdateKbOperationDTOUpdate
-    from .update_kb_operation_dto import UpdateKbOperationDTO
-    from .update_qna_dto_questions import UpdateQnaDTOQuestions
-    from .update_qna_dto_metadata import UpdateQnaDTOMetadata
-    from .update_qna_dto_context import UpdateQnaDTOContext
-    from .update_qna_dto import UpdateQnaDTO
-    from .update_kb_contents_dto import UpdateKbContentsDTO
-    from .update_questions_dto import UpdateQuestionsDTO
     from .metadata_dto import MetadataDTO
-    from .update_metadata_dto import UpdateMetadataDTO
-    from .prompt_dto_qna import PromptDTOQna
-    from .prompt_dto import PromptDTO
-    from .update_context_dto import UpdateContextDTO
-    from .delete_kb_contents_dto import DeleteKbContentsDTO
     from .qn_adto_context import QnADTOContext
     from .qn_adto import QnADTO
-    from .file_dto import FileDTO
-    from .create_kb_input_dto import CreateKbInputDTO
-    from .qn_adocuments_dto import QnADocumentsDTO
-    from .create_kb_dto import CreateKbDTO
-    from .replace_kb_dto import ReplaceKbDTO
+    from .prompt_dto_qna import PromptDTOQna
+    from .prompt_dto import PromptDTO
     from .context_dto import ContextDTO
     from .error_response_error import ErrorResponseError
     from .error_response import ErrorResponse, ErrorResponseException
     from .inner_error_model import InnerErrorModel
     from .error import Error
-    from .operation import Operation
-    from .knowledgebase_dto import KnowledgebaseDTO
-    from .knowledgebases_dto import KnowledgebasesDTO
-    from .endpoint_settings_dto_active_learning import EndpointSettingsDTOActiveLearning
-    from .endpoint_settings_dto import EndpointSettingsDTO
-    from .active_learning_settings_dto import ActiveLearningSettingsDTO
-    from .alterations_dto import AlterationsDTO
-    from .word_alterations_dto import WordAlterationsDTO
-    from .endpoint_keys_dto import EndpointKeysDTO
-from .qn_amaker_client_enums import (
-    KnowledgebaseEnvironmentType,
+    from .query_dto_context import QueryDTOContext
+    from .query_dto import QueryDTO
+    from .query_context_dto import QueryContextDTO
+    from .qn_asearch_result_context import QnASearchResultContext
+    from .qn_asearch_result import QnASearchResult
+    from .qn_asearch_result_list import QnASearchResultList
+    from .feedback_record_dto import FeedbackRecordDTO
+    from .feedback_records_dto import FeedbackRecordsDTO
+from .qn_amaker_runtime_client_enums import (
     ErrorCodeType,
-    OperationStateType,
-    EnvironmentType,
 )
 
 __all__ = [
-    'UpdateKbOperationDTOAdd',
-    'UpdateKbOperationDTODelete',
-    'UpdateKbOperationDTOUpdate',
-    'UpdateKbOperationDTO',
-    'UpdateQnaDTOQuestions',
-    'UpdateQnaDTOMetadata',
-    'UpdateQnaDTOContext',
-    'UpdateQnaDTO',
-    'UpdateKbContentsDTO',
-    'UpdateQuestionsDTO',
     'MetadataDTO',
-    'UpdateMetadataDTO',
-    'PromptDTOQna',
-    'PromptDTO',
-    'UpdateContextDTO',
-    'DeleteKbContentsDTO',
     'QnADTOContext',
     'QnADTO',
-    'FileDTO',
-    'CreateKbInputDTO',
-    'QnADocumentsDTO',
-    'CreateKbDTO',
-    'ReplaceKbDTO',
+    'PromptDTOQna',
+    'PromptDTO',
     'ContextDTO',
     'ErrorResponseError',
     'ErrorResponse', 'ErrorResponseException',
     'InnerErrorModel',
     'Error',
-    'Operation',
-    'KnowledgebaseDTO',
-    'KnowledgebasesDTO',
-    'EndpointSettingsDTOActiveLearning',
-    'EndpointSettingsDTO',
-    'ActiveLearningSettingsDTO',
-    'AlterationsDTO',
-    'WordAlterationsDTO',
-    'EndpointKeysDTO',
-    'KnowledgebaseEnvironmentType',
+    'QueryDTOContext',
+    'QueryDTO',
+    'QueryContextDTO',
+    'QnASearchResultContext',
+    'QnASearchResult',
+    'QnASearchResultList',
+    'FeedbackRecordDTO',
+    'FeedbackRecordsDTO',
     'ErrorCodeType',
-    'OperationStateType',
-    'EnvironmentType',
 ]

sdk/cognitiveservices/azure-cognitiveservices-knowledge-qnamaker/azure/cognitiveservices/knowledge/qnamaker/models/feedback_record_dto.py

@@ -0,0 +1,41 @@
+# coding=utf-8
+# --------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for
+# license information.
+#
+# Code generated by Microsoft (R) AutoRest Code Generator.
+# Changes may cause incorrect behavior and will be lost if the code is
+# regenerated.
+# --------------------------------------------------------------------------
+
+from msrest.serialization import Model
+
+
+class FeedbackRecordDTO(Model):
+    """Active learning feedback record.
+
+    :param user_id: Unique identifier for the user.
+    :type user_id: str
+    :param user_question: The suggested question being provided as feedback.
+    :type user_question: str
+    :param qna_id: The qnaId for which the suggested question is provided as
+     feedback.
+    :type qna_id: int
+    """
+
+    _validation = {
+        'user_question': {'max_length': 1000},
+    }
+
+    _attribute_map = {
+        'user_id': {'key': 'userId', 'type': 'str'},
+        'user_question': {'key': 'userQuestion', 'type': 'str'},
+        'qna_id': {'key': 'qnaId', 'type': 'int'},
+    }
+
+    def __init__(self, **kwargs):
+        super(FeedbackRecordDTO, self).__init__(**kwargs)
+        self.user_id = kwargs.get('user_id', None)
+        self.user_question = kwargs.get('user_question', None)
+        self.qna_id = kwargs.get('qna_id', None)

sdk/cognitiveservices/azure-cognitiveservices-knowledge-qnamaker/azure/cognitiveservices/knowledge/qnamaker/models/feedback_record_dto_py3.py

@@ -0,0 +1,41 @@
+# coding=utf-8
+# --------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for
+# license information.
+#
+# Code generated by Microsoft (R) AutoRest Code Generator.
+# Changes may cause incorrect behavior and will be lost if the code is
+# regenerated.
+# --------------------------------------------------------------------------
+
+from msrest.serialization import Model
+
+
+class FeedbackRecordDTO(Model):
+    """Active learning feedback record.
+
+    :param user_id: Unique identifier for the user.
+    :type user_id: str
+    :param user_question: The suggested question being provided as feedback.
+    :type user_question: str
+    :param qna_id: The qnaId for which the suggested question is provided as
+     feedback.
+    :type qna_id: int
+    """
+
+    _validation = {
+        'user_question': {'max_length': 1000},
+    }
+
+    _attribute_map = {
+        'user_id': {'key': 'userId', 'type': 'str'},
+        'user_question': {'key': 'userQuestion', 'type': 'str'},
+        'qna_id': {'key': 'qnaId', 'type': 'int'},
+    }
+
+    def __init__(self, *, user_id: str=None, user_question: str=None, qna_id: int=None, **kwargs) -> None:
+        super(FeedbackRecordDTO, self).__init__(**kwargs)
+        self.user_id = user_id
+        self.user_question = user_question
+        self.qna_id = qna_id

sdk/cognitiveservices/azure-cognitiveservices-knowledge-qnamaker/azure/cognitiveservices/knowledge/qnamaker/models/feedback_records_dto.py

@@ -0,0 +1,29 @@
+# coding=utf-8
+# --------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for
+# license information.
+#
+# Code generated by Microsoft (R) AutoRest Code Generator.
+# Changes may cause incorrect behavior and will be lost if the code is
+# regenerated.
+# --------------------------------------------------------------------------
+
+from msrest.serialization import Model
+
+
+class FeedbackRecordsDTO(Model):
+    """Active learning feedback records.
+
+    :param feedback_records: List of feedback records.
+    :type feedback_records:
+     list[~azure.cognitiveservices.knowledge.qnamaker.models.FeedbackRecordDTO]
+    """
+
+    _attribute_map = {
+        'feedback_records': {'key': 'feedbackRecords', 'type': '[FeedbackRecordDTO]'},
+    }
+
+    def __init__(self, **kwargs):
+        super(FeedbackRecordsDTO, self).__init__(**kwargs)
+        self.feedback_records = kwargs.get('feedback_records', None)

sdk/cognitiveservices/azure-cognitiveservices-knowledge-qnamaker/azure/cognitiveservices/knowledge/qnamaker/models/feedback_records_dto_py3.py

@@ -0,0 +1,29 @@
+# coding=utf-8
+# --------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for
+# license information.
+#
+# Code generated by Microsoft (R) AutoRest Code Generator.
+# Changes may cause incorrect behavior and will be lost if the code is
+# regenerated.
+# --------------------------------------------------------------------------
+
+from msrest.serialization import Model
+
+
+class FeedbackRecordsDTO(Model):
+    """Active learning feedback records.
+
+    :param feedback_records: List of feedback records.
+    :type feedback_records:
+     list[~azure.cognitiveservices.knowledge.qnamaker.models.FeedbackRecordDTO]
+    """
+
+    _attribute_map = {
+        'feedback_records': {'key': 'feedbackRecords', 'type': '[FeedbackRecordDTO]'},
+    }
+
+    def __init__(self, *, feedback_records=None, **kwargs) -> None:
+        super(FeedbackRecordsDTO, self).__init__(**kwargs)
+        self.feedback_records = feedback_records

sdk/cognitiveservices/azure-cognitiveservices-knowledge-qnamaker/azure/cognitiveservices/knowledge/qnamaker/models/qn_amaker_runtime_client_enums.py

@@ -0,0 +1,30 @@
+# coding=utf-8
+# --------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for
+# license information.
+#
+# Code generated by Microsoft (R) AutoRest Code Generator.
+# Changes may cause incorrect behavior and will be lost if the code is
+# regenerated.
+# --------------------------------------------------------------------------
+
+from enum import Enum
+
+
+class ErrorCodeType(str, Enum):
+
+    bad_argument = "BadArgument"
+    forbidden = "Forbidden"
+    not_found = "NotFound"
+    kb_not_found = "KbNotFound"
+    unauthorized = "Unauthorized"
+    unspecified = "Unspecified"
+    endpoint_keys_error = "EndpointKeysError"
+    quota_exceeded = "QuotaExceeded"
+    qna_runtime_error = "QnaRuntimeError"
+    sku_limit_exceeded = "SKULimitExceeded"
+    operation_not_found = "OperationNotFound"
+    service_error = "ServiceError"
+    validation_failure = "ValidationFailure"
+    extraction_failure = "ExtractionFailure"