Module: Legion::LLM::API::SharedHelpers

Includes:
Legion::Logging::Helper
Included in:
Namespaces::Helpers
Defined in:
lib/legion/llm/api/shared_helpers.rb

Instance Method Summary collapse

Instance Method Details

#api_context_stats(pipeline_response) ⇒ Object 



250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/legion/llm/api/shared_helpers.rb', line 250

def api_context_stats(pipeline_response)
  return nil unless pipeline_response.respond_to?(:audit)

  accounting = pipeline_response.audit&.dig(:context_accounting)
  return nil unless accounting.is_a?(Hash)

  tokens = accounting[:tokens] || {}
  curated = tokens[:curation_saved_estimated_tokens].to_i
  archived = tokens[:archive_saved_estimated_tokens].to_i
  stripped = tokens[:stripped_thinking_estimated_tokens].to_i
  compacted = tokens[:context_window_saved_estimated_tokens].to_i
  total_saved = curated + archived + stripped + compacted
  return nil unless total_saved.positive?

  { context_tokens_saved: total_saved }
rescue StandardError => e
  handle_exception(e, level: :warn, handled: true, operation: 'llm.api.context_stats')
  nil
end

#api_duration_ms(started_at) ⇒ Object 



229
230
231
232
233
 
# File 'lib/legion/llm/api/shared_helpers.rb', line 229

def api_duration_ms(started_at)
  return 0 unless started_at

  ((::Process.clock_gettime(::Process::CLOCK_MONOTONIC) - started_at) * 1000).round
end

#api_hash_value(hash, key) ⇒ Object 



270
271
272
273
274
 
# File 'lib/legion/llm/api/shared_helpers.rb', line 270

def api_hash_value(hash, key)
  return nil unless hash.respond_to?(:[])

  hash[key] || hash[key.to_s]
end

#api_provider_latency_ms(pipeline_response, routing) ⇒ Object 



235
236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'lib/legion/llm/api/shared_helpers.rb', line 235

def api_provider_latency_ms(pipeline_response, routing)
  latency = api_hash_value(routing, :latency_ms)
  return latency if latency

  timestamps = pipeline_response.respond_to?(:timestamps) ? pipeline_response.timestamps || {} : {}
  provider_start = api_hash_value(timestamps, :provider_start)
  provider_end = api_hash_value(timestamps, :provider_end)
  return nil unless provider_start && provider_end

  ((provider_end - provider_start) * 1000).round
rescue StandardError => e
  handle_exception(e, level: :debug, handled: true, operation: 'llm.api.provider_latency_ms')
  nil
end

#api_stop_reason(pipeline_response) ⇒ Object 



310
311
312
313
314
315
 
# File 'lib/legion/llm/api/shared_helpers.rb', line 310

def api_stop_reason(pipeline_response)
  stop = pipeline_response.respond_to?(:stop) ? pipeline_response.stop : nil
  return nil unless stop.respond_to?(:[])

  stop[:reason] || stop['reason']
end

#api_thinking_tokens(pipeline_response, tokens) ⇒ Object 



291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/legion/llm/api/shared_helpers.rb', line 291

def api_thinking_tokens(pipeline_response, tokens)
  token_value = api_token_value(tokens, :thinking, :thinking_tokens, :reasoning, :reasoning_tokens)
  return token_value unless token_value.nil?

  thinking = pipeline_response.respond_to?(:thinking) ? pipeline_response.thinking : nil
  return nil if thinking.nil?
  return api_hash_value(thinking, :tokens).to_i if thinking.is_a?(Hash) && api_hash_value(thinking, :tokens)
  return thinking.tokens.to_i if thinking.respond_to?(:tokens)

  nil
end

#api_token_value(tokens, *keys) ⇒ Object 



276
277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/legion/llm/api/shared_helpers.rb', line 276

def api_token_value(tokens, *keys)
  return nil if tokens.nil?

  keys.each do |key|
    value = if tokens.is_a?(Hash)
              tokens[key] || tokens[key.to_s]
            elsif tokens.respond_to?(key)
              tokens.public_send(key)
            end
    return value.to_i unless value.nil?
  end

  nil
