class RecombeeApiClient::CreateManualReqlSegmentation
Segment the items using multiple [ReQL](docs.recombee.com/reql.html) filters.
Use the Add Manual ReQL Items Segment endpoint to create the individual segments.
Attributes
Public Class Methods
Source
# File lib/recombee_api_client/api/create_manual_reql_segmentation.rb, line 31 def initialize(segmentation_id, source_type, optional = {}) @segmentation_id = segmentation_id @source_type = source_type optional = normalize_optional(optional) @title = optional['title'] @description = optional['description'] @optional = optional @timeout = 10000 @ensure_https = false @optional.each do |par, _| fail UnknownOptionalParameter.new(par) unless ["title","description"].include? par end end
-
*Required arguments*
-
segmentation_id
-> ID of the newly created Segmentation -
source_type
-> What type of data should be segmented. Currently only ‘items` are supported.
-
-
*Optional arguments (given as hash optional)*
-
title
-> Human-readable name that is shown in the Recombee Admin UI. -
description
-> Description that is shown in the Recombee Admin UI.
-
Public Instance Methods
Source
# File lib/recombee_api_client/api/create_manual_reql_segmentation.rb, line 51 def body_parameters p = Hash.new p['sourceType'] = @source_type p['title'] = @optional['title'] if @optional.include? 'title' p['description'] = @optional['description'] if @optional.include? 'description' p end
Values of body parameters as a Hash
Source
# File lib/recombee_api_client/api/create_manual_reql_segmentation.rb, line 46 def method :put end
HTTP method
Source
# File lib/recombee_api_client/api/create_manual_reql_segmentation.rb, line 67 def path "/{databaseId}/segmentations/manual-reql/#{@segmentation_id}" end
Relative path to the endpoint
Source
# File lib/recombee_api_client/api/create_manual_reql_segmentation.rb, line 61 def query_parameters params = {} params end
Values of query parameters as a Hash. name of parameter => value of the parameter