Module: Protege

Extended by:
Protege
Included in:
Protege
Defined in:
lib/protege.rb,
lib/protege/loop.rb,
lib/protege/engine.rb,
lib/protege/gateway.rb,
lib/protege/version.rb,
lib/protege/inference.rb,
app/models/protege/trace.rb,
lib/protege/errors/error.rb,
lib/protege/events/event.rb,
lib/protege/orchestrator.rb,
lib/protege/types/result.rb,
lib/protege/configuration.rb,
lib/protege/loop/schedule.rb,
app/models/protege/current.rb,
app/models/protege/message.rb,
app/models/protege/persona.rb,
lib/protege/loop/scheduler.rb,
app/models/protege/tool_use.rb,
lib/protege/extensions/hook.rb,
lib/protege/extensions/tool.rb,
lib/protege/types/text_part.rb,
lib/protege/types/image_part.rb,
lib/protege/types/stored_file.rb,
lib/protege/types/tool_result.rb,
app/jobs/protege/inference_job.rb,
app/models/protege/access_rule.rb,
app/models/protege/email_domain.rb,
app/models/protege/email_thread.rb,
lib/protege/extensions/provider.rb,
lib/protege/extensions/resolver.rb,
lib/protege/subscribers/tracing.rb,
lib/protege/types/document_part.rb,
lib/protege/types/model_message.rb,
app/helpers/protege/trace_helper.rb,
app/jobs/protege/application_job.rb,
app/tools/protege/web_fetch_tool.rb,
lib/protege/errors/generic_error.rb,
lib/protege/errors/timeout_error.rb,
lib/protege/gateway/mail/address.rb,
lib/protege/orchestrator/context.rb,
lib/protege/orchestrator/harness.rb,
app/models/protege/responsibility.rb,
app/services/protege/trace_search.rb,
app/tools/protege/send_email_tool.rb,
app/tools/protege/web_search_tool.rb,
lib/protege/errors/internal_error.rb,
lib/protege/extensions/hook_mixin.rb,
lib/protege/extensions/tool_mixin.rb,
lib/protege/gateway/access_policy.rb,
lib/protege/gateway/mail/outbound.rb,
app/helpers/protege/threads_helper.rb,
app/tools/protege/create_file_tool.rb,
lib/protege/gateway/access_control.rb,
app/helpers/protege/messages_helper.rb,
app/helpers/protege/personas_helper.rb,
app/hooks/protege/event_logger_hook.rb,
app/jobs/protege/responsibility_job.rb,
app/mailboxes/protege/agent_mailbox.rb,
app/services/protege/message_search.rb,
lib/protege/gateway/mail/attachment.rb,
lib/protege/gateway/mail/message_id.rb,
lib/protege/gateway/mail/references.rb,
app/tools/protege/search_emails_tool.rb,
lib/protege/errors/bad_request_error.rb,
lib/protege/errors/unavailable_error.rb,
app/models/protege/application_record.rb,
app/models/protege/responsibility_run.rb,
lib/protege/errors/rate_limited_error.rb,
lib/protege/errors/unauthorized_error.rb,
lib/protege/extensions/provider_mixin.rb,
lib/protege/extensions/resolver_mixin.rb,
lib/protege/gateway/attachment_policy.rb,
app/helpers/protege/application_helper.rb,
app/jobs/protege/console_inference_job.rb,
app/jobs/protege/mail_provisioning_job.rb,
app/mailers/protege/application_mailer.rb,
app/tools/protege/read_attachment_tool.rb,
lib/protege/errors/invalid_model_error.rb,
lib/protege/inference/provider/request.rb,
lib/protege/orchestrator/reply_context.rb,
lib/protege/orchestrator/reply_harness.rb,
app/controllers/protege/home_controller.rb,
app/models/concerns/protege/tool_scoped.rb,
lib/generators/protege/extension_naming.rb,
lib/protege/errors/tool_not_found_error.rb,
lib/protege/inference/provider/response.rb,
lib/protege/orchestrator/resolver_chain.rb,
lib/protege/subscribers/hook_dispatcher.rb,
app/helpers/protege/email_domains_helper.rb,
app/jobs/protege/responsibility_tick_job.rb,
app/resolvers/protege/load_file_resolver.rb,
app/resolvers/protege/load_text_resolver.rb,
lib/protege/events/inference_chunk_event.rb,
lib/protege/events/loop_run_failed_event.rb,
lib/protege/inference/provider/tool_call.rb,
app/controllers/protege/traces_controller.rb,
lib/protege/events/inference_failed_event.rb,
lib/protege/events/loop_run_started_event.rb,
lib/protege/events/tool_call_failed_event.rb,
app/controllers/protege/replies_controller.rb,
app/controllers/protege/threads_controller.rb,
app/providers/protege/open_router_provider.rb,
app/resolvers/protege/load_record_resolver.rb,
lib/generators/protege/hook/hook_generator.rb,
lib/generators/protege/tool/tool_generator.rb,
lib/protege/events/inference_started_event.rb,
lib/protege/events/loop_run_enqueued_event.rb,
lib/protege/events/tool_call_started_event.rb,
app/controllers/protege/archives_controller.rb,
app/controllers/protege/messages_controller.rb,
app/controllers/protege/personas_controller.rb,
app/helpers/protege/components/cards_helper.rb,
app/helpers/protege/components/forms_helper.rb,
app/helpers/protege/components/icons_helper.rb,
app/helpers/protege/components/menus_helper.rb,
app/helpers/protege/responsibilities_helper.rb,
lib/protege/errors/contract_violation_error.rb,
lib/protege/errors/tool_not_available_error.rb,
lib/protege/events/loop_run_completed_event.rb,
app/helpers/protege/components/badges_helper.rb,
app/helpers/protege/components/layout_helper.rb,
app/helpers/protege/components/tables_helper.rb,
lib/protege/errors/invalid_tool_result_error.rb,
lib/protege/events/inference_completed_event.rb,
lib/protege/events/inference_generated_event.rb,
lib/protege/events/tool_call_completed_event.rb,
lib/protege/events/tool_calls_received_event.rb,
app/helpers/protege/components/buttons_helper.rb,
app/helpers/protege/components/dialogs_helper.rb,
app/helpers/protege/components/hotkeys_helper.rb,
app/helpers/protege/components/sidebar_helper.rb,
app/resolvers/protege/thread_history_resolver.rb,
app/controllers/concerns/protege/thread_scoped.rb,
app/controllers/protege/application_controller.rb,
lib/protege/errors/response_parse_failed_error.rb,
app/controllers/concerns/protege/persona_scoped.rb,
app/controllers/protege/access_rules_controller.rb,
lib/protege/errors/unsupported_capability_error.rb,
lib/protege/orchestrator/responsibility_context.rb,
lib/protege/orchestrator/responsibility_harness.rb,
app/controllers/protege/email_domains_controller.rb,
app/helpers/protege/components/components_helper.rb,
app/helpers/protege/components/pagination_helper.rb,
app/helpers/protege/components/typography_helper.rb,
app/models/concerns/protege/broadcastable_thread.rb,
lib/generators/protege/install/install_generator.rb,
lib/generators/protege/persona/persona_generator.rb,
lib/generators/protege/postfix/postfix_generator.rb,
lib/protege/errors/resolver_file_not_found_error.rb,
app/models/concerns/protege/broadcastable_message.rb,
app/models/concerns/protege/broadcastable_persona.rb,
app/subscribers/protege/introspection_broadcaster.rb,
app/controllers/protege/traces/searches_controller.rb,
lib/generators/protege/provider/provider_generator.rb,
lib/generators/protege/resolver/resolver_generator.rb,
app/controllers/protege/responsibilities_controller.rb,
app/helpers/protege/components/introspection_helper.rb,
app/controllers/protege/mta_domains_syncs_controller.rb,
lib/protege/events/inference_max_turns_reached_event.rb,
app/controllers/protege/responsibility_runs_controller.rb,
app/models/concerns/protege/broadcastable_email_domain.rb,
app/models/concerns/protege/broadcastable_responsibility.rb,
app/services/protege/introspection_tool_call_presentation.rb

