Class: MailSlurpClient::AIControllerApi

Inherits:
Object
  • Object
show all
Defined in:
lib/mailslurp_client/api/ai_controller_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ AIControllerApi

Returns a new instance of AIControllerApi.



19
20
21
 
# File 'lib/mailslurp_client/api/ai_controller_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/mailslurp_client/api/ai_controller_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_transformer(ai_transform_create_options, opts = {}) ⇒ AITransformDto

Create a transformer for reuse in automations Save an AI transform instructions and schema for use with webhooks and automations

Parameters:

Returns:



27
28
29
30
 
# File 'lib/mailslurp_client/api/ai_controller_api.rb', line 27

def create_transformer(ai_transform_create_options, opts = {})
  data, _status_code, _headers = create_transformer_with_http_info(ai_transform_create_options, opts)
  data
end

#create_transformer_mappings(create_ai_transformer_mapping_options, opts = {}) ⇒ AITransformMappingDto

Create transformer mapping Create AI transformer mappings to other entities

Parameters:

Returns:



91
92
93
94
 
# File 'lib/mailslurp_client/api/ai_controller_api.rb', line 91

def create_transformer_mappings(create_ai_transformer_mapping_options, opts = {})
  data, _status_code, _headers = create_transformer_mappings_with_http_info(create_ai_transformer_mapping_options, opts)
  data
end

#create_transformer_mappings_with_http_info(create_ai_transformer_mapping_options, opts = {}) ⇒ Array<(AITransformMappingDto, Integer, Hash)>

Create transformer mapping Create AI transformer mappings to other entities

Parameters:

Returns:

  • (Array<(AITransformMappingDto, Integer, Hash)>) —

    AITransformMappingDto data, response status code and response headers



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/mailslurp_client/api/ai_controller_api.rb', line 101