end

#api_tool_execution_count(pipeline_response) ⇒ Object 



303
304
305
306
307
308
 
# File 'lib/legion/llm/api/shared_helpers.rb', line 303

def api_tool_execution_count(pipeline_response)
  Array(pipeline_response.respond_to?(:timeline) ? pipeline_response.timeline : []).count do |event|
    key = event.is_a?(Hash) ? event[:key] || event['key'] : nil
    key.to_s.start_with?('tool:execute:')
  end
end

#build_client_tool_class(tname, tdesc, tschema) ⇒ Object 



340
341
342
343
344
345
346
347
348
349
350
351
 
# File 'lib/legion/llm/api/shared_helpers.rb', line 340

def build_client_tool_class(tname, tdesc, tschema)
  log.debug("[llm][api][shared_helpers] build_client_tool_class name=#{tname}")
  Legion::LLM::Types::ToolDefinition.build(
    name:        tname,
    description: tdesc,
    parameters:  tschema || {},
    source:      { type: :client, executable: false, raw_name: tname }
  )
rescue StandardError => e
  handle_exception(e, level: :warn, handled: true, operation: "llm.api.build_client_tool_class.#{tname}")
  nil
end

#build_response_metrics(pipeline_response) ⇒ Object 



145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/legion/llm/api/shared_helpers.rb', line 145

def build_response_metrics(pipeline_response)
  routing = pipeline_response.routing || {}
  timestamps = pipeline_response.timestamps || {}
  metrics = {}

  if (latency = routing[:latency_ms])
    metrics[:latency_ms] = latency
  end

  step_timings = timestamps[:step_timings]
  if step_timings.is_a?(Hash) && step_timings.any?
    metrics[:timing] = step_timings
    total = step_timings[:total].to_i
    external = step_timings[:provider_call].to_i + step_timings[:tool_calls].to_i
    metrics[:latency_legionio_ms] = total - external if total.positive?
  end

  metrics.empty? ? nil : metrics
end

#build_server_caller(source:, path:, env:, caller_context: nil) ⇒ Object 



544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
 
# File 'lib/legion/llm/api/shared_helpers.rb', line 544

def build_server_caller(source:, path:, env:, caller_context: nil)
  normalized_caller = caller_context.respond_to?(:transform_keys) ? caller_context.transform_keys(&:to_sym) : {}
  safe_caller_fields = normalized_caller.slice(:context, :session_id, :trace_id)

  caller_hash = {
    source:       source,
    path:         path,
    requested_by: identity_caller_hash(env).fetch(:requested_by),
    client:       caller_client_string(env)
  }

  # Carry parent request reference for ledger enrichment (avoids DB queries at emit time)
  if (turn_metadata = env['HTTP_X_CODEX_TURN_METADATA'])
    begin
      parsed = Legion::JSON.load(turn_metadata)
      caller_hash[:parent_request_ref] = parsed['turn_id'] if parsed['turn_id']
      caller_hash[:codex_turn_metadata] = parsed
    rescue StandardError => e
      handle_exception(e, level: :debug, handled: true, operation: 'llm.api.build_server_caller.turn_metadata')
    end
  end

  caller_hash.merge(safe_caller_fields)
end

#build_tool_definitions(tool_specs, executable: true) ⇒ Object

Tool helpers



321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
 
# File 'lib/legion/llm/api/shared_helpers.rb', line 321

def build_tool_definitions(tool_specs, executable: true)
  return [] if tool_specs.nil? || !tool_specs.is_a?(Array)

  tool_specs.filter_map do |spec|
    s = spec.respond_to?(:transform_keys) ? spec.transform_keys(&:to_sym) : spec
    next if s[:name].to_s.empty?

    Legion::LLM::Types::ToolDefinition.build(
      name:        s[:name].to_s,
      description: (s[:description] || '').to_s,
      parameters:  s[:parameters] || s[:input_schema] || {},
      source:      { type: :client, executable: executable, raw_name: s[:name].to_s }
    )
  rescue StandardError => e
    handle_exception(e, level: :warn, handled: true, operation: "llm.api.build_tool.#{s[:name]}")
    nil
  end
