azure_cognitiveservices_qnamakerruntime 0.17.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6b286cf61164334c0ca56dce1840f921fbce19d7df323bbbacb262d27e4364f4
+  data.tar.gz: 3965cbbf3890af8f977a6773fc20b7f89b87ee887c3c508629c194f93694b01f
+SHA512:
+  metadata.gz: bab9405bc175263683862d287052986b04d23259102953ca026ae421fac860b7708967e5a075537861b9bf9718015bae47cfa3f5e68bb2ab8222f7dd560c746c
+  data.tar.gz: cb3dfe2ab1ec22d1b3ecc1ca37b602999c77ec227d7313598d1f7559333c5040f4c99384a4bc5b7b9aea694b91093990db4fa0c7083909ba6d2592fccdb6becb

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Microsoft Corporation
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/lib/4.0/generated/azure_cognitiveservices_qnamakerruntime.rb

@@ -0,0 +1,47 @@
+# encoding: utf-8
+# Code generated by Microsoft (R) AutoRest Code Generator.
+# Changes may cause incorrect behavior and will be lost if the code is
+# regenerated.
+
+require 'uri'
+require 'cgi'
+require 'date'
+require 'json'
+require 'base64'
+require 'erb'
+require 'securerandom'
+require 'time'
+require 'timeliness'
+require 'faraday'
+require 'faraday-cookie_jar'
+require 'concurrent'
+require 'ms_rest'
+require '4.0/generated/azure_cognitiveservices_qnamakerruntime/module_definition'
+require 'ms_rest_azure'
+
+module Azure::CognitiveServices::QnamakerRuntime::V4_0
+  autoload :Runtime,                                            '4.0/generated/azure_cognitiveservices_qnamakerruntime/runtime.rb'
+  autoload :QnamakerRuntimeClient,                              '4.0/generated/azure_cognitiveservices_qnamakerruntime/qnamaker_runtime_client.rb'
+
+  module Models
+    autoload :Error,                                              '4.0/generated/azure_cognitiveservices_qnamakerruntime/models/error.rb'
+    autoload :MetadataDTO,                                        '4.0/generated/azure_cognitiveservices_qnamakerruntime/models/metadata_dto.rb'
+    autoload :ErrorResponse,                                      '4.0/generated/azure_cognitiveservices_qnamakerruntime/models/error_response.rb'
+    autoload :InnerErrorModel,                                    '4.0/generated/azure_cognitiveservices_qnamakerruntime/models/inner_error_model.rb'
+    autoload :FeedbackRecordDTO,                                  '4.0/generated/azure_cognitiveservices_qnamakerruntime/models/feedback_record_dto.rb'
+    autoload :QnASearchResult,                                    '4.0/generated/azure_cognitiveservices_qnamakerruntime/models/qn_asearch_result.rb'
+    autoload :ContextDTO,                                         '4.0/generated/azure_cognitiveservices_qnamakerruntime/models/context_dto.rb'
+    autoload :QnADTO,                                             '4.0/generated/azure_cognitiveservices_qnamakerruntime/models/qn_adto.rb'
+    autoload :QueryDTO,                                           '4.0/generated/azure_cognitiveservices_qnamakerruntime/models/query_dto.rb'
+    autoload :QnASearchResultList,                                '4.0/generated/azure_cognitiveservices_qnamakerruntime/models/qn_asearch_result_list.rb'
+    autoload :QueryContextDTO,                                    '4.0/generated/azure_cognitiveservices_qnamakerruntime/models/query_context_dto.rb'
+    autoload :PromptDTO,                                          '4.0/generated/azure_cognitiveservices_qnamakerruntime/models/prompt_dto.rb'
+    autoload :FeedbackRecordsDTO,                                 '4.0/generated/azure_cognitiveservices_qnamakerruntime/models/feedback_records_dto.rb'
+    autoload :QnADTOContext,                                      '4.0/generated/azure_cognitiveservices_qnamakerruntime/models/qn_adtocontext.rb'
+    autoload :PromptDTOQna,                                       '4.0/generated/azure_cognitiveservices_qnamakerruntime/models/prompt_dtoqna.rb'
+    autoload :ErrorResponseError,                                 '4.0/generated/azure_cognitiveservices_qnamakerruntime/models/error_response_error.rb'
+    autoload :QueryDTOContext,                                    '4.0/generated/azure_cognitiveservices_qnamakerruntime/models/query_dtocontext.rb'
+    autoload :QnASearchResultContext,                             '4.0/generated/azure_cognitiveservices_qnamakerruntime/models/qn_asearch_result_context.rb'
+    autoload :ErrorCodeType,                                      '4.0/generated/azure_cognitiveservices_qnamakerruntime/models/error_code_type.rb'
+  end
+end

data/lib/4.0/generated/azure_cognitiveservices_qnamakerruntime/models/context_dto.rb

