AgentOpera API References documentation
Welcome to the API documentation for AgentOpera. This documentation is automatically generated from the source code docstrings.
Chatflow Module
- chatflow
- chatflow.agents
BaseChatAgentBaseChatAgent.nameBaseChatAgent.descriptionBaseChatAgent.produced_message_typesBaseChatAgent.on_messages()BaseChatAgent.on_messages_stream()BaseChatAgent.run()BaseChatAgent.run_stream()BaseChatAgent.on_reset()BaseChatAgent.save_state()BaseChatAgent.load_state()BaseChatAgent.close()BaseChatAgent.agent_identifier()
AssistantAgentCodeExecutorAgentSocietyOfMindAgentSocietyOfMindAgent.DEFAULT_INSTRUCTIONSocietyOfMindAgent.DEFAULT_RESPONSE_PROMPTSocietyOfMindAgent.DEFAULT_DESCRIPTIONSocietyOfMindAgent.produced_message_typesSocietyOfMindAgent.on_messages()SocietyOfMindAgent.on_messages_stream()SocietyOfMindAgent.on_reset()SocietyOfMindAgent.save_state()SocietyOfMindAgent.load_state()
UserProxyAgent
- chatflow.base
- chatflow.conditions
- chatflow.media
- chatflow.state
- chatflow.team
- chatflow.ui
- chatflow.utils
Engine Module
- engine
MessageSerializerUnknownPayloadJSON_DATA_CONTENT_TYPEPROTOBUF_DATA_CONTENT_TYPEROOT_LOGGER_NAMEEVENT_LOGGER_NAMETRACE_LOGGER_NAMEDefaultSubscriptionSubscriptionSubscriptionInstantiationContextTopicPrefixSubscriptionTopicSubscriptiondefault_subscription()topic_subscription()- engine.agent
- engine.function_call
- engine.protocol
- engine.runtime
LocalAgentEngineLocalAgentEngine.unprocessed_messages_countLocalAgentEngine.send_message()LocalAgentEngine.publish_message()LocalAgentEngine.save_state()LocalAgentEngine.load_state()LocalAgentEngine.process_next()LocalAgentEngine.start()LocalAgentEngine.close()LocalAgentEngine.stop()LocalAgentEngine.stop_when_idle()LocalAgentEngine.stop_when()LocalAgentEngine.agent_metadata()LocalAgentEngine.agent_save_state()LocalAgentEngine.agent_load_state()LocalAgentEngine.register_agent_builder()LocalAgentEngine.subscribe()LocalAgentEngine.unsubscribe()LocalAgentEngine.get()LocalAgentEngine.register_msg_serializer()
DistAgentEngineDistAgentEngine.start()DistAgentEngine.stop()DistAgentEngine.stop_when_signal()DistAgentEngine.send_message()DistAgentEngine.publish_message()DistAgentEngine.save_state()DistAgentEngine.load_state()DistAgentEngine.agent_metadata()DistAgentEngine.agent_save_state()DistAgentEngine.agent_load_state()DistAgentEngine.register_agent_builder()DistAgentEngine.remove_agent()DistAgentEngine.remove_agents_with_type()DistAgentEngine.try_get_underlying_agent_instance()DistAgentEngine.subscribe()DistAgentEngine.unsubscribe()DistAgentEngine.get()DistAgentEngine.register_msg_serializer()
DistAgentEngineSrvSubscriptionManagerAgentEngineAgentEngine.send_message()AgentEngine.publish_message()AgentEngine.register_agent_builder()AgentEngine.get()AgentEngine.save_state()AgentEngine.load_state()AgentEngine.agent_metadata()AgentEngine.agent_save_state()AgentEngine.agent_load_state()AgentEngine.subscribe()AgentEngine.unsubscribe()AgentEngine.register_msg_serializer()
MessageHandlerContextAgentInstantiationContext
- engine.subscription
- engine.telemetry
- engine.types
- engine.agent
- engine.function_call
- engine.protocol
- engine.runtime
LocalAgentEngineLocalAgentEngine.unprocessed_messages_countLocalAgentEngine.send_message()LocalAgentEngine.publish_message()LocalAgentEngine.save_state()LocalAgentEngine.load_state()LocalAgentEngine.process_next()LocalAgentEngine.start()LocalAgentEngine.close()LocalAgentEngine.stop()LocalAgentEngine.stop_when_idle()LocalAgentEngine.stop_when()LocalAgentEngine.agent_metadata()LocalAgentEngine.agent_save_state()LocalAgentEngine.agent_load_state()LocalAgentEngine.register_agent_builder()LocalAgentEngine.subscribe()LocalAgentEngine.unsubscribe()LocalAgentEngine.get()LocalAgentEngine.register_msg_serializer()
DistAgentEngineDistAgentEngine.start()DistAgentEngine.stop()DistAgentEngine.stop_when_signal()DistAgentEngine.send_message()DistAgentEngine.publish_message()DistAgentEngine.save_state()DistAgentEngine.load_state()DistAgentEngine.agent_metadata()DistAgentEngine.agent_save_state()DistAgentEngine.agent_load_state()DistAgentEngine.register_agent_builder()DistAgentEngine.remove_agent()DistAgentEngine.remove_agents_with_type()DistAgentEngine.try_get_underlying_agent_instance()DistAgentEngine.subscribe()DistAgentEngine.unsubscribe()DistAgentEngine.get()DistAgentEngine.register_msg_serializer()
DistAgentEngineSrvSubscriptionManagerAgentEngineAgentEngine.send_message()AgentEngine.publish_message()AgentEngine.register_agent_builder()AgentEngine.get()AgentEngine.save_state()AgentEngine.load_state()AgentEngine.agent_metadata()AgentEngine.agent_save_state()AgentEngine.agent_load_state()AgentEngine.subscribe()AgentEngine.unsubscribe()AgentEngine.register_msg_serializer()
MessageHandlerContextAgentInstantiationContext
- engine.telemetry
- engine.types
- engine.types.agent
- engine.types.model_context
- engine.types.models
AssistantMessageChatCompletionClientChatCompletionTokenLogprobCreateResultFunctionExecutionResultFunctionExecutionResultMessageModelCapabilitiesModelFamilyModelFamily.ANYModelFamily.CLAUDE_3_5_HAIKUModelFamily.CLAUDE_3_5_SONNETModelFamily.CLAUDE_3_7_SONNETModelFamily.CLAUDE_3_HAIKUModelFamily.CLAUDE_3_OPUSModelFamily.CLAUDE_3_SONNETModelFamily.GEMINI_1_5_FLASHModelFamily.GEMINI_1_5_PROModelFamily.GEMINI_2_0_FLASHModelFamily.GPT_35ModelFamily.GPT_4ModelFamily.GPT_4OModelFamily.O1ModelFamily.O3ModelFamily.R1ModelFamily.UNKNOWNModelFamily.is_claude()ModelFamily.is_gemini()ModelFamily.is_openai()
ModelInfoRequestUsageSystemMessageTopLogprobUserMessageVercelMessagevalidate_model_info()
- engine.types.msg_channel
- engine.types.msg_context
- others
Agents Module
- agents
- agents.openai
OpenAIAssistantAgentOpenAIAssistantAgent.produced_message_typesOpenAIAssistantAgent.threadsOpenAIAssistantAgent.runsOpenAIAssistantAgent.messagesOpenAIAssistantAgent.on_messages()OpenAIAssistantAgent.on_messages_stream()OpenAIAssistantAgent.handle_text_message()OpenAIAssistantAgent.on_reset()OpenAIAssistantAgent.on_upload_for_code_interpreter()OpenAIAssistantAgent.on_upload_for_file_search()OpenAIAssistantAgent.delete_uploaded_files()OpenAIAssistantAgent.delete_assistant()OpenAIAssistantAgent.delete_vector_store()OpenAIAssistantAgent.save_state()OpenAIAssistantAgent.load_state()
- agents.magentic_one
- agents.magentic_one_team
- agents.web_surfer
MultimodalWebSurferMultimodalWebSurfer.DEFAULT_DESCRIPTIONMultimodalWebSurfer.DEFAULT_START_PAGEMultimodalWebSurfer.VIEWPORT_HEIGHTMultimodalWebSurfer.VIEWPORT_WIDTHMultimodalWebSurfer.MLM_HEIGHTMultimodalWebSurfer.MLM_WIDTHMultimodalWebSurfer.SCREENSHOT_TOKENSMultimodalWebSurfer.close()MultimodalWebSurfer.produced_message_typesMultimodalWebSurfer.on_reset()MultimodalWebSurfer.on_messages()MultimodalWebSurfer.on_messages_stream()
PlaywrightControllerPlaywrightController.sleep()PlaywrightController.get_interactive_rects()PlaywrightController.get_visual_viewport()PlaywrightController.get_focused_rect_id()PlaywrightController.get_page_metadata()PlaywrightController.on_new_page()PlaywrightController.back()PlaywrightController.visit_page()PlaywrightController.page_down()PlaywrightController.page_up()PlaywrightController.gradual_cursor_animation()PlaywrightController.add_cursor_box()PlaywrightController.remove_cursor_box()PlaywrightController.click_id()PlaywrightController.hover_id()PlaywrightController.fill_id()PlaywrightController.scroll_id()PlaywrightController.get_webpage_text()PlaywrightController.get_visible_text()PlaywrightController.get_page_markdown()
- agents.video_surfer
- agents.file_surfer
- agents.code_executor
- agents.openai
- agents.openai
OpenAIAssistantAgentOpenAIAssistantAgent.produced_message_typesOpenAIAssistantAgent.threadsOpenAIAssistantAgent.runsOpenAIAssistantAgent.messagesOpenAIAssistantAgent.on_messages()OpenAIAssistantAgent.on_messages_stream()OpenAIAssistantAgent.handle_text_message()OpenAIAssistantAgent.on_reset()OpenAIAssistantAgent.on_upload_for_code_interpreter()OpenAIAssistantAgent.on_upload_for_file_search()OpenAIAssistantAgent.delete_uploaded_files()OpenAIAssistantAgent.delete_assistant()OpenAIAssistantAgent.delete_vector_store()OpenAIAssistantAgent.save_state()OpenAIAssistantAgent.load_state()
- agents.magentic_one
- agents.magentic_one_team
- agents.web_surfer
MultimodalWebSurferMultimodalWebSurfer.DEFAULT_DESCRIPTIONMultimodalWebSurfer.DEFAULT_START_PAGEMultimodalWebSurfer.VIEWPORT_HEIGHTMultimodalWebSurfer.VIEWPORT_WIDTHMultimodalWebSurfer.MLM_HEIGHTMultimodalWebSurfer.MLM_WIDTHMultimodalWebSurfer.SCREENSHOT_TOKENSMultimodalWebSurfer.close()MultimodalWebSurfer.produced_message_typesMultimodalWebSurfer.on_reset()MultimodalWebSurfer.on_messages()MultimodalWebSurfer.on_messages_stream()
PlaywrightControllerPlaywrightController.sleep()PlaywrightController.get_interactive_rects()PlaywrightController.get_visual_viewport()PlaywrightController.get_focused_rect_id()PlaywrightController.get_page_metadata()PlaywrightController.on_new_page()PlaywrightController.back()PlaywrightController.visit_page()PlaywrightController.page_down()PlaywrightController.page_up()PlaywrightController.gradual_cursor_animation()PlaywrightController.add_cursor_box()PlaywrightController.remove_cursor_box()PlaywrightController.click_id()PlaywrightController.hover_id()PlaywrightController.fill_id()PlaywrightController.scroll_id()PlaywrightController.get_webpage_text()PlaywrightController.get_visible_text()PlaywrightController.get_page_markdown()
- agents.video_surfer
- agents.file_surfer
- agents.code_executor
Router Module
- router
AgentFactoryAgentRegistryIntentRegistrySemanticRouterAgentLLMIntentClassifier- router.workers
- router.user
- router.session
SessionManagerSessionManager.start()SessionManager.shutdown()SessionManager.start_session()SessionManager.start_new_session()SessionManager.get_session()SessionManager.register_agent()SessionManager.interrupt_streaming_agents()SessionManager.unmark_agent_streaming()SessionManager.expire_old_sessions()SessionManager.end_session()
SessionInMemorySessionRepository
- router.workers
- router.user
- router.session
SessionManagerSessionManager.start()SessionManager.shutdown()SessionManager.start_session()SessionManager.start_new_session()SessionManager.get_session()SessionManager.register_agent()SessionManager.interrupt_streaming_agents()SessionManager.unmark_agent_streaming()SessionManager.expire_old_sessions()SessionManager.end_session()
SessionInMemorySessionRepository
Models Module
- models
- models.openai
OpenAIChatCompletionClientAzureOpenAIChatCompletionClientBaseOpenAIChatCompletionClientBaseOpenAIChatCompletionClient.create_from_config()BaseOpenAIChatCompletionClient.create()BaseOpenAIChatCompletionClient.create_stream()BaseOpenAIChatCompletionClient.actual_usage()BaseOpenAIChatCompletionClient.total_usage()BaseOpenAIChatCompletionClient.count_tokens()BaseOpenAIChatCompletionClient.remaining_tokens()BaseOpenAIChatCompletionClient.capabilitiesBaseOpenAIChatCompletionClient.model_info
AzureOpenAIClientConfigurationConfigModelOpenAIClientConfigurationConfigModelBaseOpenAIClientConfigurationConfigModelBaseOpenAIClientConfigurationConfigModel.modelBaseOpenAIClientConfigurationConfigModel.api_keyBaseOpenAIClientConfigurationConfigModel.timeoutBaseOpenAIClientConfigurationConfigModel.max_retriesBaseOpenAIClientConfigurationConfigModel.model_capabilitiesBaseOpenAIClientConfigurationConfigModel.model_infoBaseOpenAIClientConfigurationConfigModel.add_name_prefixesBaseOpenAIClientConfigurationConfigModel.default_headersBaseOpenAIClientConfigurationConfigModel.model_config
CreateArgumentsConfigModelCreateArgumentsConfigModel.frequency_penaltyCreateArgumentsConfigModel.logit_biasCreateArgumentsConfigModel.max_tokensCreateArgumentsConfigModel.nCreateArgumentsConfigModel.presence_penaltyCreateArgumentsConfigModel.response_formatCreateArgumentsConfigModel.seedCreateArgumentsConfigModel.stopCreateArgumentsConfigModel.temperatureCreateArgumentsConfigModel.top_pCreateArgumentsConfigModel.userCreateArgumentsConfigModel.stream_optionsCreateArgumentsConfigModel.model_config
- models.anthropic
AnthropicChatCompletionClientBaseAnthropicChatCompletionClientBaseAnthropicChatCompletionClient.create()BaseAnthropicChatCompletionClient.create_stream()BaseAnthropicChatCompletionClient.count_tokens()BaseAnthropicChatCompletionClient.remaining_tokens()BaseAnthropicChatCompletionClient.actual_usage()BaseAnthropicChatCompletionClient.total_usage()BaseAnthropicChatCompletionClient.capabilitiesBaseAnthropicChatCompletionClient.model_info
AnthropicClientConfigurationAnthropicClientConfiguration.toolsAnthropicClientConfiguration.tool_choiceAnthropicClientConfiguration.modelAnthropicClientConfiguration.max_tokensAnthropicClientConfiguration.temperatureAnthropicClientConfiguration.top_pAnthropicClientConfiguration.top_kAnthropicClientConfiguration.stop_sequencesAnthropicClientConfiguration.response_formatAnthropicClientConfiguration.metadataAnthropicClientConfiguration.api_keyAnthropicClientConfiguration.base_urlAnthropicClientConfiguration.model_capabilitiesAnthropicClientConfiguration.model_infoAnthropicClientConfiguration.timeoutAnthropicClientConfiguration.max_retriesAnthropicClientConfiguration.default_headers
AnthropicClientConfigurationConfigModelCreateArgumentsConfigModelCreateArgumentsConfigModel.modelCreateArgumentsConfigModel.max_tokensCreateArgumentsConfigModel.temperatureCreateArgumentsConfigModel.top_pCreateArgumentsConfigModel.top_kCreateArgumentsConfigModel.stop_sequencesCreateArgumentsConfigModel.response_formatCreateArgumentsConfigModel.metadataCreateArgumentsConfigModel.model_config
- models.azure
- models.ollama
OllamaChatCompletionClientBaseOllamaClientConfigurationConfigModelBaseOllamaClientConfigurationConfigModel.follow_redirectsBaseOllamaClientConfigurationConfigModel.timeoutBaseOllamaClientConfigurationConfigModel.headersBaseOllamaClientConfigurationConfigModel.model_capabilitiesBaseOllamaClientConfigurationConfigModel.model_infoBaseOllamaClientConfigurationConfigModel.model_configBaseOllamaClientConfigurationConfigModel.options
CreateArgumentsConfigModel
- models.replay
ReplayChatCompletionClientReplayChatCompletionClient.create()ReplayChatCompletionClient.create_stream()ReplayChatCompletionClient.actual_usage()ReplayChatCompletionClient.total_usage()ReplayChatCompletionClient.count_tokens()ReplayChatCompletionClient.remaining_tokens()ReplayChatCompletionClient.set_cached_bool_value()ReplayChatCompletionClient.capabilitiesReplayChatCompletionClient.model_infoReplayChatCompletionClient.reset()
- models.cache
- models.utils
- models.openai
- models.openai
OpenAIChatCompletionClientAzureOpenAIChatCompletionClientBaseOpenAIChatCompletionClientBaseOpenAIChatCompletionClient.create_from_config()BaseOpenAIChatCompletionClient.create()BaseOpenAIChatCompletionClient.create_stream()BaseOpenAIChatCompletionClient.actual_usage()BaseOpenAIChatCompletionClient.total_usage()BaseOpenAIChatCompletionClient.count_tokens()BaseOpenAIChatCompletionClient.remaining_tokens()BaseOpenAIChatCompletionClient.capabilitiesBaseOpenAIChatCompletionClient.model_info
AzureOpenAIClientConfigurationConfigModelOpenAIClientConfigurationConfigModelBaseOpenAIClientConfigurationConfigModelBaseOpenAIClientConfigurationConfigModel.modelBaseOpenAIClientConfigurationConfigModel.api_keyBaseOpenAIClientConfigurationConfigModel.timeoutBaseOpenAIClientConfigurationConfigModel.max_retriesBaseOpenAIClientConfigurationConfigModel.model_capabilitiesBaseOpenAIClientConfigurationConfigModel.model_infoBaseOpenAIClientConfigurationConfigModel.add_name_prefixesBaseOpenAIClientConfigurationConfigModel.default_headersBaseOpenAIClientConfigurationConfigModel.model_config
CreateArgumentsConfigModelCreateArgumentsConfigModel.frequency_penaltyCreateArgumentsConfigModel.logit_biasCreateArgumentsConfigModel.max_tokensCreateArgumentsConfigModel.nCreateArgumentsConfigModel.presence_penaltyCreateArgumentsConfigModel.response_formatCreateArgumentsConfigModel.seedCreateArgumentsConfigModel.stopCreateArgumentsConfigModel.temperatureCreateArgumentsConfigModel.top_pCreateArgumentsConfigModel.userCreateArgumentsConfigModel.stream_optionsCreateArgumentsConfigModel.model_config
- models.anthropic
AnthropicChatCompletionClientBaseAnthropicChatCompletionClientBaseAnthropicChatCompletionClient.create()BaseAnthropicChatCompletionClient.create_stream()BaseAnthropicChatCompletionClient.count_tokens()BaseAnthropicChatCompletionClient.remaining_tokens()BaseAnthropicChatCompletionClient.actual_usage()BaseAnthropicChatCompletionClient.total_usage()BaseAnthropicChatCompletionClient.capabilitiesBaseAnthropicChatCompletionClient.model_info
AnthropicClientConfigurationAnthropicClientConfiguration.toolsAnthropicClientConfiguration.tool_choiceAnthropicClientConfiguration.modelAnthropicClientConfiguration.max_tokensAnthropicClientConfiguration.temperatureAnthropicClientConfiguration.top_pAnthropicClientConfiguration.top_kAnthropicClientConfiguration.stop_sequencesAnthropicClientConfiguration.response_formatAnthropicClientConfiguration.metadataAnthropicClientConfiguration.api_keyAnthropicClientConfiguration.base_urlAnthropicClientConfiguration.model_capabilitiesAnthropicClientConfiguration.model_infoAnthropicClientConfiguration.timeoutAnthropicClientConfiguration.max_retriesAnthropicClientConfiguration.default_headers
AnthropicClientConfigurationConfigModelCreateArgumentsConfigModelCreateArgumentsConfigModel.modelCreateArgumentsConfigModel.max_tokensCreateArgumentsConfigModel.temperatureCreateArgumentsConfigModel.top_pCreateArgumentsConfigModel.top_kCreateArgumentsConfigModel.stop_sequencesCreateArgumentsConfigModel.response_formatCreateArgumentsConfigModel.metadataCreateArgumentsConfigModel.model_config
- models.azure
- models.ollama
OllamaChatCompletionClientBaseOllamaClientConfigurationConfigModelBaseOllamaClientConfigurationConfigModel.follow_redirectsBaseOllamaClientConfigurationConfigModel.timeoutBaseOllamaClientConfigurationConfigModel.headersBaseOllamaClientConfigurationConfigModel.model_capabilitiesBaseOllamaClientConfigurationConfigModel.model_infoBaseOllamaClientConfigurationConfigModel.model_configBaseOllamaClientConfigurationConfigModel.options
CreateArgumentsConfigModel
- models.replay
ReplayChatCompletionClientReplayChatCompletionClient.create()ReplayChatCompletionClient.create_stream()ReplayChatCompletionClient.actual_usage()ReplayChatCompletionClient.total_usage()ReplayChatCompletionClient.count_tokens()ReplayChatCompletionClient.remaining_tokens()ReplayChatCompletionClient.set_cached_bool_value()ReplayChatCompletionClient.capabilitiesReplayChatCompletionClient.model_infoReplayChatCompletionClient.reset()
- models.cache
- models.utils
Memory Module
Tools Module
UI Module
Utils Module
Adapter Module
MCP Module
Zerocode Module
Edge Module