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

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

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

Parameters:

Returns:



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

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<(StructuredContentResult, Integer, Hash)>

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

Parameters:

Returns:

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

    StructuredContentResult 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 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] || 'StructuredContentResult' 

  # 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 = {}) ⇒ StructuredContentResult

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

Parameters:

Returns:



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

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<(StructuredContentResult, Integer, Hash)>

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

Parameters:

Returns:

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

    StructuredContentResult 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 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] || 'StructuredContentResult' 

  # 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

#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:



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

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:



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
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/mailslurp_client/api/ai_controller_api.rb', line 165

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