@@ -0,0 +1,73 @@
+# encoding: utf-8
+# Code generated by Microsoft (R) AutoRest Code Generator.
+# Changes may cause incorrect behavior and will be lost if the code is
+# regenerated.
+
+module Azure::CognitiveServices::QnamakerRuntime::V4_0
+  module Models
+    #
+    # Context associated with Qna.
+    #
+    class ContextDTO
+
+      include MsRestAzure
+
+      # @return [Boolean] To mark if a prompt is relevant only with a previous
+      # question or not.
+      # true - Do not include this QnA as search result for queries without
+      # context
+      # false - ignores context and includes this QnA in search result
+      attr_accessor :is_context_only
+
+      # @return [Array<PromptDTO>] List of prompts associated with the answer.
+      attr_accessor :prompts
+
+
+      #
+      # Mapper for ContextDTO class as Ruby Hash.
+      # This will be used for serialization/deserialization.
+      #
+      def self.mapper()
+        {
+          client_side_validation: true,
+          required: false,
+          serialized_name: 'ContextDTO',
+          type: {
+            name: 'Composite',
+            class_name: 'ContextDTO',
+            model_properties: {
+              is_context_only: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'isContextOnly',
+                type: {
+                  name: 'Boolean'
+                }
+              },
+              prompts: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'prompts',
+                constraints: {
+                  MaxItems: 20
+                },
+                type: {
+                  name: 'Sequence',
+                  element: {
+                      client_side_validation: true,
+                      required: false,
+                      serialized_name: 'PromptDTOElementType',
+                      type: {
+                        name: 'Composite',
+                        class_name: 'PromptDTO'
+                      }
+                  }
+                }
+              }
+            }
+          }
+        }
+      end
+    end
+  end
+end

data/lib/4.0/generated/azure_cognitiveservices_qnamakerruntime/models/error.rb

@@ -0,0 +1,108 @@
+# encoding: utf-8
+# Code generated by Microsoft (R) AutoRest Code Generator.
+# Changes may cause incorrect behavior and will be lost if the code is
+# regenerated.
+
+module Azure::CognitiveServices::QnamakerRuntime::V4_0
+  module Models
+    #
+    # The error object. As per Microsoft One API guidelines -
+    # https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
+    #
+    class Error
+
+      include MsRestAzure
+
+      # @return [ErrorCodeType] One of a server-defined set of error codes.
+      # Possible values include: 'BadArgument', 'Forbidden', 'NotFound',
+      # 'KbNotFound', 'Unauthorized', 'Unspecified', 'EndpointKeysError',
+      # 'QuotaExceeded', 'QnaRuntimeError', 'SKULimitExceeded',
+      # 'OperationNotFound', 'ServiceError', 'ValidationFailure',
+      # 'ExtractionFailure'
+      attr_accessor :code
+
+      # @return [String] A human-readable representation of the error.
+      attr_accessor :message
+
+      # @return [String] The target of the error.
+      attr_accessor :target
+
+      # @return [Array<Error>] An array of details about specific errors that
+      # led to this reported error.
+      attr_accessor :details
+
+      # @return [InnerErrorModel] An object containing more specific
+      # information than the current object about the error.
+      attr_accessor :inner_error
+
+
+      #
+      # Mapper for Error class as Ruby Hash.
+      # This will be used for serialization/deserialization.
+      #
+      def self.mapper()
+        {
+          client_side_validation: true,
+          required: false,
+          serialized_name: 'Error',
+          type: {
+            name: 'Composite',
+            class_name: 'Error',
+            model_properties: {
+              code: {
+                client_side_validation: true,
+                required: true,
+                serialized_name: 'code',
+                type: {
+                  name: 'String'
+                }
+              },
+              message: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'message',
+                type: {
+                  name: 'String'
+                }
+              },
+              target: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'target',
+                type: {
+                  name: 'String'
+                }
+              },
+              details: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'details',
+                type: {
+                  name: 'Sequence',
+                  element: {
+                      client_side_validation: true,
+                      required: false,
+                      serialized_name: 'ErrorElementType',
+                      type: {
+                        name: 'Composite',
+                        class_name: 'Error'
+                      }
+                  }
+                }
+              },
+              inner_error: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'innerError',
+                type: {
+                  name: 'Composite',
+                  class_name: 'InnerErrorModel'
+                }
+              }
+            }
+          }
+        }
+      end
+    end
+  end
+end

data/lib/4.0/generated/azure_cognitiveservices_qnamakerruntime/models/error_code_type.rb

@@ -0,0 +1,28 @@
+# encoding: utf-8
+# Code generated by Microsoft (R) AutoRest Code Generator.
+# Changes may cause incorrect behavior and will be lost if the code is
+# regenerated.
+
+module Azure::CognitiveServices::QnamakerRuntime::V4_0
+  module Models
+    #
+    # Defines values for ErrorCodeType
+    #
+    module ErrorCodeType
+      BadArgument = "BadArgument"
+      Forbidden = "Forbidden"
+      NotFound = "NotFound"
+      KbNotFound = "KbNotFound"
+      Unauthorized = "Unauthorized"
+      Unspecified = "Unspecified"
+      EndpointKeysError = "EndpointKeysError"
+      QuotaExceeded = "QuotaExceeded"
+      QnaRuntimeError = "QnaRuntimeError"
+      SKULimitExceeded = "SKULimitExceeded"
+      OperationNotFound = "OperationNotFound"
+      ServiceError = "ServiceError"
+      ValidationFailure = "ValidationFailure"
+      ExtractionFailure = "ExtractionFailure"
+    end
+  end
+end

