indexea_client 0.0.9

data/lib/indexea_client/api/search_api.rb

@@ -0,0 +1,892 @@
+=begin
+#Indexea OpenAPI
+
+#OpenAPI of Indexea
+
+OpenAPI spec version: 1.0.0
+Contact: indexea.com@gmail.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 3.0.54
+=end
+
+module IndexeaClient
+  class SearchApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # 搜索结果点击行为收集
+    # 该接口主要用于记录用户对搜索结果的点击行为
+    # @param widget 组件唯一标识
+    # @param action_id 对应搜索行为编号
+    # @param doc_id 对应索引中的内部记录编号
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :userid 搜索者的唯一标识，该标识由搜索前端生成，长度不超过64
+    # @option opts [String] :x_token 如果要使用非发布的组件，需要组件作者授权
+    # @return [BOOLEAN]
+    def search_click(widget, action_id, doc_id, opts = {})
+      data, _status_code, _headers = search_click_with_http_info(widget, action_id, doc_id, opts)
+      data
+    end
+
+    # 搜索结果点击行为收集
+    # 该接口主要用于记录用户对搜索结果的点击行为
+    # @param widget 组件唯一标识
+    # @param action_id 对应搜索行为编号
+    # @param doc_id 对应索引中的内部记录编号
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :userid 搜索者的唯一标识，该标识由搜索前端生成，长度不超过64
+    # @option opts [String] :x_token 如果要使用非发布的组件，需要组件作者授权
+    # @return [Array<(BOOLEAN, Integer, Hash)>] BOOLEAN data, response status code and response headers
+    def search_click_with_http_info(widget, action_id, doc_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SearchApi.search_click ...'
+      end
+      # verify the required parameter 'widget' is set
+      if @api_client.config.client_side_validation && widget.nil?
+        fail ArgumentError, "Missing the required parameter 'widget' when calling SearchApi.search_click"
+      end
+      # verify the required parameter 'action_id' is set
+      if @api_client.config.client_side_validation && action_id.nil?
+        fail ArgumentError, "Missing the required parameter 'action_id' when calling SearchApi.search_click"
+      end
+      # verify the required parameter 'doc_id' is set
+      if @api_client.config.client_side_validation && doc_id.nil?
+        fail ArgumentError, "Missing the required parameter 'doc_id' when calling SearchApi.search_click"
+      end
+      # resource path
+      local_var_path = '/search/widget/{widget}/click'.sub('{' + 'widget' + '}', widget.to_s)
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'action_id'] = action_id
+      query_params[:'doc_id'] = doc_id
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      header_params[:'userid'] = opts[:'userid'] if !opts[:'userid'].nil?
+      header_params[:'x-token'] = opts[:'x_token'] if !opts[:'x_token'].nil?
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      return_type = opts[:return_type] || 'BOOLEAN' 
+
+      auth_names = opts[:auth_names] || []
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type)
+
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SearchApi#search_click\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # 获取当前搜索用户的最新搜索记录
+    # @param widget 组件唯一标识
+    # @param strategy 搜索记录策略
+    # @param query 指定关联查询的编号
+    # @param size 数量
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :userid 搜索者的唯一标识，该标识由搜索前端生成，长度不超过64
+    # @option opts [String] :x_token 如果要使用非公开的组件，需要组件作者授权
+    # @return [Array<String>]
+    def search_histories(widget, strategy, query, size, opts = {})
+      data, _status_code, _headers = search_histories_with_http_info(widget, strategy, query, size, opts)
+      data
+    end
+
+    # 获取当前搜索用户的最新搜索记录
+    # @param widget 组件唯一标识
+    # @param strategy 搜索记录策略
+    # @param query 指定关联查询的编号
+    # @param size 数量
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :userid 搜索者的唯一标识，该标识由搜索前端生成，长度不超过64
+    # @option opts [String] :x_token 如果要使用非公开的组件，需要组件作者授权
+    # @return [Array<(Array<String>, Integer, Hash)>] Array<String> data, response status code and response headers
+    def search_histories_with_http_info(widget, strategy, query, size, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SearchApi.search_histories ...'
+      end
+      # verify the required parameter 'widget' is set
+      if @api_client.config.client_side_validation && widget.nil?
+        fail ArgumentError, "Missing the required parameter 'widget' when calling SearchApi.search_histories"
+      end
+      # verify the required parameter 'strategy' is set
+      if @api_client.config.client_side_validation && strategy.nil?
+        fail ArgumentError, "Missing the required parameter 'strategy' when calling SearchApi.search_histories"
+      end
+      # verify enum value
+      if @api_client.config.client_side_validation && !['recent', 'popular'].include?(strategy)
+        fail ArgumentError, "invalid value for 'strategy', must be one of recent, popular"
+      end
+      # verify the required parameter 'query' is set
+      if @api_client.config.client_side_validation && query.nil?
+        fail ArgumentError, "Missing the required parameter 'query' when calling SearchApi.search_histories"
+      end
+      # verify the required parameter 'size' is set
+      if @api_client.config.client_side_validation && size.nil?
+        fail ArgumentError, "Missing the required parameter 'size' when calling SearchApi.search_histories"
+      end
+      # resource path
+      local_var_path = '/search/widget/{widget}/histories'.sub('{' + 'widget' + '}', widget.to_s)
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'strategy'] = strategy
+      query_params[:'query'] = query
+      query_params[:'size'] = size
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      header_params[:'userid'] = opts[:'userid'] if !opts[:'userid'].nil?
+      header_params[:'x-token'] = opts[:'x_token'] if !opts[:'x_token'].nil?
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      return_type = opts[:return_type] || 'Array<String>' 
+
+      auth_names = opts[:auth_names] || []
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type)
+
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SearchApi#search_histories\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # 获取搜索日志
+    # 该接口主要用于获取搜索明细
+    # @param app 应用标识
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<Integer>] :indices 只看指定索引
+    # @option opts [String] :scope 搜索范围 (default to all)
+    # @option opts [Integer] :widget 搜索组件 (default to 0)
+    # @option opts [Integer] :query 指定查询 (default to 0)
+    # @option opts [Integer] :recomm 推荐组件 (default to 0)
+    # @option opts [Date] :start_date 统计起始日期
+    # @option opts [Date] :end_date 统计结束日期
+    # @option opts [Integer] :from 起始位置 (default to 0)
+    # @option opts [Integer] :size 每页记录数量 (default to 50)
+    # @return [Array<QueryActionBean>]
+    def search_logs(app, opts = {})
+      data, _status_code, _headers = search_logs_with_http_info(app, opts)
+      data
+    end
+
+    # 获取搜索日志
+    # 该接口主要用于获取搜索明细
+    # @param app 应用标识
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<Integer>] :indices 只看指定索引
+    # @option opts [String] :scope 搜索范围
+    # @option opts [Integer] :widget 搜索组件
+    # @option opts [Integer] :query 指定查询
+    # @option opts [Integer] :recomm 推荐组件
+    # @option opts [Date] :start_date 统计起始日期
+    # @option opts [Date] :end_date 统计结束日期
+    # @option opts [Integer] :from 起始位置
+    # @option opts [Integer] :size 每页记录数量
+    # @return [Array<(Array<QueryActionBean>, Integer, Hash)>] Array<QueryActionBean> data, response status code and response headers
+    def search_logs_with_http_info(app, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SearchApi.search_logs ...'
+      end
+      # verify the required parameter 'app' is set
+      if @api_client.config.client_side_validation && app.nil?
+        fail ArgumentError, "Missing the required parameter 'app' when calling SearchApi.search_logs"
+      end
+      if @api_client.config.client_side_validation && opts[:'scope'] && !['all', 'search', 'recomm'].include?(opts[:'scope'])
+        fail ArgumentError, 'invalid value for "scope", must be one of all, search, recomm'
+      end
+      # resource path
+      local_var_path = '/apps/{app}/logs-searchs'.sub('{' + 'app' + '}', app.to_s)
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'indices'] = @api_client.build_collection_param(opts[:'indices'], :multi) if !opts[:'indices'].nil?
+      query_params[:'scope'] = opts[:'scope'] if !opts[:'scope'].nil?
+      query_params[:'widget'] = opts[:'widget'] if !opts[:'widget'].nil?
+      query_params[:'query'] = opts[:'query'] if !opts[:'query'].nil?
+      query_params[:'recomm'] = opts[:'recomm'] if !opts[:'recomm'].nil?
+      query_params[:'start_date'] = opts[:'start_date'] if !opts[:'start_date'].nil?
+      query_params[:'end_date'] = opts[:'end_date'] if !opts[:'end_date'].nil?
+      query_params[:'from'] = opts[:'from'] if !opts[:'from'].nil?
+      query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      return_type = opts[:return_type] || 'Array<QueryActionBean>' 
+
+      auth_names = opts[:auth_names] || ['TokenAuth']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type)
+
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SearchApi#search_logs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # 获取当前搜索用户的最新搜索记录
+    # @param query 查询唯一标识
+    # @param strategy 搜索记录策略
+    # @param size 数量
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :userid 搜索者的唯一标识，该标识由搜索前端生成，长度不超过64
+    # @option opts [String] :x_token 如果要使用非公开查询，需要组件作者授权
+    # @return [Array<String>]
+    def search_query_histories(query, strategy, size, opts = {})
+      data, _status_code, _headers = search_query_histories_with_http_info(query, strategy, size, opts)
+      data
+    end
+
+    # 获取当前搜索用户的最新搜索记录
+    # @param query 查询唯一标识
+    # @param strategy 搜索记录策略
+    # @param size 数量
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :userid 搜索者的唯一标识，该标识由搜索前端生成，长度不超过64
+    # @option opts [String] :x_token 如果要使用非公开查询，需要组件作者授权
+    # @return [Array<(Array<String>, Integer, Hash)>] Array<String> data, response status code and response headers
+    def search_query_histories_with_http_info(query, strategy, size, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SearchApi.search_query_histories ...'
+      end
+      # verify the required parameter 'query' is set
+      if @api_client.config.client_side_validation && query.nil?
+        fail ArgumentError, "Missing the required parameter 'query' when calling SearchApi.search_query_histories"
+      end
+      # verify the required parameter 'strategy' is set
+      if @api_client.config.client_side_validation && strategy.nil?
+        fail ArgumentError, "Missing the required parameter 'strategy' when calling SearchApi.search_query_histories"
+      end
+      # verify enum value
+      if @api_client.config.client_side_validation && !['recent', 'popular'].include?(strategy)
+        fail ArgumentError, "invalid value for 'strategy', must be one of recent, popular"
+      end
+      # verify the required parameter 'size' is set
+      if @api_client.config.client_side_validation && size.nil?
+        fail ArgumentError, "Missing the required parameter 'size' when calling SearchApi.search_query_histories"
+      end
+      # resource path
+      local_var_path = '/search/query/{query}/histories'.sub('{' + 'query' + '}', query.to_s)
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'strategy'] = strategy
+      query_params[:'size'] = size
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      header_params[:'userid'] = opts[:'userid'] if !opts[:'userid'].nil?
+      header_params[:'x-token'] = opts[:'x_token'] if !opts[:'x_token'].nil?
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      return_type = opts[:return_type] || 'Array<String>' 
+
+      auth_names = opts[:auth_names] || []
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type)
+
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SearchApi#search_query_histories\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # 获取查询相关热词
+    # @param query 查询标识
+    # @param scope 时间范围
+    # @param count 获取热词数量
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :x_token 如果要使用非发布的组件，需要组件作者授权
+    # @option opts [String] :userid 搜索者的唯一标识，该标识由搜索前端生成，长度不超过64
+    # @return [Array<SearchWord>]
+    def search_query_hot_words(query, scope, count, opts = {})
+      data, _status_code, _headers = search_query_hot_words_with_http_info(query, scope, count, opts)
+      data
+    end
+
+    # 获取查询相关热词
+    # @param query 查询标识
+    # @param scope 时间范围
+    # @param count 获取热词数量
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :x_token 如果要使用非发布的组件，需要组件作者授权
+    # @option opts [String] :userid 搜索者的唯一标识，该标识由搜索前端生成，长度不超过64
+    # @return [Array<(Array<SearchWord>, Integer, Hash)>] Array<SearchWord> data, response status code and response headers
+    def search_query_hot_words_with_http_info(query, scope, count, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SearchApi.search_query_hot_words ...'
+      end
+      # verify the required parameter 'query' is set
+      if @api_client.config.client_side_validation && query.nil?
+        fail ArgumentError, "Missing the required parameter 'query' when calling SearchApi.search_query_hot_words"
+      end
+      # verify the required parameter 'scope' is set
+      if @api_client.config.client_side_validation && scope.nil?
+        fail ArgumentError, "Missing the required parameter 'scope' when calling SearchApi.search_query_hot_words"
+      end
+      # verify enum value
+      if @api_client.config.client_side_validation && !['month', 'year', 'all'].include?(scope)
+        fail ArgumentError, "invalid value for 'scope', must be one of month, year, all"
+      end
+      # verify the required parameter 'count' is set
+      if @api_client.config.client_side_validation && count.nil?
+        fail ArgumentError, "Missing the required parameter 'count' when calling SearchApi.search_query_hot_words"
+      end
+      # resource path
+      local_var_path = '/search/query/{query}/hotwords'.sub('{' + 'query' + '}', query.to_s)
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'scope'] = scope
+      query_params[:'count'] = count
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      header_params[:'x-token'] = opts[:'x_token'] if !opts[:'x_token'].nil?
+      header_params[:'userid'] = opts[:'userid'] if !opts[:'userid'].nil?
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      return_type = opts[:return_type] || 'Array<SearchWord>' 
+
+      auth_names = opts[:auth_names] || []
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type)
+
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SearchApi#search_query_hot_words\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # 读取滚动搜索结果
+    # 先调用 search.queryScroll 获取 scroll_id 值以及第一批结果记录，然后使用 scroll_id 值调用该接口获取下一批结果记录，请注意该值的有效期是 1 分钟
+    # @param query 查询标识
+    # @param id scroll_id 值，该值的有效期是 1 分钟
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :x_token 如果要使用非发布的组件，需要组件作者授权
+    # @option opts [String] :userid 搜索者的唯一标识，该标识由搜索前端生成，长度不超过64
+    # @return [Object]
+    def search_query_repeat_scroll(query, id, opts = {})
+      data, _status_code, _headers = search_query_repeat_scroll_with_http_info(query, id, opts)
+      data
+    end
+
+    # 读取滚动搜索结果
+    # 先调用 search.queryScroll 获取 scroll_id 值以及第一批结果记录，然后使用 scroll_id 值调用该接口获取下一批结果记录，请注意该值的有效期是 1 分钟
+    # @param query 查询标识
+    # @param id scroll_id 值，该值的有效期是 1 分钟
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :x_token 如果要使用非发布的组件，需要组件作者授权
+    # @option opts [String] :userid 搜索者的唯一标识，该标识由搜索前端生成，长度不超过64
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def search_query_repeat_scroll_with_http_info(query, id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SearchApi.search_query_repeat_scroll ...'
+      end
+      # verify the required parameter 'query' is set
+      if @api_client.config.client_side_validation && query.nil?
+        fail ArgumentError, "Missing the required parameter 'query' when calling SearchApi.search_query_repeat_scroll"
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling SearchApi.search_query_repeat_scroll"
+      end
+      # resource path
+      local_var_path = '/search/scroll/{query}'.sub('{' + 'query' + '}', query.to_s)
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'id'] = id
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      header_params[:'x-token'] = opts[:'x_token'] if !opts[:'x_token'].nil?
+      header_params[:'userid'] = opts[:'userid'] if !opts[:'userid'].nil?
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      return_type = opts[:return_type] || 'Object' 
+
+      auth_names = opts[:auth_names] || []
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type)
+
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SearchApi#search_query_repeat_scroll\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # 基于查询的滚动搜索
+    # 用于读取超过 10000 条记录的搜索结果，当需要读取大批量查询结果时请采用此接口获得 scroll_id 值，然后再用 POST 方法 queryRepeatScroll 读取剩余的其他结果，每批次的读取间隔不能超过 1 分钟
+    # @param query 查询标识
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :x_token 如果要使用非发布的组件，需要组件作者授权
+    # @option opts [String] :userid 搜索者的唯一标识，该标识由搜索前端生成，长度不超过64
+    # @option opts [Integer] :size 单次滚动的记录数 (default to 100)
+    # @option opts [String] :q 搜索关键字
+    # @option opts [Hash<String, String>] :params 聚合参数
+    # @return [Object]
+    def search_query_scroll(query, opts = {})
+      data, _status_code, _headers = search_query_scroll_with_http_info(query, opts)
+      data
+    end
+
+    # 基于查询的滚动搜索
+    # 用于读取超过 10000 条记录的搜索结果，当需要读取大批量查询结果时请采用此接口获得 scroll_id 值，然后再用 POST 方法 queryRepeatScroll 读取剩余的其他结果，每批次的读取间隔不能超过 1 分钟
+    # @param query 查询标识
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :x_token 如果要使用非发布的组件，需要组件作者授权
+    # @option opts [String] :userid 搜索者的唯一标识，该标识由搜索前端生成，长度不超过64
+    # @option opts [Integer] :size 单次滚动的记录数
+    # @option opts [String] :q 搜索关键字
+    # @option opts [Hash<String, String>] :params 聚合参数
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def search_query_scroll_with_http_info(query, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SearchApi.search_query_scroll ...'
+      end
+      # verify the required parameter 'query' is set
+      if @api_client.config.client_side_validation && query.nil?
+        fail ArgumentError, "Missing the required parameter 'query' when calling SearchApi.search_query_scroll"
+      end
+      # resource path
+      local_var_path = '/search/scroll/{query}'.sub('{' + 'query' + '}', query.to_s)
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
+      query_params[:'q'] = opts[:'q'] if !opts[:'q'].nil?
+      query_params[:'params'] = @api_client.build_collection_param(opts[:'params'], :multi) if !opts[:'params'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      header_params[:'x-token'] = opts[:'x_token'] if !opts[:'x_token'].nil?
+      header_params[:'userid'] = opts[:'userid'] if !opts[:'userid'].nil?
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      return_type = opts[:return_type] || 'Object' 
+
+      auth_names = opts[:auth_names] || []
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type)
+
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SearchApi#search_query_scroll\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # 基于查询的公开搜索
+    # 该接口主要用于公开搜索，如果查询是公开的就不需要授权
+    # @param query 查询标识
+    # @param from 起始记录
+    # @param size 每页记录数量
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :x_token 如果要使用非发布的组件，需要组件作者授权
+    # @option opts [String] :userid 搜索者的唯一标识，该标识由搜索前端生成，长度不超过64
+    # @option opts [String] :q 搜索关键字
+    # @option opts [Hash<String, String>] :params 聚合参数
+    # @return [Object]
+    def search_query_search(query, from, size, opts = {})
+      data, _status_code, _headers = search_query_search_with_http_info(query, from, size, opts)
+      data
+    end
+
+    # 基于查询的公开搜索
+    # 该接口主要用于公开搜索，如果查询是公开的就不需要授权
+    # @param query 查询标识
+    # @param from 起始记录
+    # @param size 每页记录数量
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :x_token 如果要使用非发布的组件，需要组件作者授权
+    # @option opts [String] :userid 搜索者的唯一标识，该标识由搜索前端生成，长度不超过64
+    # @option opts [String] :q 搜索关键字
+    # @option opts [Hash<String, String>] :params 聚合参数
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def search_query_search_with_http_info(query, from, size, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SearchApi.search_query_search ...'
+      end
+      # verify the required parameter 'query' is set
+      if @api_client.config.client_side_validation && query.nil?
+        fail ArgumentError, "Missing the required parameter 'query' when calling SearchApi.search_query_search"
+      end
+      # verify the required parameter 'from' is set
+      if @api_client.config.client_side_validation && from.nil?
+        fail ArgumentError, "Missing the required parameter 'from' when calling SearchApi.search_query_search"
+      end
+      # verify the required parameter 'size' is set
+      if @api_client.config.client_side_validation && size.nil?
+        fail ArgumentError, "Missing the required parameter 'size' when calling SearchApi.search_query_search"
+      end
+      # resource path
+      local_var_path = '/search/query/{query}'.sub('{' + 'query' + '}', query.to_s)
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'from'] = from
+      query_params[:'size'] = size
+      query_params[:'q'] = opts[:'q'] if !opts[:'q'].nil?
+      query_params[:'params'] = @api_client.build_collection_param(opts[:'params'], :multi) if !opts[:'params'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      header_params[:'x-token'] = opts[:'x_token'] if !opts[:'x_token'].nil?
+      header_params[:'userid'] = opts[:'userid'] if !opts[:'userid'].nil?
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      return_type = opts[:return_type] || 'Object' 
+
+      auth_names = opts[:auth_names] || []
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type)
+
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SearchApi#search_query_search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # 基于组件的搜索词自动完成
+    # 该接口主要为搜索输入框提供自动完成的功能
+    # @param widget 组件唯一标识
+    # @param query 查询编号
+    # @param q 搜索关键字
+    # @param size 数量
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :userid 搜索者的唯一标识，该标识由搜索前端生成，长度不超过64
+    # @option opts [String] :x_token 如果要使用非发布的组件，需要组件作者授权
+    # @return [Array<AutoCompleteItem>]
+    def search_widget_auto_complete(widget, query, q, size, opts = {})
+      data, _status_code, _headers = search_widget_auto_complete_with_http_info(widget, query, q, size, opts)
+      data
+    end
+
+    # 基于组件的搜索词自动完成
+    # 该接口主要为搜索输入框提供自动完成的功能
+    # @param widget 组件唯一标识
+    # @param query 查询编号
+    # @param q 搜索关键字
+    # @param size 数量
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :userid 搜索者的唯一标识，该标识由搜索前端生成，长度不超过64
+    # @option opts [String] :x_token 如果要使用非发布的组件，需要组件作者授权
+    # @return [Array<(Array<AutoCompleteItem>, Integer, Hash)>] Array<AutoCompleteItem> data, response status code and response headers
+    def search_widget_auto_complete_with_http_info(widget, query, q, size, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SearchApi.search_widget_auto_complete ...'
+      end
+      # verify the required parameter 'widget' is set
+      if @api_client.config.client_side_validation && widget.nil?
+        fail ArgumentError, "Missing the required parameter 'widget' when calling SearchApi.search_widget_auto_complete"
+      end
+      # verify the required parameter 'query' is set
+      if @api_client.config.client_side_validation && query.nil?
+        fail ArgumentError, "Missing the required parameter 'query' when calling SearchApi.search_widget_auto_complete"
+      end
+      # verify the required parameter 'q' is set
+      if @api_client.config.client_side_validation && q.nil?
+        fail ArgumentError, "Missing the required parameter 'q' when calling SearchApi.search_widget_auto_complete"
+      end
+      # verify the required parameter 'size' is set
+      if @api_client.config.client_side_validation && size.nil?
+        fail ArgumentError, "Missing the required parameter 'size' when calling SearchApi.search_widget_auto_complete"
+      end
+      # resource path
+      local_var_path = '/search/widget/{widget}/autocomplete'.sub('{' + 'widget' + '}', widget.to_s)
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'query'] = query
+      query_params[:'q'] = q
+      query_params[:'size'] = size
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      header_params[:'userid'] = opts[:'userid'] if !opts[:'userid'].nil?
+      header_params[:'x-token'] = opts[:'x_token'] if !opts[:'x_token'].nil?
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      return_type = opts[:return_type] || 'Array<AutoCompleteItem>' 
+
+      auth_names = opts[:auth_names] || []
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type)
+
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SearchApi#search_widget_auto_complete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # 获取组件搜索的相关热词
+    # @param widget 组件唯一标识
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :x_token 如果要使用非发布的组件，需要组件作者授权
+    # @option opts [String] :userid 搜索者的唯一标识，该标识由搜索前端生成，长度不超过64
+    # @option opts [Integer] :query 查询编号
+    # @option opts [String] :scope 时间范围
+    # @option opts [Integer] :count 获取热词数量 (default to 10)
+    # @return [Array<SearchWord>]
+    def search_widget_hot_words(widget, opts = {})
+      data, _status_code, _headers = search_widget_hot_words_with_http_info(widget, opts)
+      data
+    end
+
+    # 获取组件搜索的相关热词
+    # @param widget 组件唯一标识
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :x_token 如果要使用非发布的组件，需要组件作者授权
+    # @option opts [String] :userid 搜索者的唯一标识，该标识由搜索前端生成，长度不超过64
+    # @option opts [Integer] :query 查询编号
+    # @option opts [String] :scope 时间范围
+    # @option opts [Integer] :count 获取热词数量
+    # @return [Array<(Array<SearchWord>, Integer, Hash)>] Array<SearchWord> data, response status code and response headers
+    def search_widget_hot_words_with_http_info(widget, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SearchApi.search_widget_hot_words ...'
+      end
+      # verify the required parameter 'widget' is set
+      if @api_client.config.client_side_validation && widget.nil?
+        fail ArgumentError, "Missing the required parameter 'widget' when calling SearchApi.search_widget_hot_words"
+      end
+      if @api_client.config.client_side_validation && opts[:'scope'] && !['month', 'year', 'all', 'custom'].include?(opts[:'scope'])
+        fail ArgumentError, 'invalid value for "scope", must be one of month, year, all, custom'
+      end
+      # resource path
+      local_var_path = '/search/widget/{widget}/hotwords'.sub('{' + 'widget' + '}', widget.to_s)
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'query'] = opts[:'query'] if !opts[:'query'].nil?
+      query_params[:'scope'] = opts[:'scope'] if !opts[:'scope'].nil?
+      query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      header_params[:'x-token'] = opts[:'x_token'] if !opts[:'x_token'].nil?
+      header_params[:'userid'] = opts[:'userid'] if !opts[:'userid'].nil?
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      return_type = opts[:return_type] || 'Array<SearchWord>' 
+
+      auth_names = opts[:auth_names] || []
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type)
+
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SearchApi#search_widget_hot_words\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # 基于组件的公开搜索
+    # 该接口主要为UI组件提供公开搜索
+    # @param widget 组件唯一标识
+    # @param query 查询编号
+    # @param from 起始记录
+    # @param size 每页记录数量, 如果值小于0则使用预设值的记录数
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :userid 搜索者的唯一标识，该标识由搜索前端生成，长度不超过64
+    # @option opts [String] :x_token 如果要使用非发布的组件，需要组件作者授权
+    # @option opts [String] :original 搜索动作的延续，在 Web 组件中一边输入即时搜索时，使用的是同一个 original，original 值等于第一个搜索动作产生结果中的 action 值
+    # @option opts [String] :q 搜索关键字
+    # @option opts [Hash<String, String>] :params 聚合参数
+    # @return [Object]
+    def search_widget_search(widget, query, from, size, opts = {})
+      data, _status_code, _headers = search_widget_search_with_http_info(widget, query, from, size, opts)
+      data
+    end
+
+    # 基于组件的公开搜索
+    # 该接口主要为UI组件提供公开搜索
+    # @param widget 组件唯一标识
+    # @param query 查询编号
+    # @param from 起始记录
+    # @param size 每页记录数量, 如果值小于0则使用预设值的记录数
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :userid 搜索者的唯一标识，该标识由搜索前端生成，长度不超过64
+    # @option opts [String] :x_token 如果要使用非发布的组件，需要组件作者授权
+    # @option opts [String] :original 搜索动作的延续，在 Web 组件中一边输入即时搜索时，使用的是同一个 original，original 值等于第一个搜索动作产生结果中的 action 值
+    # @option opts [String] :q 搜索关键字
+    # @option opts [Hash<String, String>] :params 聚合参数
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def search_widget_search_with_http_info(widget, query, from, size, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SearchApi.search_widget_search ...'
+      end
+      # verify the required parameter 'widget' is set
+      if @api_client.config.client_side_validation && widget.nil?
+        fail ArgumentError, "Missing the required parameter 'widget' when calling SearchApi.search_widget_search"
+      end
+      # verify the required parameter 'query' is set
+      if @api_client.config.client_side_validation && query.nil?
+        fail ArgumentError, "Missing the required parameter 'query' when calling SearchApi.search_widget_search"
+      end
+      # verify the required parameter 'from' is set
+      if @api_client.config.client_side_validation && from.nil?
+        fail ArgumentError, "Missing the required parameter 'from' when calling SearchApi.search_widget_search"
+      end
+      # verify the required parameter 'size' is set
+      if @api_client.config.client_side_validation && size.nil?
+        fail ArgumentError, "Missing the required parameter 'size' when calling SearchApi.search_widget_search"
+      end
+      # resource path
+      local_var_path = '/search/widget/{widget}'.sub('{' + 'widget' + '}', widget.to_s)
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'query'] = query
+      query_params[:'from'] = from
+      query_params[:'size'] = size
+      query_params[:'q'] = opts[:'q'] if !opts[:'q'].nil?
+      query_params[:'params'] = @api_client.build_collection_param(opts[:'params'], :multi) if !opts[:'params'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      header_params[:'userid'] = opts[:'userid'] if !opts[:'userid'].nil?
+      header_params[:'x-token'] = opts[:'x_token'] if !opts[:'x_token'].nil?
+      header_params[:'original'] = opts[:'original'] if !opts[:'original'].nil?
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      return_type = opts[:return_type] || 'Object' 
+
+      auth_names = opts[:auth_names] || []
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type)
+
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SearchApi#search_widget_search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end