Class: RubyLLM::Protocols::Bedrock::Guardrails

Inherits:
RubyLLM::Protocol show all
Defined in:
lib/ruby_llm/protocols/bedrock/guardrails.rb

Overview

Moderation through an explicitly configured Bedrock guardrail.

Instance Attribute Summary

Attributes inherited from RubyLLM::Protocol

#config, #connection, #model, #provider

Instance Method Summary collapse

Methods inherited from RubyLLM::Protocol

abstract, #animate_later, #apply_compaction, #apply_compaction_headers, #apply_end_user, #cache_content, #compact, #complete, #count_tokens, #delete_cache, #embed, #extend_cache, #find_cache, #initialize, #list_models, #ocr, #paint, #parse_error, #parse_image_responses, #post_image, #post_video, #preprocess_message, #raise_transcription_streaming_unsupported, #refresh_video_job, #render, #render_embedding, #render_transcription_options, #render_video_extension_payload, #rerank, #server_tool_aliases, #speak, #stream_speech, #stream_speech_response, #stream_transcription, #supports_embedding_media?, #tokenize, #tool_approval_response, #transcribe, #video_extension_attachment, #video_extension_url, #video_request_url

Methods included from RubyLLM::Protocol::BinaryStreaming

#stream_binary

Methods included from RubyLLM::Protocol::Streaming

build_on_data_handler, build_stream_error_response, error_chunk?, failed_http_status, faraday_1?, handle_data, handle_error_chunk, handle_error_event, handle_failed_response, handle_json_error_chunk, handle_sse, handle_stream, json_error_payload?, parse_error_from_json, parse_streaming_error, process_stream_chunk, raise_stream_error, stream_events, stream_response, stream_state

Constructor Details

This class inherits a constructor from RubyLLM::Protocol

Instance Method Details

#moderate(input, model:, with: [], provider_options: {}) ⇒ Object

Raises:



21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
# File 'lib/ruby_llm/protocols/bedrock/guardrails.rb', line 21

def moderate(input, model:, with: [], provider_options: {})
  raise ArgumentError, 'Bedrock guardrails do not accept a model' unless model.nil?

  url = @provider.guardrail_url
  attachments = Attachment.wrap(with, config: @config)
  validate_moderation_input(input, attachments)
  payloads = (input.is_a?(Array) ? input : [input]).map do |text|
    render_moderation_payload(text, attachments, provider_options)
  end
  track_usage(:moderation) do
    responses = payloads.map do |payload|
      response = post_moderation(url, payload)
      result = parse_moderation_result(response)
      @usage_tracker.succeed_attempts(tokens: [Tokens.new])
      [response, result]
    end
    parse_moderation_responses(responses)
  end
end