data/lib/4.0/generated/azure_cognitiveservices_qnamakerruntime/models/error_response.rb

@@ -0,0 +1,48 @@
+# encoding: utf-8
+# Code generated by Microsoft (R) AutoRest Code Generator.
+# Changes may cause incorrect behavior and will be lost if the code is
+# regenerated.
+
+module Azure::CognitiveServices::QnamakerRuntime::V4_0
+  module Models
+    #
+    # Error response. As per Microsoft One API guidelines -
+    # https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
+    #
+    class ErrorResponse
+
+      include MsRestAzure
+
+      # @return [ErrorResponseError] The error object.
+      attr_accessor :error
+
+
+      #
+      # Mapper for ErrorResponse class as Ruby Hash.
+      # This will be used for serialization/deserialization.
+      #
+      def self.mapper()
+        {
+          client_side_validation: true,
+          required: false,
+          serialized_name: 'ErrorResponse',
+          type: {
+            name: 'Composite',
+            class_name: 'ErrorResponse',
+            model_properties: {
+              error: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'error',
+                type: {
+                  name: 'Composite',
+                  class_name: 'ErrorResponseError'
+                }
+              }
+            }
+          }
+        }
+      end
+    end
+  end
+end

data/lib/4.0/generated/azure_cognitiveservices_qnamakerruntime/models/error_response_error.rb

@@ -0,0 +1,85 @@
+# encoding: utf-8
+# Code generated by Microsoft (R) AutoRest Code Generator.
+# Changes may cause incorrect behavior and will be lost if the code is
+# regenerated.
+
+module Azure::CognitiveServices::QnamakerRuntime::V4_0
+  module Models
+    #
+    # The error object.
+    #
+    class ErrorResponseError < Error
+
+      include MsRestAzure
+
+
+      #
+      # Mapper for ErrorResponseError class as Ruby Hash.
+      # This will be used for serialization/deserialization.
+      #
+      def self.mapper()
+        {
+          client_side_validation: true,
+          required: false,
+          serialized_name: 'ErrorResponse_error',
+          type: {
+            name: 'Composite',
+            class_name: 'ErrorResponseError',
+            model_properties: {
+              code: {
+                client_side_validation: true,
+                required: true,
+                serialized_name: 'code',
+                type: {
+                  name: 'String'
+                }
+              },
+              message: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'message',
+                type: {
+                  name: 'String'
+                }
+              },
+              target: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'target',
+                type: {
+                  name: 'String'
+                }
+              },
+              details: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'details',
+                type: {
+                  name: 'Sequence',
+                  element: {
+                      client_side_validation: true,
+                      required: false,
+                      serialized_name: 'ErrorElementType',
+                      type: {
+                        name: 'Composite',
+                        class_name: 'Error'
+                      }
+                  }
+                }
+              },
+              inner_error: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'innerError',
+                type: {
+                  name: 'Composite',
+                  class_name: 'InnerErrorModel'
+                }
+              }
+            }
+          }
+        }
+      end
+    end
+  end
+end

data/lib/4.0/generated/azure_cognitiveservices_qnamakerruntime/models/feedback_record_dto.rb

@@ -0,0 +1,72 @@
+# encoding: utf-8
+# Code generated by Microsoft (R) AutoRest Code Generator.
+# Changes may cause incorrect behavior and will be lost if the code is
+# regenerated.
+
+module Azure::CognitiveServices::QnamakerRuntime::V4_0
+  module Models
+    #
+    # Active learning feedback record.
+    #
+    class FeedbackRecordDTO
+
+      include MsRestAzure
+
+      # @return [String] Unique identifier for the user.
+      attr_accessor :user_id
+
+      # @return [String] The suggested question being provided as feedback.
+      attr_accessor :user_question
+
+      # @return [Integer] The qnaId for which the suggested question is
+      # provided as feedback.
+      attr_accessor :qna_id
+
+
+      #
+      # Mapper for FeedbackRecordDTO class as Ruby Hash.
+      # This will be used for serialization/deserialization.
+      #
+      def self.mapper()
+        {
+          client_side_validation: true,
+          required: false,
+          serialized_name: 'FeedbackRecordDTO',
+          type: {
+            name: 'Composite',
+            class_name: 'FeedbackRecordDTO',
+            model_properties: {
+              user_id: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'userId',
+                type: {
+                  name: 'String'
+                }
+              },
+              user_question: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'userQuestion',
+                constraints: {
+                  MaxLength: 1000
+                },
+                type: {
+                  name: 'String'
+                }
+              },
+              qna_id: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'qnaId',
+                type: {
+                  name: 'Number'
+                }
+              }
+            }
+          }
+        }
+      end
+    end
+  end
+end