end

#cache_available? ⇒ Boolean

Returns:

  • (Boolean) 


104
105
106
 
# File 'lib/legion/llm/api/shared_helpers.rb', line 104

def cache_available?
  cache_connected? || local_cache_connected?
end

#caller_client_string(env) ⇒ Object 



573
574
575
576
577
 
# File 'lib/legion/llm/api/shared_helpers.rb', line 573

def caller_client_string(env)
  user_agent = env['HTTP_USER_AGENT'] || 'unknown'
  remote_addr = env['REMOTE_ADDR'] || env['HTTP_X_FORWARDED_FOR'] || 'unknown'
  "#{user_agent} (#{remote_addr})"
end

#detect_caller_client(env) ⇒ Object 



569
570
571
 
# File 'lib/legion/llm/api/shared_helpers.rb', line 569

def detect_caller_client(env)
  env['HTTP_USER_AGENT'] || env['HTTP_X_REQUEST_ID']
end

#detect_modality(messages) ⇒ Object 



579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
 
# File 'lib/legion/llm/api/shared_helpers.rb', line 579

def detect_modality(messages)
  return nil unless messages.is_a?(Array)

  messages.each do |msg|
    content = msg[:content] || msg['content']
    next unless content.is_a?(Array)

    content.each do |block|
      b = block.is_a?(Hash) ? block : next
      type = (b[:type] || b['type']).to_s
      return :vision if %w[image image_url].include?(type)
      return :vision if b[:source] && (b.dig(:source, :type) || b.dig(:source, 'type')).to_s == 'base64'
    end
  end

  nil
end

#emit_response_tool_call_events(_stream, pipeline_response) ⇒ Object 



385
386
387
388
389
390
391
392
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
 
# File 'lib/legion/llm/api/shared_helpers.rb', line 385

def emit_response_tool_call_events(_stream, pipeline_response)
  tool_calls = extract_tool_calls(pipeline_response)
  return if tool_calls.empty?

  timeline_tool_call_ids = Array(pipeline_response.timeline).filter_map do |event|
    key = event[:key].to_s
    next unless key.start_with?('tool:execute:')

    data = event[:data].is_a?(Hash) ? event[:data] : {}
    data[:tool_call_id] || data['tool_call_id']
  end

  done_only = 0
  skipped_timeline = 0
  request_id = pipeline_response.respond_to?(:request_id) ? pipeline_response.request_id : 'unknown'
  conversation_id = pipeline_response.respond_to?(:conversation_id) ? pipeline_response.conversation_id : 'none'

  tool_calls.each do |tool_call|
    tool_call_id = tool_call[:id] || tool_call['id']
    if tool_call_id && timeline_tool_call_ids.include?(tool_call_id)
      skipped_timeline += 1
      next
    end

    tool_name = openai_tool_call_name(tool_call)
    next if tool_name.to_s.empty?

    log.info(
      "[llm][api][tools] action=returned_tool_call_done_only request_id=#{request_id} " \
      "conversation_id=#{conversation_id} tool_call_id=#{tool_call_id || 'none'} name=#{tool_name} " \
      "args_class=#{openai_tool_call_arguments(tool_call).class}"
    )
    done_only += 1
  end

  names = tool_calls.map { |tc| openai_tool_call_name(tc) }.compact
  names_str = names.first(30).join(',') + (names.size > 30 ? ",+#{names.size - 30}more" : '')
  log.info(
    "[llm][api][tools] action=returned_tool_calls_complete request_id=#{request_id} " \
    "conversation_id=#{conversation_id} total=#{tool_calls.size} done_only=#{done_only} " \
    "skipped_timeline=#{skipped_timeline} names=#{names_str.empty? ? 'none' : names_str}"
  )
end

#emit_sse_event(stream, event_name, payload) ⇒ Object

Emit an SSE event to a streaming response body. Logs every event type except 'text-delta' at info (preserving existing behavior from api/native/helpers.rb: text-delta goes to debug, everything else to info).



127
128
129
130
131
 
# File 'lib/legion/llm/api/shared_helpers.rb', line 127

