Class: Lockally::AiApi

Inherits:
Object
  • Object
show all
Defined in:
lib/lockally/api/ai_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ AiApi

Returns a new instance of AiApi.



19
20
21
 
# File 'lib/lockally/api/ai_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/lockally/api/ai_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#v1_ai_config_get(opts = {}) ⇒ Object

Read the tenant's AI configuration Mode (off/byok/units), model, masked key hint, AI-unit balance, whether the units tier is available on this deployment.

Parameters:

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

    the optional parameters

Returns:

  • (Object) 


26
27
28
29
 
# File 'lib/lockally/api/ai_api.rb', line 26

def v1_ai_config_get(opts = {})
  data, _status_code, _headers = v1_ai_config_get_with_http_info(opts)
  data
end

#v1_ai_config_get_with_http_info(opts = {}) ⇒ Array<(Object, Integer, Hash)>

Read the tenant's AI configuration Mode (off/byok/units), model, masked key hint, AI-unit balance, whether the units tier is available on this deployment.

Parameters:

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



35
36
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
 
# File 'lib/lockally/api/ai_api.rb', line 35

def v1_ai_config_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AiApi.v1_ai_config_get ...'
  end
  # resource path
  local_var_path = '/v1/ai-config'

  # 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(['application/json']) unless header_params['Accept']

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearerAuth']

  new_options = opts.merge(
    :operation => :"AiApi.v1_ai_config_get",
    :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: AiApi#v1_ai_config_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#v1_ai_config_put(opts = {}) ⇒ Object

Configure the AI tier Body: \"off|byok|units\", \"model\": \"...\", \"anthropic_key\": \"sk-ant-...\". BYOK keys are stored AES-256-GCM encrypted; the cleartext is never returned. Omit anthropic_key to keep the stored one.

Parameters:

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

    the optional parameters

Returns:

  • (Object) 


83
84
85
86
 
# File 'lib/lockally/api/ai_api.rb', line 83

def v1_ai_config_put(opts = {})
  data, _status_code, _headers = v1_ai_config_put_with_http_info(opts)
  data
end

#v1_ai_config_put_with_http_info(opts = {}) ⇒ Array<(Object, Integer, Hash)>

Configure the AI tier Body: \"off|byok|units\", \"model\": \"...\", \"anthropic_key\": \"sk-ant-...\". BYOK keys are stored AES-256-GCM encrypted; the cleartext is never returned. Omit anthropic_key to keep the stored one.

Parameters:

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



92
93
94
95
96
97
98
99
100
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
 
# File 'lib/lockally/api/ai_api.rb', line 92

def v1_ai_config_put_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AiApi.v1_ai_config_put ...'
  end
  # resource path
  local_var_path = '/v1/ai-config'

  # 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(['application/json']) unless header_params['Accept']

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearerAuth']

  new_options = opts.merge(
    :operation => :"AiApi.v1_ai_config_put",
    :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(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AiApi#v1_ai_config_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#v1_billing_ai_units_checkout_post(opts = {}) ⇒ Object

Buy prepaid AI units Body: \"100|500|2000\". One classification = one unit; bundles expire after 6 months. Admin session required. 503 until Paystack billing is configured.

Parameters:

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

    the optional parameters

Returns:

  • (Object) 


140
141
142
143
 
# File 'lib/lockally/api/ai_api.rb', line 140

def v1_billing_ai_units_checkout_post(opts = {})
  data, _status_code, _headers = v1_billing_ai_units_checkout_post_with_http_info(opts)
  data
end

#v1_billing_ai_units_checkout_post_with_http_info(opts = {}) ⇒ Array<(Object, Integer, Hash)>

Buy prepaid AI units Body: \"100|500|2000\". One classification = one unit; bundles expire after 6 months. Admin session required. 503 until Paystack billing is configured.

Parameters:

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



149
150
151
152
153
154
155
156
157
158
159
160
161
162
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
 
# File 'lib/lockally/api/ai_api.rb', line 149

def v1_billing_ai_units_checkout_post_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AiApi.v1_billing_ai_units_checkout_post ...'
  end
  # resource path
  local_var_path = '/v1/billing/ai-units/checkout'

  # 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(['application/json']) unless header_params['Accept']

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearerAuth']

  new_options = opts.merge(
    :operation => :"AiApi.v1_billing_ai_units_checkout_post",
    :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: AiApi#v1_billing_ai_units_checkout_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#v1_threads_thread_id_classify_post(thread_id, opts = {}) ⇒ Object

LLM-classify a thread Returns urgency, summary, suggested_action via the tenant's AI tier (BYOK or prepaid units — see /v1/ai-config). Cached per thread state: unchanged threads return the cache free; ?refresh=true forces a re-run. A failed model call charges nothing. 402 when the AI tier is off.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :refresh (Boolean)

Returns:

  • (Object) 


199
200
201
202
 
# File 'lib/lockally/api/ai_api.rb', line 199

def v1_threads_thread_id_classify_post(thread_id, opts = {})
  data, _status_code, _headers = v1_threads_thread_id_classify_post_with_http_info(thread_id, opts)
  data
end

#v1_threads_thread_id_classify_post_with_http_info(thread_id, opts = {}) ⇒ Array<(Object, Integer, Hash)>

LLM-classify a thread Returns urgency, summary, suggested_action via the tenant's AI tier (BYOK or prepaid units — see /v1/ai-config). Cached per thread state: unchanged threads return the cache free; ?refresh=true forces a re-run. A failed model call charges nothing. 402 when the AI tier is off.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :refresh (Boolean)

Returns:

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

    Object data, response status code and response headers



210
211
212
213
214
215
216
217
218
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
 
# File 'lib/lockally/api/ai_api.rb', line 210

def v1_threads_thread_id_classify_post_with_http_info(thread_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AiApi.v1_threads_thread_id_classify_post ...'
  end
  # verify the required parameter 'thread_id' is set
  if @api_client.config.client_side_validation && thread_id.nil?
    fail ArgumentError, "Missing the required parameter 'thread_id' when calling AiApi.v1_threads_thread_id_classify_post"
  end
  # resource path
  local_var_path = '/v1/threads/{threadID}/classify'.sub('{threadID}', CGI.escape(thread_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'refresh'] = opts[:'refresh'] if !opts[:'refresh'].nil?

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

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearerAuth']

  new_options = opts.merge(
    :operation => :"AiApi.v1_threads_thread_id_classify_post",
    :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: AiApi#v1_threads_thread_id_classify_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end