azure_cognitiveservices_qnamakerruntime 0.17.0

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

@@ -0,0 +1,51 @@
+# 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 object with previous QnA's information.
+    #
+    class QueryDTOContext < QueryContextDTO
+
+      include MsRestAzure
+
+
+      #
+      # Mapper for QueryDTOContext class as Ruby Hash.
+      # This will be used for serialization/deserialization.
+      #
+      def self.mapper()
+        {
+          client_side_validation: true,
+          required: false,
+          serialized_name: 'QueryDTO_context',
+          type: {
+            name: 'Composite',
+            class_name: 'QueryDTOContext',
+            model_properties: {
+              previous_qna_id: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'previousQnaId',
+                type: {
+                  name: 'String'
+                }
+              },
+              previous_user_query: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'previousUserQuery',
+                type: {
+                  name: 'String'
+                }
+              }
+            }
+          }
+        }
+      end
+    end
+  end
+end

data/lib/4.0/generated/azure_cognitiveservices_qnamakerruntime/module_definition.rb

@@ -0,0 +1,9 @@
+# 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 end
+module Azure::CognitiveServices end
+module Azure::CognitiveServices::QnamakerRuntime end
+module Azure::CognitiveServices::QnamakerRuntime::V4_0 end

data/lib/4.0/generated/azure_cognitiveservices_qnamakerruntime/qnamaker_runtime_client.rb

@@ -0,0 +1,127 @@
+# 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
+  #
+  # A service client - single point of access to the REST API.
+  #
+  class QnamakerRuntimeClient < MsRestAzure::AzureServiceClient
+    include MsRestAzure
+    include MsRestAzure::Serialization
+
+    # @return [String] the base URI of the service.
+    attr_reader :base_url
+
+    # @return Credentials needed for the client to connect to Azure.
+    attr_reader :credentials
+
+    # @return [String] QnA Maker App Service endpoint (for example:
+    # https://{qnaservice-hostname}.azurewebsites.net).
+    attr_accessor :runtime_endpoint
+
+    # @return [String] The preferred language for the response.
+    attr_accessor :accept_language
+
+    # @return [Integer] The retry timeout in seconds for Long Running
+    # Operations. Default value is 30.
+    attr_accessor :long_running_operation_retry_timeout
+
+    # @return [Boolean] Whether a unique x-ms-client-request-id should be
+    # generated. When set to true a unique x-ms-client-request-id value is
+    # generated and included in each request. Default is true.
+    attr_accessor :generate_client_request_id
+
+    # @return [Runtime] runtime
+    attr_reader :runtime
+
+    #
+    # Creates initializes a new instance of the QnamakerRuntimeClient class.
+    # @param credentials [MsRest::ServiceClientCredentials] credentials to authorize HTTP requests made by the service client.
+    # @param options [Array] filters to be applied to the HTTP requests.
+    #
+    def initialize(credentials = nil, options = nil)
+      super(credentials, options)
+      @base_url = '{RuntimeEndpoint}/qnamaker'
+
+      fail ArgumentError, 'invalid type of credentials input parameter' unless credentials.is_a?(MsRest::ServiceClientCredentials) unless credentials.nil?
+      @credentials = credentials
+
+      @runtime = Runtime.new(self)
+      @accept_language = 'en-US'
+      @long_running_operation_retry_timeout = 30
+      @generate_client_request_id = true
+      add_telemetry
+    end
+
+    #
+    # Makes a request and returns the body of the response.
+    # @param method [Symbol] with any of the following values :get, :put, :post, :patch, :delete.
+    # @param path [String] the path, relative to {base_url}.
+    # @param options [Hash{String=>String}] specifying any request options like :body.
+    # @return [Hash{String=>String}] containing the body of the response.
+    # Example:
+    #
+    #  request_content = "{'location':'westus','tags':{'tag1':'val1','tag2':'val2'}}"
+    #  path = "/path"
+    #  options = {
+    #    body: request_content,
+    #    query_params: {'api-version' => '2016-02-01'}
+    #  }
+    #  result = @client.make_request(:put, path, options)
+    #
+    def make_request(method, path, options = {})
+      result = make_request_with_http_info(method, path, options)
+      result.body unless result.nil?
+    end
+
+    #
+    # Makes a request and returns the operation response.
+    # @param method [Symbol] with any of the following values :get, :put, :post, :patch, :delete.
+    # @param path [String] the path, relative to {base_url}.
+    # @param options [Hash{String=>String}] specifying any request options like :body.
+    # @return [MsRestAzure::AzureOperationResponse] Operation response containing the request, response and status.
+    #
+    def make_request_with_http_info(method, path, options = {})
+      result = make_request_async(method, path, options).value!
+      result.body = result.response.body.to_s.empty? ? nil : JSON.load(result.response.body)
+      result
+    end
+
+    #
+    # Makes a request asynchronously.
+    # @param method [Symbol] with any of the following values :get, :put, :post, :patch, :delete.
+    # @param path [String] the path, relative to {base_url}.
+    # @param options [Hash{String=>String}] specifying any request options like :body.
+    # @return [Concurrent::Promise] Promise object which holds the HTTP response.
+    #
+    def make_request_async(method, path, options = {})
+      fail ArgumentError, 'method is nil' if method.nil?
+      fail ArgumentError, 'path is nil' if path.nil?
+
+      request_url = options[:base_url] || @base_url
+      if(!options[:headers].nil? && !options[:headers]['Content-Type'].nil?)
+        @request_headers['Content-Type'] = options[:headers]['Content-Type']
+      end
+
+      request_headers = @request_headers
+      request_headers.merge!({'accept-language' => @accept_language}) unless @accept_language.nil?
+      options.merge!({headers: request_headers.merge(options[:headers] || {})})
+      options.merge!({credentials: @credentials}) unless @credentials.nil?
+
+      super(request_url, method, path, options)
+    end
+
+
+    private
+    #
+    # Adds telemetry information.
+    #
+    def add_telemetry
+        sdk_information = 'azure_cognitiveservices_qnamakerruntime'
+        sdk_information = "#{sdk_information}/0.17.0"
+        add_user_agent_information(sdk_information)
+    end
+  end
+end