def emit_sse_event(stream, event_name, payload)
  level = event_name == 'text-delta' ? :debug : :info
  log.send(level, "[sse][emit] event=#{event_name} keys=#{payload.is_a?(Hash) ? payload.keys.join(',') : 'n/a'}")
  stream << "event: #{event_name}\ndata: #{Legion::JSON.dump(payload)}\n\n"
end

#emit_timeline_tool_events(stream, pipeline_response, skip_tool_results: false) ⇒ Object 



429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
 
# File 'lib/legion/llm/api/shared_helpers.rb', line 429

def emit_timeline_tool_events(stream, pipeline_response, skip_tool_results: false)
  timeline = Array(pipeline_response.timeline)
  log.debug("[llm][api][shared_helpers] emit_timeline_tool_events count=#{timeline.size} skip_tool_results=#{skip_tool_results}")
  timeline.each do |event|
    key = event[:key].to_s
    detail = event[:detail]
    data = event[:data].is_a?(Hash) ? event[:data] : {}
    name = key.split(':', 3).last
    next if name.to_s.empty?

    if key.start_with?('tool:result:')
      next if skip_tool_results

      event_name = data[:status].to_s == 'error' ? 'tool-error' : 'tool-result'
      emit_sse_event(stream, event_name, {
                       toolCallId: data[:tool_call_id],
                       toolName:   name,
                       result:     data[:result] || detail,
                       status:     data[:status],
                       timestamp:  Time.now.utc.iso8601
                     })
    elsif key.start_with?('tool:execute:')
      emit_sse_event(stream, 'tool-progress', {
                       toolCallId: data[:tool_call_id],
                       toolName:   name,
                       type:       'execution_complete',
                       args:       data[:arguments] || {},
                       source:     data[:source],
                       status:     detail,
                       timestamp:  Time.now.utc.iso8601
                     })
    end
  end
end

#extract_text_content(content) ⇒ Object

Content extraction



468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
 
# File 'lib/legion/llm/api/shared_helpers.rb', line 468

def extract_text_content(content)
  case content
  when nil then ''
  when String then content
  when Array then content.filter_map { |entry| extract_text_content(entry) }.join
  when Hash
    type = content[:type] || content['type']
    return '' unless type.nil? || type.to_s == 'text'

    # Explicit parens to avoid operator precedence ambiguity between || and ?:
    text = content.key?(:text) || content.key?('text') ? (content[:text] || content['text']) : (content[:content] || content['content'])
    extract_text_content(text)
  else
    content.respond_to?(:text) ? content.text.to_s : content.to_s
  end
end

#extract_tool_calls(pipeline_response) ⇒ Object 



353
354
355
 
# File 'lib/legion/llm/api/shared_helpers.rb', line 353

def extract_tool_calls(pipeline_response)
  Legion::LLM::API::Translators::OpenAIResponse.build_tool_calls(pipeline_response)
end

#identity_caller_hash(rack_env) ⇒ Object 



531
532
533
534
535
536
537
538
539
540
541
542
 
# File 'lib/legion/llm/api/shared_helpers.rb', line 531

def identity_caller_hash(rack_env)
  request_identity = identity_request_from_env(rack_env)
  if request_identity.respond_to?(:to_caller_hash)
    caller_hash = request_identity.to_caller_hash
    if caller_hash.is_a?(Hash)
      requested_by = caller_hash[:requested_by] || caller_hash['requested_by']
      return { requested_by: requested_by } if requested_by && !Legion::LLM::PublisherIdentity.generic_requested_by?(requested_by)
    end
  end

  { requested_by: Legion::LLM::PublisherIdentity.requested_by }
end

#identity_canonical_name(rack_env) ⇒ Object 



506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
 
# File 'lib/legion/llm/api/shared_helpers.rb', line 506

