Class: AsposeImagingCloud::FindImagesByTagsRequest

Inherits:
ImagingRequest show all
Defined in:
lib/aspose-imaging-cloud/models/requests/find_images_by_tags_request.rb

Overview

Request model for find_images_by_tags operation.

Instance Method Summary collapse

Constructor Details

#initialize(tags, search_context_id, similarity_threshold, max_count, folder = nil, storage = nil) ⇒ FindImagesByTagsRequest

Find images by tags. Tags JSON string is passed as zero-indexed multipart/form-data content or as raw body stream.

Parameters:

  • tags (String) —

    Tags array for searching

  • search_context_id (String) —

    The search context identifier.

  • similarity_threshold (Float) —

    The similarity threshold.

  • max_count (Integer) —

    The maximum count.

  • folder (String) (defaults to: nil) —

    The folder.

  • storage (String) (defaults to: nil) —

    The storage.



41
42
43
44
45
46
47
48
 
# File 'lib/aspose-imaging-cloud/models/requests/find_images_by_tags_request.rb', line 41

def initialize(tags, search_context_id, similarity_threshold, max_count, folder = nil, storage = nil)
  @tags = tags
  @search_context_id = search_context_id
  @similarity_threshold = similarity_threshold
  @max_count = max_count
  @folder = folder
  @storage = storage
end

Instance Method Details

#to_http_info(config) ⇒ Object 



50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/aspose-imaging-cloud/models/requests/find_images_by_tags_request.rb', line 50

def to_http_info(config)
  # verify the required parameter 'tags' is set
  if config.client_side_validation && @tags.nil?
    raise ArgumentError, "Missing the required parameter 'tags' when calling ImagingApi.find_images_by_tags"
  end

  # verify the required parameter 'search_context_id' is set
  if config.client_side_validation && @search_context_id.nil?
    raise ArgumentError, "Missing the required parameter 'search_context_id' when calling ImagingApi.find_images_by_tags"
  end

  # verify the required parameter 'similarity_threshold' is set
  if config.client_side_validation && @similarity_threshold.nil?
    raise ArgumentError, "Missing the required parameter 'similarity_threshold' when calling ImagingApi.find_images_by_tags"
  end

  # verify the required parameter 'max_count' is set
  if config.client_side_validation && @max_count.nil?
    raise ArgumentError, "Missing the required parameter 'max_count' when calling ImagingApi.find_images_by_tags"
  end

  # resource path
  local_var_path = '/imaging/ai/imageSearch/{searchContextId}/findByTags'.sub('{' + 'searchContextId' + '}', @search_context_id.to_s)

  # query parameters
  query_params = {}
  query_params[:similarityThreshold] = @similarity_threshold
  query_params[:maxCount] = @max_count
  query_params[:folder] = @folder unless @folder.nil?
  query_params[:storage] = @storage unless @storage.nil?

  # form parameters
  form_params = {}
  form_params['tags'] = @tags

  # http body (model)
  post_body = nil
  auth_names = ['JWT']

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = form_params.any? ? 'multipart/form-data' : select_header_content_type(['application/json', 'multipart/form-data'])

  AsposeImagingCloud::HttpRequest.new(local_var_path,
                                  header_params,
                                  query_params,
                                  form_params,
                                  post_body,
                                  auth_names)
end