data/lib/4.0/generated/azure_cognitiveservices_qnamakerruntime/runtime.rb

@@ -0,0 +1,214 @@
+# 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
+  #
+  # An API for QnAMaker runtime
+  #
+  class Runtime
+    include MsRestAzure
+
+    #
+    # Creates and initializes a new instance of the Runtime class.
+    # @param client service class for accessing basic functionality.
+    #
+    def initialize(client)
+      @client = client
+    end
+
+    # @return [QnamakerRuntimeClient] reference to the QnamakerRuntimeClient
+    attr_reader :client
+
+    #
+    # GenerateAnswer call to query the knowledgebase.
+    #
+    # @param kb_id [String] Knowledgebase id.
+    # @param generate_answer_payload [QueryDTO] Post body of the request.
+    # @param custom_headers [Hash{String => String}] A hash of custom headers that
+    # will be added to the HTTP request.
+    #
+    # @return [QnASearchResultList] operation results.
+    #
+    def generate_answer(kb_id, generate_answer_payload, custom_headers:nil)
+      response = generate_answer_async(kb_id, generate_answer_payload, custom_headers:custom_headers).value!
+      response.body unless response.nil?
+    end
+
+    #
+    # GenerateAnswer call to query the knowledgebase.
+    #
+    # @param kb_id [String] Knowledgebase id.
+    # @param generate_answer_payload [QueryDTO] Post body of the request.
+    # @param custom_headers [Hash{String => String}] A hash of custom headers that
+    # will be added to the HTTP request.
+    #
+    # @return [MsRestAzure::AzureOperationResponse] HTTP response information.
+    #
+    def generate_answer_with_http_info(kb_id, generate_answer_payload, custom_headers:nil)
+      generate_answer_async(kb_id, generate_answer_payload, custom_headers:custom_headers).value!
+    end
+
+    #
+    # GenerateAnswer call to query the knowledgebase.
+    #
+    # @param kb_id [String] Knowledgebase id.
+    # @param generate_answer_payload [QueryDTO] Post body of the request.
+    # @param [Hash{String => String}] A hash of custom headers that will be added
+    # to the HTTP request.
+    #
+    # @return [Concurrent::Promise] Promise object which holds the HTTP response.
+    #
+    def generate_answer_async(kb_id, generate_answer_payload, custom_headers:nil)
+      fail ArgumentError, '@client.runtime_endpoint is nil' if @client.runtime_endpoint.nil?
+      fail ArgumentError, 'kb_id is nil' if kb_id.nil?
+      fail ArgumentError, 'generate_answer_payload is nil' if generate_answer_payload.nil?
+
+
+      request_headers = {}
+      request_headers['Content-Type'] = 'application/json; charset=utf-8'
+
+      # Set Headers
+      request_headers['x-ms-client-request-id'] = SecureRandom.uuid
+      request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?
+
+      # Serialize Request
+      request_mapper = Azure::CognitiveServices::QnamakerRuntime::V4_0::Models::QueryDTO.mapper()
+      request_content = @client.serialize(request_mapper,  generate_answer_payload)
+      request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil
+
+      path_template = 'knowledgebases/{kbId}/generateAnswer'
+
+      request_url = @base_url || @client.base_url
+    request_url = request_url.gsub('{RuntimeEndpoint}', @client.runtime_endpoint)
+
+      options = {
+          middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
+          path_params: {'kbId' => kb_id},
+          body: request_content,
+          headers: request_headers.merge(custom_headers || {}),
+          base_url: request_url
+      }
+      promise = @client.make_request_async(:post, path_template, options)
+
+      promise = promise.then do |result|
+        http_response = result.response
+        status_code = http_response.status
+        response_content = http_response.body
+        unless status_code == 200
+          error_model = JSON.load(response_content)
+          fail MsRest::HttpOperationError.new(result.request, http_response, error_model)
+        end
+
+        result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
+        result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
+        result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
+        # Deserialize Response
+        if status_code == 200
+          begin
+            parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
+            result_mapper = Azure::CognitiveServices::QnamakerRuntime::V4_0::Models::QnASearchResultList.mapper()
+            result.body = @client.deserialize(result_mapper, parsed_response)
+          rescue Exception => e
+            fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
+          end
+        end
+
+        result
+      end
+
+      promise.execute
+    end
+
+    #
+    # Train call to add suggestions to the knowledgebase.
+    #
+    # @param kb_id [String] Knowledgebase id.
+    # @param train_payload [FeedbackRecordsDTO] Post body of the request.
+    # @param custom_headers [Hash{String => String}] A hash of custom headers that
+    # will be added to the HTTP request.
+    #
+    #
+    def train(kb_id, train_payload, custom_headers:nil)
+      response = train_async(kb_id, train_payload, custom_headers:custom_headers).value!
+      nil
+    end
+
+    #
+    # Train call to add suggestions to the knowledgebase.
+    #
+    # @param kb_id [String] Knowledgebase id.
+    # @param train_payload [FeedbackRecordsDTO] Post body of the request.
+    # @param custom_headers [Hash{String => String}] A hash of custom headers that
+    # will be added to the HTTP request.
+    #
+    # @return [MsRestAzure::AzureOperationResponse] HTTP response information.
+    #
+    def train_with_http_info(kb_id, train_payload, custom_headers:nil)
+      train_async(kb_id, train_payload, custom_headers:custom_headers).value!
+    end
+
+    #
+    # Train call to add suggestions to the knowledgebase.
+    #
+    # @param kb_id [String] Knowledgebase id.
+    # @param train_payload [FeedbackRecordsDTO] Post body of the request.
+    # @param [Hash{String => String}] A hash of custom headers that will be added
+    # to the HTTP request.
+    #
+    # @return [Concurrent::Promise] Promise object which holds the HTTP response.
+    #
+    def train_async(kb_id, train_payload, custom_headers:nil)
+      fail ArgumentError, '@client.runtime_endpoint is nil' if @client.runtime_endpoint.nil?
+      fail ArgumentError, 'kb_id is nil' if kb_id.nil?
+      fail ArgumentError, 'train_payload is nil' if train_payload.nil?
+
+
+      request_headers = {}
+      request_headers['Content-Type'] = 'application/json; charset=utf-8'
+
+      # Set Headers
+      request_headers['x-ms-client-request-id'] = SecureRandom.uuid
+      request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?
+
+      # Serialize Request
+      request_mapper = Azure::CognitiveServices::QnamakerRuntime::V4_0::Models::FeedbackRecordsDTO.mapper()
+      request_content = @client.serialize(request_mapper,  train_payload)
+      request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil
+
+      path_template = 'knowledgebases/{kbId}/train'
+
+      request_url = @base_url || @client.base_url
+    request_url = request_url.gsub('{RuntimeEndpoint}', @client.runtime_endpoint)
+
+      options = {
+          middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
+          path_params: {'kbId' => kb_id},
+          body: request_content,
+          headers: request_headers.merge(custom_headers || {}),
+          base_url: request_url
+      }
+      promise = @client.make_request_async(:post, path_template, options)
+
+      promise = promise.then do |result|
+        http_response = result.response
+        status_code = http_response.status
+        response_content = http_response.body
+        unless status_code == 204
+          error_model = JSON.load(response_content)
+          fail MsRest::HttpOperationError.new(result.request, http_response, error_model)
+        end
+
+        result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
+        result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
+        result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
+
+        result
+      end
+
+      promise.execute
+    end
+
+  end
+end