def identity_canonical_name(rack_env)
  request_identity = identity_request_from_env(rack_env)
  if request_identity.respond_to?(:to_caller_hash)
    caller_hash = request_identity.to_caller_hash
    if caller_hash.is_a?(Hash)
      requested_by = caller_hash[:requested_by] || caller_hash['requested_by']
      unless Legion::LLM::PublisherIdentity.generic_requested_by?(requested_by)
        name = requested_by[:identity] || requested_by['identity'] if requested_by.respond_to?(:key?)
        return name if name && name.to_s != ''
      end
    end
  end

  publisher_identity = Legion::LLM::PublisherIdentity.requested_by[:identity]
  return publisher_identity if publisher_identity && publisher_identity.to_s != ''

  if defined?(Legion::Identity::Process) && Legion::Identity::Process.respond_to?(:canonical_name)
    process_name = Legion::Identity::Process.canonical_name
    return process_name if process_name && process_name.to_s != ''
  end

  raw = ENV.fetch('USER', nil) || ENV.fetch('LOGNAME', nil) || 'anonymous'
  raw.to_s.include?('@') ? raw.to_s.split('@').first : raw.to_s
end

#identity_request_from_env(rack_env) ⇒ Object

Identity resolution chain



499
500
501
502
503
504
 
# File 'lib/legion/llm/api/shared_helpers.rb', line 499

def identity_request_from_env(rack_env)
  return nil unless defined?(Legion::Identity::Request)
  return nil unless Legion::Identity::Request.respond_to?(:from_env)

  Legion::Identity::Request.from_env(rack_env)
end

#json_error(code, message, status_code: 400) ⇒ Object 



118
119
120
121
122
 
# File 'lib/legion/llm/api/shared_helpers.rb', line 118

def json_error(code, message, status_code: 400)
  content_type :json
  status status_code
  Legion::JSON.dump({ error: { code: code, message: message } })
end

#json_response(data, status_code: 200) ⇒ Object

Responses



112
113
114
115
116
 
# File 'lib/legion/llm/api/shared_helpers.rb', line 112

def json_response(data, status_code: 200)
  content_type :json
  status status_code
  Legion::JSON.dump({ data: data })
end

#log_api_completion_summary(namespace:, request_id:, pipeline_response:, stream:, started_at:, tool_calls: nil, stop_reason: nil) ⇒ Object 



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/legion/llm/api/shared_helpers.rb', line 165