def create_transformer_mappings_with_http_info(create_ai_transformer_mapping_options, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AIControllerApi.create_transformer_mappings ...'
  end
  # verify the required parameter 'create_ai_transformer_mapping_options' is set
  if @api_client.config.client_side_validation && create_ai_transformer_mapping_options.nil?
    fail ArgumentError, "Missing the required parameter 'create_ai_transformer_mapping_options' when calling AIControllerApi.create_transformer_mappings"
  end
  # resource path
  local_var_path = '/ai/transformer/mappings'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(create_ai_transformer_mapping_options) 

  # return_type
  return_type = opts[:return_type] || 'AITransformMappingDto' 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AIControllerApi#create_transformer_mappings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_transformer_with_http_info(ai_transform_create_options, opts = {}) ⇒ Array<(AITransformDto, Integer, Hash)>

Create a transformer for reuse in automations Save an AI transform instructions and schema for use with webhooks and automations

Parameters:

Returns:

  • (Array<(AITransformDto, Integer, Hash)>) —

    AITransformDto data, response status code and response headers



37
38
39
40
41
42
43
44
45
46
47
48
49
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
 
# File 'lib/mailslurp_client/api/ai_controller_api.rb', line 37

def create_transformer_with_http_info(ai_transform_create_options, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AIControllerApi.create_transformer ...'
  end
  # verify the required parameter 'ai_transform_create_options' is set
  if @api_client.config.client_side_validation && ai_transform_create_options.nil?
    fail ArgumentError, "Missing the required parameter 'ai_transform_create_options' when calling AIControllerApi.create_transformer"
  end
  # resource path
  local_var_path = '/ai/transformer'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(ai_transform_create_options) 

  # return_type
  return_type = opts[:return_type] || 'AITransformDto' 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AIControllerApi#create_transformer\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_all_transformer_mappings(opts = {}) ⇒ nil

Delete all transformer mapping Delete all AI transformer mappings

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


154
155
156
157
 
# File 'lib/mailslurp_client/api/ai_controller_api.rb', line 154

def delete_all_transformer_mappings(opts = {})
  delete_all_transformer_mappings_with_http_info(opts)
  nil
end

#delete_all_transformer_mappings_with_http_info(opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete all transformer mapping Delete all AI transformer mappings

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/mailslurp_client/api/ai_controller_api.rb', line 163

def delete_all_transformer_mappings_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AIControllerApi.delete_all_transformer_mappings ...'
  end
  # resource path
  local_var_path = '/ai/transformer/mappings'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AIControllerApi#delete_all_transformer_mappings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_transformer(id, opts = {}) ⇒ nil

Delete a transformer Delete an AI transformer and schemas by ID

Parameters:

  • id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


209
210
211
212
 
# File 'lib/mailslurp_client/api/ai_controller_api.rb', line 209

def delete_transformer(id, opts = {})
  delete_transformer_with_http_info(id, opts)
  nil
end

#delete_transformer_mapping(id, opts = {}) ⇒ nil

Delete transformer mapping Delete an AI transformer mapping

Parameters:

  • id (String) —

    ID of transform mapping

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


269
270
271
272
 
# File 'lib/mailslurp_client/api/ai_controller_api.rb', line 269

def delete_transformer_mapping(id, opts = {})
  delete_transformer_mapping_with_http_info(id, opts)
  nil
end

#delete_transformer_mapping_with_http_info(id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete transformer mapping Delete an AI transformer mapping

Parameters:

  • id (String) —

    ID of transform mapping

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
 
# File 'lib/mailslurp_client/api/ai_controller_api.rb', line 279

def delete_transformer_mapping_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AIControllerApi.delete_transformer_mapping ...'
  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 AIControllerApi.delete_transformer_mapping"
  end
  # resource path
  local_var_path = '/ai/transformer/mappings/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AIControllerApi#delete_transformer_mapping\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_transformer_with_http_info(id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete a transformer Delete an AI transformer and schemas by ID

Parameters:

  • id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/mailslurp_client/api/ai_controller_api.rb', line 219

def delete_transformer_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AIControllerApi.delete_transformer ...'
  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 AIControllerApi.delete_transformer"
  end
  # resource path
  local_var_path = '/ai/transformer/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AIControllerApi#delete_transformer\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_transformers(opts = {}) ⇒ nil

Delete all transformers Delete all AI transformers and schemas

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


328
329
330
331
 
# File 'lib/mailslurp_client/api/ai_controller_api.rb', line 328

def delete_transformers(opts = {})
  delete_transformers_with_http_info(opts)
  nil
end

#delete_transformers_with_http_info(opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete all transformers Delete all AI transformers and schemas

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
 
# File 'lib/mailslurp_client/api/ai_controller_api.rb', line 337

def delete_transformers_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AIControllerApi.delete_transformers ...'
  end
  # resource path
  local_var_path = '/ai/transformer'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AIControllerApi#delete_transformers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#export_transformer_results(export_transformer_options, opts = {}) ⇒ ExportTransformerResponse

Export transformer results Export AI transformer results in formats such as Excel, CSV, XML etc.

Parameters:

Returns:



383
384
385
386
 
# File 'lib/mailslurp_client/api/ai_controller_api.rb', line 383

def export_transformer_results(export_transformer_options, opts = {})
  data, _status_code, _headers = export_transformer_results_with_http_info(export_transformer_options, opts)
  data
end

#export_transformer_results_with_http_info(export_transformer_options, opts = {}) ⇒ Array<(ExportTransformerResponse, Integer, Hash)>

Export transformer results Export AI transformer results in formats such as Excel, CSV, XML etc.

Parameters:

Returns:

  • (Array<(ExportTransformerResponse, Integer, Hash)>) —

    ExportTransformerResponse data, response status code and response headers



393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
 
# File 'lib/mailslurp_client/api/ai_controller_api.rb', line 393

def export_transformer_results_with_http_info(export_transformer_options, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AIControllerApi.export_transformer_results ...'
  end
  # verify the required parameter 'export_transformer_options' is set
  if @api_client.config.client_side_validation && export_transformer_options.nil?
    fail ArgumentError, "Missing the required parameter 'export_transformer_options' when calling AIControllerApi.export_transformer_results"
  end
  # resource path
  local_var_path = '/ai/transformer/results/export'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(export_transformer_options) 

  # return_type
  return_type = opts[:return_type] || 'ExportTransformerResponse' 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AIControllerApi#export_transformer_results\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#generate_structured_content_from_attachment(generate_structured_content_attachment_options, opts = {}) ⇒ StructuredContentResultDto

Generate structured content for an attachment Use output schemas to extract data from an attachment using AI

Parameters:

Returns:



447
448
449
450
 
# File 'lib/mailslurp_client/api/ai_controller_api.rb', line 447

def generate_structured_content_from_attachment(generate_structured_content_attachment_options, opts = {})
  data, _status_code, _headers = generate_structured_content_from_attachment_with_http_info(generate_structured_content_attachment_options, opts)
  data
end

#generate_structured_content_from_attachment_with_http_info(generate_structured_content_attachment_options, opts = {}) ⇒ Array<(StructuredContentResultDto, Integer, Hash)>

Generate structured content for an attachment Use output schemas to extract data from an attachment using AI

Parameters:

Returns:

  • (Array<(StructuredContentResultDto, Integer, Hash)>) —

    StructuredContentResultDto data, response status code and response headers



457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
 
# File 'lib/mailslurp_client/api/ai_controller_api.rb', line 457

def generate_structured_content_from_attachment_with_http_info(generate_structured_content_attachment_options, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AIControllerApi.generate_structured_content_from_attachment ...'
  end
  # verify the required parameter 'generate_structured_content_attachment_options' is set
  if @api_client.config.client_side_validation && generate_structured_content_attachment_options.nil?
    fail ArgumentError, "Missing the required parameter 'generate_structured_content_attachment_options' when calling AIControllerApi.generate_structured_content_from_attachment"
  end
  # resource path
  local_var_path = '/ai/structured-content/attachment'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(generate_structured_content_attachment_options) 

  # return_type
  return_type = opts[:return_type] || 'StructuredContentResultDto' 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AIControllerApi#generate_structured_content_from_attachment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#generate_structured_content_from_email(generate_structured_content_email_options, opts = {}) ⇒ StructuredContentResultDto

Generate structured content for an email Use output schemas to extract data from an email using AI

Parameters:

Returns:



511
512
513
514
 
# File 'lib/mailslurp_client/api/ai_controller_api.rb', line 511

def generate_structured_content_from_email(generate_structured_content_email_options, opts = {})
  data, _status_code, _headers = generate_structured_content_from_email_with_http_info(generate_structured_content_email_options, opts)
  data
end

#generate_structured_content_from_email_with_http_info(generate_structured_content_email_options, opts = {}) ⇒ Array<(StructuredContentResultDto, Integer, Hash)>

Generate structured content for an email Use output schemas to extract data from an email using AI

Parameters:

Returns:

  • (Array<(StructuredContentResultDto, Integer, Hash)>) —

    StructuredContentResultDto data, response status code and response headers



521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
 
# File 'lib/mailslurp_client/api/ai_controller_api.rb', line 521

def generate_structured_content_from_email_with_http_info(generate_structured_content_email_options, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AIControllerApi.generate_structured_content_from_email ...'
  end
  # verify the required parameter 'generate_structured_content_email_options' is set
  if @api_client.config.client_side_validation && generate_structured_content_email_options.nil?
    fail ArgumentError, "Missing the required parameter 'generate_structured_content_email_options' when calling AIControllerApi.generate_structured_content_from_email"
  end
  # resource path
  local_var_path = '/ai/structured-content/email'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(generate_structured_content_email_options) 

  # return_type
  return_type = opts[:return_type] || 'StructuredContentResultDto' 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AIControllerApi#generate_structured_content_from_email\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#generate_structured_content_from_sms(generate_structured_content_sms_options, opts = {}) ⇒ StructuredContentResultDto

Generate structured content for a TXT message Use output schemas to extract data from an SMS using AI

Parameters:

Returns:



575
576
577
578
 
# File 'lib/mailslurp_client/api/ai_controller_api.rb', line 575

def generate_structured_content_from_sms(generate_structured_content_sms_options, opts = {})
  data, _status_code, _headers = generate_structured_content_from_sms_with_http_info(generate_structured_content_sms_options, opts)
  data
end

#generate_structured_content_from_sms_with_http_info(generate_structured_content_sms_options, opts = {}) ⇒ Array<(StructuredContentResultDto, Integer, Hash)>

Generate structured content for a TXT message Use output schemas to extract data from an SMS using AI

Parameters:

Returns:

  • (Array<(StructuredContentResultDto, Integer, Hash)>) —

    StructuredContentResultDto data, response status code and response headers



585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
 
# File 'lib/mailslurp_client/api/ai_controller_api.rb', line 585

def generate_structured_content_from_sms_with_http_info(generate_structured_content_sms_options, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AIControllerApi.generate_structured_content_from_sms ...'
  end
  # verify the required parameter 'generate_structured_content_sms_options' is set
  if @api_client.config.client_side_validation && generate_structured_content_sms_options.nil?
    fail ArgumentError, "Missing the required parameter 'generate_structured_content_sms_options' when calling AIControllerApi.generate_structured_content_from_sms"
  end
  # resource path
  local_var_path = '/ai/structured-content/sms'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(generate_structured_content_sms_options) 

  # return_type
  return_type = opts[:return_type] || 'StructuredContentResultDto' 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AIControllerApi#generate_structured_content_from_sms\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_export_transformer_results_job(id, opts = {}) ⇒ ExportTransformerResultJobDto

Get export transformer results job Get the job status for an export

Parameters:

  • id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



639
640
641
642
 
# File 'lib/mailslurp_client/api/ai_controller_api.rb', line 639

def get_export_transformer_results_job(id, opts = {})
  data, _status_code, _headers = get_export_transformer_results_job_with_http_info(id, opts)
  data
end

#get_export_transformer_results_job_with_http_info(id, opts = {}) ⇒ Array<(ExportTransformerResultJobDto, Integer, Hash)>

Get export transformer results job Get the job status for an export

Parameters:

  • id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
 
# File 'lib/mailslurp_client/api/ai_controller_api.rb', line 649

def get_export_transformer_results_job_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AIControllerApi.get_export_transformer_results_job ...'
  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 AIControllerApi.get_export_transformer_results_job"
  end
  # resource path
  local_var_path = '/ai/transformer/results/export/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'ExportTransformerResultJobDto' 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AIControllerApi#get_export_transformer_results_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_transformer(id, opts = {}) ⇒ AITransformDto

Get a transformer Get AI transformer and schemas by ID

Parameters:

  • id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



701
702
703
704
 
# File 'lib/mailslurp_client/api/ai_controller_api.rb', line 701

def get_transformer(id, opts = {})
  data, _status_code, _headers = get_transformer_with_http_info(id, opts)
  data
end

#get_transformer_mapping(id, opts = {}) ⇒ AITransformMappingDto

Get transformer mapping Get an AI transformer mapping

Parameters:

  • id (String) —

    ID of transform mapping

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



763
764
765
766
 
# File 'lib/mailslurp_client/api/ai_controller_api.rb', line 763

def get_transformer_mapping(id, opts = {})
  data, _status_code, _headers = get_transformer_mapping_with_http_info(id, opts)
  data
end

#get_transformer_mapping_with_http_info(id, opts = {}) ⇒ Array<(AITransformMappingDto, Integer, Hash)>

Get transformer mapping Get an AI transformer mapping

Parameters:

  • id (String) —

    ID of transform mapping

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(AITransformMappingDto, Integer, Hash)>) —

    AITransformMappingDto data, response status code and response headers



773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
 
# File 'lib/mailslurp_client/api/ai_controller_api.rb', line 773

def get_transformer_mapping_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AIControllerApi.get_transformer_mapping ...'
  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 AIControllerApi.get_transformer_mapping"
  end
  # resource path
  local_var_path = '/ai/transformer/mappings/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'AITransformMappingDto' 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AIControllerApi#get_transformer_mapping\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_transformer_mappings(opts = {}) ⇒ PageAITransformMappingProjection

Get transformer mappings Get AI transformer mappings to other entities

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :ai_transform_id (String)
  • :entity_id (String)
  • :entity_type (String)
  • :page (Integer) — default: default to 0
  • :size (Integer) —

    Optional page size. Maximum size is 100. Use page index and sort to page through larger results (default to 20)

  • :sort (String) —

    Optional createdAt sort direction ASC or DESC (default to 'ASC')

Returns:



830
831
832
833
 
# File 'lib/mailslurp_client/api/ai_controller_api.rb', line 830

def get_transformer_mappings(opts = {})
  data, _status_code, _headers = get_transformer_mappings_with_http_info(opts)
  data
end

#get_transformer_mappings_with_http_info(opts = {}) ⇒ Array<(PageAITransformMappingProjection, Integer, Hash)>

Get transformer mappings Get AI transformer mappings to other entities

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :ai_transform_id (String)
  • :entity_id (String)
  • :entity_type (String)
  • :page (Integer)
  • :size (Integer) —

    Optional page size. Maximum size is 100. Use page index and sort to page through larger results

  • :sort (String) —

    Optional createdAt sort direction ASC or DESC

Returns:



845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
 
# File 'lib/mailslurp_client/api/ai_controller_api.rb', line 845

def get_transformer_mappings_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AIControllerApi.get_transformer_mappings ...'
  end
  allowable_values = ["INBOX", "PHONE"]
  if @api_client.config.client_side_validation && opts[:'entity_type'] && !allowable_values.include?(opts[:'entity_type'])
    fail ArgumentError, "invalid value for \"entity_type\", must be one of #{allowable_values}"
  end
  if @api_client.config.client_side_validation && !opts[:'size'].nil? && opts[:'size'] > 100
    fail ArgumentError, 'invalid value for "opts[:"size"]" when calling AIControllerApi.get_transformer_mappings, must be smaller than or equal to 100.'
  end

  allowable_values = ["ASC", "DESC"]
  if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
    fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/ai/transformer/mappings'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'aiTransformId'] = opts[:'ai_transform_id'] if !opts[:'ai_transform_id'].nil?
  query_params[:'entityId'] = opts[:'entity_id'] if !opts[:'entity_id'].nil?
  query_params[:'entityType'] = opts[:'entity_type'] if !opts[:'entity_type'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'PageAITransformMappingProjection' 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AIControllerApi#get_transformer_mappings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_transformer_result(id, opts = {}) ⇒ AITransformResultDto

Get transformer result Get AI transformer result

Parameters:

  • id (String) —

    ID of transform result

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



911
912
913
914
 
# File 'lib/mailslurp_client/api/ai_controller_api.rb', line 911

def get_transformer_result(id, opts = {})
  data, _status_code, _headers = get_transformer_result_with_http_info(id, opts)
  data
end

#get_transformer_result_with_http_info(id, opts = {}) ⇒ Array<(AITransformResultDto, Integer, Hash)>

Get transformer result Get AI transformer result

Parameters:

  • id (String) —

    ID of transform result

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(AITransformResultDto, Integer, Hash)>) —

    AITransformResultDto data, response status code and response headers



921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
 
# File 'lib/mailslurp_client/api/ai_controller_api.rb', line 921

def get_transformer_result_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AIControllerApi.get_transformer_result ...'
  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 AIControllerApi.get_transformer_result"
  end
  # resource path
  local_var_path = '/ai/transformer/results/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'AITransformResultDto' 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AIControllerApi#get_transformer_result\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_transformer_results(opts = {}) ⇒ PageAITransformResultProjection

Get transformer results Get AI transformer results

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :email_id (String)
  • :sms_id (String)
  • :attachment_id (String)
  • :ai_transform_id (String)
  • :ai_transform_mapping_id (String)
  • :entity_id (String)
  • :entity_type (String)
  • :page (Integer) — default: default to 0
  • :size (Integer) —

    Optional page size. Maximum size is 100. Use page index and sort to page through larger results (default to 20)

  • :sort (String) —

    Optional createdAt sort direction ASC or DESC (default to 'ASC')

Returns:



982
983
984
985
 
# File 'lib/mailslurp_client/api/ai_controller_api.rb', line 982

def get_transformer_results(opts = {})
  data, _status_code, _headers = get_transformer_results_with_http_info(opts)
  data
end

#get_transformer_results_table(include_meta_data, flatten_arrays_to_rows, opts = {}) ⇒ PageTableData

Get transformer results table Get AI transformer results in table format

Parameters:

  • include_meta_data (Boolean)
  • flatten_arrays_to_rows (Boolean)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :email_id (String)
  • :sms_id (String)
  • :attachment_id (String)
  • :ai_transform_id (String)
  • :ai_transform_mapping_id (String)
  • :entity_id (String)
  • :entity_type (String)
  • :page (Integer) — default: default to 0
  • :size (Integer) —

    Optional page size. Maximum size is 100. Use page index and sort to page through larger results (default to 20)

  • :sort (String) —

    Optional createdAt sort direction ASC or DESC (default to 'ASC')

Returns:



1082
1083
1084
1085
 
# File 'lib/mailslurp_client/api/ai_controller_api.rb', line 1082

def get_transformer_results_table(include_meta_data, flatten_arrays_to_rows, opts = {})
  data, _status_code, _headers = get_transformer_results_table_with_http_info(include_meta_data, flatten_arrays_to_rows, opts)
  data
end

#get_transformer_results_table_with_http_info(include_meta_data, flatten_arrays_to_rows, opts = {}) ⇒ Array<(PageTableData, Integer, Hash)>

Get transformer results table Get AI transformer results in table format

Parameters:

  • include_meta_data (Boolean)
  • flatten_arrays_to_rows (Boolean)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :email_id (String)
  • :sms_id (String)
  • :attachment_id (String)
  • :ai_transform_id (String)
  • :ai_transform_mapping_id (String)
  • :entity_id (String)
  • :entity_type (String)
  • :page (Integer)
  • :size (Integer) —

    Optional page size. Maximum size is 100. Use page index and sort to page through larger results

  • :sort (String) —

    Optional createdAt sort direction ASC or DESC

Returns:

  • (Array<(PageTableData, Integer, Hash)>) —

    PageTableData data, response status code and response headers



1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
 
# File 'lib/mailslurp_client/api/ai_controller_api.rb', line 1103

def get_transformer_results_table_with_http_info(include_meta_data, flatten_arrays_to_rows, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AIControllerApi.get_transformer_results_table ...'
  end
  # verify the required parameter 'include_meta_data' is set
  if @api_client.config.client_side_validation && include_meta_data.nil?
    fail ArgumentError, "Missing the required parameter 'include_meta_data' when calling AIControllerApi.get_transformer_results_table"
  end
  # verify the required parameter 'flatten_arrays_to_rows' is set
  if @api_client.config.client_side_validation && flatten_arrays_to_rows.nil?
    fail ArgumentError, "Missing the required parameter 'flatten_arrays_to_rows' when calling AIControllerApi.get_transformer_results_table"
  end
  allowable_values = ["INBOX", "PHONE"]
  if @api_client.config.client_side_validation && opts[:'entity_type'] && !allowable_values.include?(opts[:'entity_type'])
    fail ArgumentError, "invalid value for \"entity_type\", must be one of #{allowable_values}"
  end
  if @api_client.config.client_side_validation && !opts[:'size'].nil? && opts[:'size'] > 100
    fail ArgumentError, 'invalid value for "opts[:"size"]" when calling AIControllerApi.get_transformer_results_table, must be smaller than or equal to 100.'
  end

  allowable_values = ["ASC", "DESC"]
  if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
    fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/ai/transformer/results/table'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'includeMetaData'] = include_meta_data
  query_params[:'flattenArraysToRows'] = flatten_arrays_to_rows
  query_params[:'emailId'] = opts[:'email_id'] if !opts[:'email_id'].nil?
  query_params[:'smsId'] = opts[:'sms_id'] if !opts[:'sms_id'].nil?
  query_params[:'attachmentId'] = opts[:'attachment_id'] if !opts[:'attachment_id'].nil?
  query_params[:'aiTransformId'] = opts[:'ai_transform_id'] if !opts[:'ai_transform_id'].nil?
  query_params[:'aiTransformMappingId'] = opts[:'ai_transform_mapping_id'] if !opts[:'ai_transform_mapping_id'].nil?
  query_params[:'entityId'] = opts[:'entity_id'] if !opts[:'entity_id'].nil?
  query_params[:'entityType'] = opts[:'entity_type'] if !opts[:'entity_type'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'PageTableData' 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AIControllerApi#get_transformer_results_table\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_transformer_results_with_http_info(opts = {}) ⇒ Array<(PageAITransformResultProjection, Integer, Hash)>

Get transformer results Get AI transformer results

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :email_id (String)
  • :sms_id (String)
  • :attachment_id (String)
  • :ai_transform_id (String)
  • :ai_transform_mapping_id (String)
  • :entity_id (String)
  • :entity_type (String)
  • :page (Integer)
  • :size (Integer) —

    Optional page size. Maximum size is 100. Use page index and sort to page through larger results

  • :sort (String) —

    Optional createdAt sort direction ASC or DESC

Returns:



1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
 
# File 'lib/mailslurp_client/api/ai_controller_api.rb', line 1001

def get_transformer_results_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AIControllerApi.get_transformer_results ...'
  end
  allowable_values = ["INBOX", "PHONE"]
  if @api_client.config.client_side_validation && opts[:'entity_type'] && !allowable_values.include?(opts[:'entity_type'])
    fail ArgumentError, "invalid value for \"entity_type\", must be one of #{allowable_values}"
  end
  if @api_client.config.client_side_validation && !opts[:'size'].nil? && opts[:'size'] > 100
    fail ArgumentError, 'invalid value for "opts[:"size"]" when calling AIControllerApi.get_transformer_results, must be smaller than or equal to 100.'
  end

  allowable_values = ["ASC", "DESC"]
  if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
    fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/ai/transformer/results'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'emailId'] = opts[:'email_id'] if !opts[:'email_id'].nil?
  query_params[:'smsId'] = opts[:'sms_id'] if !opts[:'sms_id'].nil?
  query_params[:'attachmentId'] = opts[:'attachment_id'] if !opts[:'attachment_id'].nil?
  query_params[:'aiTransformId'] = opts[:'ai_transform_id'] if !opts[:'ai_transform_id'].nil?
  query_params[:'aiTransformMappingId'] = opts[:'ai_transform_mapping_id'] if !opts[:'ai_transform_mapping_id'].nil?
  query_params[:'entityId'] = opts[:'entity_id'] if !opts[:'entity_id'].nil?
  query_params[:'entityType'] = opts[:'entity_type'] if !opts[:'entity_type'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'PageAITransformResultProjection' 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AIControllerApi#get_transformer_results\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_transformer_with_http_info(id, opts = {}) ⇒ Array<(AITransformDto, Integer, Hash)>

Get a transformer Get AI transformer and schemas by ID

Parameters:

  • id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(AITransformDto, Integer, Hash)>) —

    AITransformDto data, response status code and response headers



711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
 
# File 'lib/mailslurp_client/api/ai_controller_api.rb', line 711

def get_transformer_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AIControllerApi.get_transformer ...'
  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 AIControllerApi.get_transformer"
  end
  # resource path
  local_var_path = '/ai/transformer/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'AITransformDto' 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AIControllerApi#get_transformer\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_transformers(opts = {}) ⇒ PageAITransformProjection

List transformers List all AI transforms

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page (Integer) — default: default to 0
  • :size (Integer) —

    Optional page size in SMS list pagination. Maximum size is 100. Use page index and sort to page through larger results (default to 20)

  • :sort (String) —

    Optional createdAt sort direction ASC or DESC (default to 'ASC')

  • :include (Array<String>) —

    Optional list of IDs to include in result

Returns:



1186
1187
1188
1189
 
# File 'lib/mailslurp_client/api/ai_controller_api.rb', line 1186

def get_transformers(opts = {})
  data, _status_code, _headers = get_transformers_with_http_info(opts)
  data
end

#get_transformers_with_http_info(opts = {}) ⇒ Array<(PageAITransformProjection, Integer, Hash)>

List transformers List all AI transforms

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page (Integer)
  • :size (Integer) —

    Optional page size in SMS list pagination. Maximum size is 100. Use page index and sort to page through larger results

  • :sort (String) —

    Optional createdAt sort direction ASC or DESC

  • :include (Array<String>) —

    Optional list of IDs to include in result

Returns:

  • (Array<(PageAITransformProjection, Integer, Hash)>) —

    PageAITransformProjection data, response status code and response headers



1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
 
# File 'lib/mailslurp_client/api/ai_controller_api.rb', line 1199

def get_transformers_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AIControllerApi.get_transformers ...'
  end
  if @api_client.config.client_side_validation && !opts[:'size'].nil? && opts[:'size'] > 100
    fail ArgumentError, 'invalid value for "opts[:"size"]" when calling AIControllerApi.get_transformers, must be smaller than or equal to 100.'
  end

  allowable_values = ["ASC", "DESC"]
  if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
    fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/ai/transformer'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :multi) if !opts[:'include'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'PageAITransformProjection' 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AIControllerApi#get_transformers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#invoke_transformer(invoke_transformer_options, opts = {}) ⇒ ConditionalStructuredContentResult

Invoke a transformer Execute an AI transformer to generate structured content

Parameters:

Returns:



1259
1260
1261
1262
 
# File 'lib/mailslurp_client/api/ai_controller_api.rb', line 1259

def invoke_transformer(invoke_transformer_options, opts = {})
  data, _status_code, _headers = invoke_transformer_with_http_info(invoke_transformer_options, opts)
  data
end

#invoke_transformer_with_http_info(invoke_transformer_options, opts = {}) ⇒ Array<(ConditionalStructuredContentResult, Integer, Hash)>

Invoke a transformer Execute an AI transformer to generate structured content

Parameters:

Returns:



1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
 
# File 'lib/mailslurp_client/api/ai_controller_api.rb', line 1269

def invoke_transformer_with_http_info(invoke_transformer_options, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AIControllerApi.invoke_transformer ...'
  end
  # verify the required parameter 'invoke_transformer_options' is set
  if @api_client.config.client_side_validation && invoke_transformer_options.nil?
    fail ArgumentError, "Missing the required parameter 'invoke_transformer_options' when calling AIControllerApi.invoke_transformer"
  end
  # resource path
  local_var_path = '/ai/transformer/invoke'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(invoke_transformer_options) 

  # return_type
  return_type = opts[:return_type] || 'ConditionalStructuredContentResult' 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AIControllerApi#invoke_transformer\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#test_transformer_mapping_match(id, opts = {}) ⇒ AITransformMappingMatchResult

Test transformer mapping match result Evaluate transform mapping match conditions for given email, sms, or attachment

Parameters:

  • id (String) —

    ID of transform mapping

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :email_id (String)
  • :sms_id (String)
  • :attachment_id (String)

Returns:



1326
1327
1328
1329
 
# File 'lib/mailslurp_client/api/ai_controller_api.rb', line 1326

def test_transformer_mapping_match(id, opts = {})
  data, _status_code, _headers = test_transformer_mapping_match_with_http_info(id, opts)
  data
end

#test_transformer_mapping_match_with_http_info(id, opts = {}) ⇒ Array<(AITransformMappingMatchResult, Integer, Hash)>

Test transformer mapping match result Evaluate transform mapping match conditions for given email, sms, or attachment

Parameters:

  • id (String) —

    ID of transform mapping

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :email_id (String)
  • :sms_id (String)
  • :attachment_id (String)

Returns:



1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
 
# File 'lib/mailslurp_client/api/ai_controller_api.rb', line 1339

def test_transformer_mapping_match_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AIControllerApi.test_transformer_mapping_match ...'
  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 AIControllerApi.test_transformer_mapping_match"
  end
  # resource path
  local_var_path = '/ai/transformer/mappings/{id}/match'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'emailId'] = opts[:'email_id'] if !opts[:'email_id'].nil?
  query_params[:'smsId'] = opts[:'sms_id'] if !opts[:'sms_id'].nil?
  query_params[:'attachmentId'] = opts[:'attachment_id'] if !opts[:'attachment_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'AITransformMappingMatchResult' 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AIControllerApi#test_transformer_mapping_match\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#validate_structured_output_schema(structured_output_schema, opts = {}) ⇒ StructuredOutputSchemaValidation

Validate structured content schema Check if a schema is valid and can be used to extract data using AI

Parameters:

Returns:



1394
1395
1396
1397
 
# File 'lib/mailslurp_client/api/ai_controller_api.rb', line 1394

def validate_structured_output_schema(structured_output_schema, opts = {})
  data, _status_code, _headers = validate_structured_output_schema_with_http_info(structured_output_schema, opts)
  data
end

#validate_structured_output_schema_with_http_info(structured_output_schema, opts = {}) ⇒ Array<(StructuredOutputSchemaValidation, Integer, Hash)>

Validate structured content schema Check if a schema is valid and can be used to extract data using AI

Parameters:

Returns:



1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
 
# File 'lib/mailslurp_client/api/ai_controller_api.rb', line 1404

def validate_structured_output_schema_with_http_info(structured_output_schema, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AIControllerApi.validate_structured_output_schema ...'
  end
  # verify the required parameter 'structured_output_schema' is set
  if @api_client.config.client_side_validation && structured_output_schema.nil?
    fail ArgumentError, "Missing the required parameter 'structured_output_schema' when calling AIControllerApi.validate_structured_output_schema"
  end
  # resource path
  local_var_path = '/ai/structured-content/validate'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(structured_output_schema) 

  # return_type
  return_type = opts[:return_type] || 'StructuredOutputSchemaValidation' 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AIControllerApi#validate_structured_output_schema\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end