data/lib/azure_cognitiveservices_qnamakerruntime.rb

@@ -0,0 +1,6 @@
+# encoding: utf-8
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for license information.
+
+require '4.0/generated/azure_cognitiveservices_qnamakerruntime'
+require 'profiles/latest/qnamakerruntime_latest_profile_client'

data/lib/module_definition.rb

@@ -0,0 +1,7 @@
+# encoding: utf-8
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for license information.
+
+module Azure end
+module Azure::Cognitiveservices end
+module Azure::Cognitiveservices::Qnamakerruntime end

data/lib/profiles/latest/modules/qnamakerruntime_profile_module.rb

@@ -0,0 +1,135 @@
+# encoding: utf-8
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for license information.
+
+require 'azure_cognitiveservices_qnamakerruntime'
+
+module Azure::QnamakerRuntime::Profiles::Latest
+  Runtime = Azure::CognitiveServices::QnamakerRuntime::V4_0::Runtime
+
+  module Models
+    Error = Azure::CognitiveServices::QnamakerRuntime::V4_0::Models::Error
+    MetadataDTO = Azure::CognitiveServices::QnamakerRuntime::V4_0::Models::MetadataDTO
+    ErrorResponse = Azure::CognitiveServices::QnamakerRuntime::V4_0::Models::ErrorResponse
+    InnerErrorModel = Azure::CognitiveServices::QnamakerRuntime::V4_0::Models::InnerErrorModel
+    FeedbackRecordDTO = Azure::CognitiveServices::QnamakerRuntime::V4_0::Models::FeedbackRecordDTO
+    QnASearchResult = Azure::CognitiveServices::QnamakerRuntime::V4_0::Models::QnASearchResult
+    ContextDTO = Azure::CognitiveServices::QnamakerRuntime::V4_0::Models::ContextDTO
+    QnADTO = Azure::CognitiveServices::QnamakerRuntime::V4_0::Models::QnADTO
+    QueryDTO = Azure::CognitiveServices::QnamakerRuntime::V4_0::Models::QueryDTO
+    QnASearchResultList = Azure::CognitiveServices::QnamakerRuntime::V4_0::Models::QnASearchResultList
+    QueryContextDTO = Azure::CognitiveServices::QnamakerRuntime::V4_0::Models::QueryContextDTO
+    PromptDTO = Azure::CognitiveServices::QnamakerRuntime::V4_0::Models::PromptDTO
+    FeedbackRecordsDTO = Azure::CognitiveServices::QnamakerRuntime::V4_0::Models::FeedbackRecordsDTO
+    QnADTOContext = Azure::CognitiveServices::QnamakerRuntime::V4_0::Models::QnADTOContext
+    PromptDTOQna = Azure::CognitiveServices::QnamakerRuntime::V4_0::Models::PromptDTOQna
+    ErrorResponseError = Azure::CognitiveServices::QnamakerRuntime::V4_0::Models::ErrorResponseError
+    QueryDTOContext = Azure::CognitiveServices::QnamakerRuntime::V4_0::Models::QueryDTOContext
+    QnASearchResultContext = Azure::CognitiveServices::QnamakerRuntime::V4_0::Models::QnASearchResultContext
+    ErrorCodeType = Azure::CognitiveServices::QnamakerRuntime::V4_0::Models::ErrorCodeType
+  end
+
+  #
+  # QnamakerRuntimeDataClass
+  #
+  class QnamakerRuntimeDataClass
+    attr_reader :runtime, :configurable, :base_url, :options, :model_classes
+
+    def initialize(options = {})
+      if options.is_a?(Hash) && options.length == 0
+        @options = setup_default_options
+      else
+        @options = options
+      end
+
+      reset!(options)
+
+      @configurable = self
+      @base_url = options[:base_url].nil? ? nil:options[:base_url]
+      @options = options[:options].nil? ? nil:options[:options]
+
+      @client_0 = Azure::CognitiveServices::QnamakerRuntime::V4_0::QnamakerRuntimeClient.new(configurable.credentials, options)
+      if(@client_0.respond_to?(:subscription_id))
+        @client_0.subscription_id = configurable.subscription_id
+      end
+      add_telemetry(@client_0)
+      @runtime = @client_0.runtime
+
+      @model_classes = ModelClasses.new
+    end
+
+    def add_telemetry(client)
+      profile_information = 'Profiles/Latest/QnamakerRuntime'
+      client.add_user_agent_information(profile_information)
+    end
+
+    def method_missing(method, *args)
+      if @client_0.respond_to?method
+        @client_0.send(method, *args)
+      else
+        super
+      end
+    end
+
+  end
+
+  class ModelClasses
+    def error
+      Azure::CognitiveServices::QnamakerRuntime::V4_0::Models::Error
+    end
+    def metadata_dto
+      Azure::CognitiveServices::QnamakerRuntime::V4_0::Models::MetadataDTO
+    end
+    def error_response
+      Azure::CognitiveServices::QnamakerRuntime::V4_0::Models::ErrorResponse
+    end
+    def inner_error_model
+      Azure::CognitiveServices::QnamakerRuntime::V4_0::Models::InnerErrorModel
+    end
+    def feedback_record_dto
+      Azure::CognitiveServices::QnamakerRuntime::V4_0::Models::FeedbackRecordDTO
+    end
+    def qn_asearch_result
+      Azure::CognitiveServices::QnamakerRuntime::V4_0::Models::QnASearchResult
+    end
+    def context_dto
+      Azure::CognitiveServices::QnamakerRuntime::V4_0::Models::ContextDTO
+    end
+    def qn_adto
+      Azure::CognitiveServices::QnamakerRuntime::V4_0::Models::QnADTO
+    end
+    def query_dto
+      Azure::CognitiveServices::QnamakerRuntime::V4_0::Models::QueryDTO
+    end
+    def qn_asearch_result_list
+      Azure::CognitiveServices::QnamakerRuntime::V4_0::Models::QnASearchResultList
+    end
+    def query_context_dto
+      Azure::CognitiveServices::QnamakerRuntime::V4_0::Models::QueryContextDTO
+    end
+    def prompt_dto
+      Azure::CognitiveServices::QnamakerRuntime::V4_0::Models::PromptDTO
+    end
+    def feedback_records_dto
+      Azure::CognitiveServices::QnamakerRuntime::V4_0::Models::FeedbackRecordsDTO
+    end
+    def qn_adtocontext
+      Azure::CognitiveServices::QnamakerRuntime::V4_0::Models::QnADTOContext
+    end
+    def prompt_dtoqna
+      Azure::CognitiveServices::QnamakerRuntime::V4_0::Models::PromptDTOQna
+    end
+    def error_response_error
+      Azure::CognitiveServices::QnamakerRuntime::V4_0::Models::ErrorResponseError
+    end
+    def query_dtocontext
+      Azure::CognitiveServices::QnamakerRuntime::V4_0::Models::QueryDTOContext
+    end
+    def qn_asearch_result_context
+      Azure::CognitiveServices::QnamakerRuntime::V4_0::Models::QnASearchResultContext
+    end
+    def error_code_type
+      Azure::CognitiveServices::QnamakerRuntime::V4_0::Models::ErrorCodeType
+    end
+  end
+end