def log_api_completion_summary(namespace:, request_id:, pipeline_response:, stream:, started_at:, tool_calls: nil, stop_reason: nil)
  routing = pipeline_response.respond_to?(:routing) ? pipeline_response.routing || {} : {}
  tokens = pipeline_response.respond_to?(:tokens) ? pipeline_response.tokens : nil
  input_tokens = api_token_value(tokens, :input, :input_tokens)
  output_tokens = api_token_value(tokens, :output, :output_tokens)
  cache_read_tokens = api_token_value(tokens, :cache_read, :cache_read_tokens)
  cache_write_tokens = api_token_value(tokens, :cache_write, :cache_write_tokens)
  thinking_tokens = api_thinking_tokens(pipeline_response, tokens)
  total_tokens = api_token_value(tokens, :total, :total_tokens)
  total_tokens ||= [input_tokens, output_tokens, thinking_tokens].compact.sum

  resolved_tool_calls = tool_calls || extract_tool_calls(pipeline_response)
  resolved_stop_reason = stop_reason || api_stop_reason(pipeline_response) || 'unknown'
  duration_ms = api_duration_ms(started_at)
  provider_latency_ms = api_provider_latency_ms(pipeline_response, routing)
  conversation_id = pipeline_response.respond_to?(:conversation_id) ? pipeline_response.conversation_id : nil

  context_stats = api_context_stats(pipeline_response)

  parts = {
    request_id:          request_id || 'unknown',
    conversation_id:     conversation_id || 'none',
    provider:            api_hash_value(routing, :provider) || 'unknown',
    instance:            api_hash_value(routing, :instance) || 'unknown',
    model:               api_hash_value(routing, :model) || 'unknown',
    tier:                api_hash_value(routing, :tier) || 'unknown',
    stream:              stream,
    duration_ms:         duration_ms,
    provider_latency_ms: provider_latency_ms || 0,
    input_tokens:        input_tokens || 0,
    output_tokens:       output_tokens || 0,
    total_tokens:        total_tokens || 0,
    cache_read_tokens:   cache_read_tokens || 0,
    cache_write_tokens:  cache_write_tokens || 0,
    thinking_tokens:     thinking_tokens || 0,
    tool_calls:          Array(resolved_tool_calls).size,
    tool_executions:     api_tool_execution_count(pipeline_response),
    stop_reason:         resolved_stop_reason
  }
  parts.merge!(context_stats) if context_stats

  log.info("[llm][api][#{namespace}] action=completed " \
           "#{parts.map { |key, value| "#{key}=#{value}" }.join(' ')}")
rescue StandardError => e
  handle_exception(e, level: :warn, handled: true,
                  operation: "llm.api.#{namespace}.completion_summary",
                  request_id: request_id)
end

#log_native_inference_response(request_id:, conversation_id:, stream:, kind:, payload:) ⇒ Object 



133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/legion/llm/api/shared_helpers.rb', line 133

def log_native_inference_response(request_id:, conversation_id:, stream:, kind:, payload:)
  log.debug(
    "[llm][api][inference] action=response_payload request_id=#{request_id || 'unknown'} " \
    "conversation_id=#{conversation_id || 'none'} stream=#{stream} kind=#{kind} " \
    "payload=#{Legion::JSON.dump(payload)}"
  )
rescue StandardError => e
  handle_exception(e, level: :warn, handled: true,
                  operation: 'llm.api.inference.response_payload_log',
                  request_id: request_id)
end

#openai_tool_call_arguments(tool_call) ⇒ Object 



362
363
364
365
366
367
368
369
370
371
 
# File 'lib/legion/llm/api/shared_helpers.rb', line 362

def openai_tool_call_arguments(tool_call)
  fn = tool_call[:function] || tool_call['function'] || {}
  raw_args = fn[:arguments] || fn['arguments'] || tool_call[:arguments] || tool_call['arguments'] || {}
  return raw_args unless raw_args.is_a?(String)

  Legion::JSON.parse(raw_args, symbolize_names: true)
rescue StandardError => e
  log.debug "[llm][api][shared_helpers] action=openai_tool_call_arguments_fallback error=#{e.class} message=#{e.message}"
  raw_args
end

#openai_tool_call_name(tool_call) ⇒ Object 



357
358
359
360
 
# File 'lib/legion/llm/api/shared_helpers.rb', line 357

def openai_tool_call_name(tool_call)
  fn = tool_call[:function] || tool_call['function'] || {}
  fn[:name] || fn['name'] || tool_call[:name] || tool_call['name']
end

#parse_request_body ⇒ Object

Request parsing



27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/legion/llm/api/shared_helpers.rb', line 27

def parse_request_body
  log.debug('[llm][api][shared_helpers] parse_request_body action=parsing')
  raw = request.body.read
  return {} if raw.nil? || raw.empty?

  parsed = begin
    Legion::JSON.load(raw)
  rescue StandardError => e
    handle_exception(e, level: :warn, handled: true, operation: 'llm.api.parse_request_body')
    halt 400, { 'Content-Type' => 'application/json' },
         Legion::JSON.dump({ error: { code: 'invalid_json', message: 'request body is not valid JSON' } })
  end

  unless parsed.respond_to?(:transform_keys)
    halt 400, { 'Content-Type' => 'application/json' },
         Legion::JSON.dump({ error: { code: 'invalid_request_body', message: 'request body must be a JSON object' } })
  end

  parsed
end

#require_llm! ⇒ Object

Guards



52
53
54
55
56
57
58
 
# File 'lib/legion/llm/api/shared_helpers.rb', line 52

def require_llm!
  return if Legion::LLM.started?

  log.debug('[llm][api][shared_helpers] require_llm! action=halting reason=not_started')
  halt 503, { 'Content-Type' => 'application/json' },
       Legion::JSON.dump({ error: { code: 'llm_unavailable', message: 'LLM subsystem is not available' } })
end

#returned_client_tool_call_payload(tool_call, tool_call_id, tool_name) ⇒ Object 



373
374
375
376
377
378
379
380
381
382
383
 
# File 'lib/legion/llm/api/shared_helpers.rb', line 373

def returned_client_tool_call_payload(tool_call, tool_call_id, tool_name)
  {
    toolCallId:         tool_call_id,
    toolName:           tool_name,
    args:               openai_tool_call_arguments(tool_call),
    clientPassthrough:  true,
    requiresToolResult: true,
    status:             'requires_client_execution',
    timestamp:          Time.now.utc.iso8601
  }
end

#set_routing_response_headers(pipeline_response: nil, routing: nil) ⇒ Object

Emits the X-Legion-Provider/Instance/Model attribution headers. Accepts either a pipeline response (reads its #routing hash, as the four inference routes do) or a flat routing hash carrying provider/instance/ model directly (embed results carry them at the top level).



218
219
220
221
222
223
224
225
226
227
 
# File 'lib/legion/llm/api/shared_helpers.rb', line 218

def set_routing_response_headers(pipeline_response: nil, routing: nil)
  routing ||= pipeline_response.respond_to?(:routing) ? pipeline_response.routing || {} : {}
  provider_val = api_hash_value(routing, :provider)
  instance_val = api_hash_value(routing, :instance)
  model_val = api_hash_value(routing, :model)

  headers 'X-Legion-Provider' => provider_val.to_s if provider_val
  headers 'X-Legion-Instance' => instance_val.to_s if instance_val
  headers 'X-Legion-Model' => model_val.to_s if model_val
end

#token_value(tokens, key) ⇒ Object 



485
486
487
488
489
490
491
492
493
 
# File 'lib/legion/llm/api/shared_helpers.rb', line 485

def token_value(tokens, key)
  return nil if tokens.nil?
  return tokens[key] || tokens[key.to_s] if tokens.is_a?(Hash)

  method_name = { input: :input_tokens, output: :output_tokens, total: :total_tokens }[key]
  return tokens.public_send(method_name) if method_name && tokens.respond_to?(method_name)

  nil
end

#validate_messages!(msg_list) ⇒ Object 



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/legion/llm/api/shared_helpers.rb', line 69

def validate_messages!(msg_list)
  valid = msg_list.all? do |m|
    next false unless m.respond_to?(:key?) && m.respond_to?(:[])

    role = m[:role] || m['role']
    content_value = m[:content] || m['content']

    !role.to_s.empty? &&
      (m.key?(:content) || m.key?('content')) &&
      !content_value.nil? &&
      !(content_value.respond_to?(:empty?) && content_value.empty?)
  end
  return if valid

  halt 400, { 'Content-Type' => 'application/json' },
       Legion::JSON.dump({ error: { code:    'invalid_messages',
                                    message: 'each message must be an object with non-empty role and content' } })
end

#validate_required!(body, *keys) ⇒ Object 



60
61
62
63
64
65
66
67
 
# File 'lib/legion/llm/api/shared_helpers.rb', line 60

def validate_required!(body, *keys)
  missing = keys.select { |k| body[k].nil? || (body[k].respond_to?(:empty?) && body[k].empty?) }
  return if missing.empty?

  log.debug("[llm][api][shared_helpers] validate_required! missing=#{missing.join(',')}")
  halt 400, { 'Content-Type' => 'application/json' },
       Legion::JSON.dump({ error: { code: 'missing_fields', message: "required: #{missing.join(', ')}" } })
end

#validate_tools!(tool_list) ⇒ Object 



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/legion/llm/api/shared_helpers.rb', line 88

def validate_tools!(tool_list)
  unless tool_list.is_a?(Array) && tool_list.all? { |t| t.respond_to?(:transform_keys) }
    halt 400, { 'Content-Type' => 'application/json' },
         Legion::JSON.dump({ error: { code: 'invalid_tools', message: 'tools must be an array of objects' } })
  end

  invalid = tool_list.any? do |t|
    ts = t.transform_keys(&:to_sym)
    ts[:name].to_s.empty?
  end
  return unless invalid

  halt 400, { 'Content-Type' => 'application/json' },
       Legion::JSON.dump({ error: { code: 'invalid_tools', message: 'each tool must have a non-empty name' } })
end