Overview

See Protege in protege.rb for the root namespace overview. This file reopens the module to define the process-wide Configuration object and its Protege.configure accessors.

Defined Under Namespace

Modules: ApplicationHelper, BroadcastableEmailDomain, BroadcastableMessage, BroadcastablePersona, BroadcastableResponsibility, BroadcastableThread, Components, EmailDomainsHelper, Gateway, Generators, HookMixin, Inference, IntrospectionBroadcaster, Loop, MessagesHelper, Orchestrator, PersonaScoped, PersonasHelper, ProviderMixin, ResolverMixin, ResponsibilitiesHelper, Subscribers, ThreadScoped, ThreadsHelper, ToolMixin, ToolScoped, TraceHelper, Traces Classes: AccessRule, AccessRulesController, AgentMailbox, ApplicationController, ApplicationJob, ApplicationMailer, ApplicationRecord, ArchivesController, BadRequestError, Configuration, ConsoleInferenceJob, ContractViolationError, CreateFileTool, Current, DocumentPart, EmailDomain, EmailDomainsController, EmailThread, Engine, Error, Event, EventLoggerHook, GenericError, HomeController, Hook, ImagePart, InferenceChunkEvent, InferenceCompletedEvent, InferenceFailedEvent, InferenceGeneratedEvent, InferenceJob, InferenceMaxTurnsReachedEvent, InferenceStartedEvent, InternalError, IntrospectionToolCallPresentation, InvalidModelError, InvalidToolResultError, LoadFileResolver, LoadRecordResolver, LoadTextResolver, LoopRunCompletedEvent, LoopRunEnqueuedEvent, LoopRunFailedEvent, LoopRunStartedEvent, MailProvisioningJob, Message, MessageSearch, MessagesController, ModelMessage, MtaDomainsSyncsController, OpenRouterProvider, Persona, PersonasController, Provider, RateLimitedError, ReadAttachmentTool, RepliesController, Resolver, ResolverFileNotFoundError, ResponseParseFailedError, ResponsibilitiesController, Responsibility, ResponsibilityJob, ResponsibilityRun, ResponsibilityRunsController, ResponsibilityTickJob, Result, SearchEmailsTool, SendEmailTool, StoredFile, TextPart, ThreadHistoryResolver, ThreadsController, TimeoutError, Tool, ToolCallCompletedEvent, ToolCallFailedEvent, ToolCallStartedEvent, ToolCallsReceivedEvent, ToolNotAvailableError, ToolNotFoundError, ToolResult, ToolUse, Trace, TraceSearch, TracesController, UnauthorizedError, UnavailableError, UnsupportedCapabilityError, WebFetchTool, WebSearchTool

Constant Summary collapse

VERSION =

Current gem version, following Semantic Versioning.

'0.1.0.alpha.2'

Instance Method Summary collapse

Instance Method Details

#configuration ⇒ Protege::Configuration

Return the process-wide configuration, creating it on first access.

Returns:



37
38
39
 
# File 'lib/protege.rb', line 37

def configuration
  @configuration ||= Configuration.new
end

#configure {|config| ... } ⇒ void

This method returns an undefined value.

Yield the configuration object for mutation. Call once in a Rails initializer.

Yields:

  • (config) —

    the configuration to mutate

Yield Parameters:



30
31
32
 
# File 'lib/protege.rb', line 30

def configure
  yield configuration
end

#reset_configuration! ⇒ Protege::Configuration

Reset configuration to defaults. Primarily for test isolation between examples.

Returns:



44
45
46
 
# File 'lib/protege.rb', line 44

def reset_configuration!
  @configuration = Configuration.new
end