chatsky_ui package

Subpackages

• api package
  • Subpackages
    • chatsky_ui.api.api_v1 package
      • Subpackages
      • chatsky_ui.api.api_v1.api module
  • chatsky_ui.api.deps module
    • get_build_manager()
    • get_index()
    • get_run_manager()
    • get_websocket_manager()
• chatsky_ui.clients package
  • chatsky_ui.clients.dff module
• chatsky_ui.core package
  • chatsky_ui.core.config module
    • AppRunner
      • AppRunner.run()
      • AppRunner.set_settings()
      • AppRunner.settings
    • Settings
      • Settings.refresh_work_dir()
      • Settings.save_config()
      • Settings.set_config()
  • chatsky_ui.core.logger_config module
    • get_logger()
    • setup_logging()
• chatsky_ui.db package
  • chatsky_ui.db.base module
    • read_conf()
    • read_logs()
    • write_conf()
• chatsky_ui.schemas package
  • chatsky_ui.schemas.pagination module
    • Pagination
      • Pagination.limit
      • Pagination.model_computed_fields
      • Pagination.model_config
      • Pagination.model_fields
      • Pagination.offset()
      • Pagination.page
  • chatsky_ui.schemas.preset module
    • Preset
      • Preset.end_status
      • Preset.model_computed_fields
      • Preset.model_config
      • Preset.model_fields
      • Preset.wait_time
  • chatsky_ui.schemas.process_status module
    • Status
      • Status.ALIVE
      • Status.COMPLETED
      • Status.FAILED
      • Status.FAILED_WITH_UNEXPECTED_CODE
      • Status.NULL
      • Status.RUNNING
      • Status.STOPPED
• chatsky_ui.services package
  • chatsky_ui.services.index module
    • Index service
    • Index
      • Index.get_services()
      • Index.indexit()
      • Index.indexit_all()
      • Index.load()
      • Index.logger
      • Index.path
      • Index.search_service()
      • Index.set_logger()
      • Index.set_path()
  • chatsky_ui.services.json_converter module
  • chatsky_ui.services.process module
    • Process classes.
    • BuildProcess
      • BuildProcess.get_full_info()
      • BuildProcess.update_db_info()
    • Process
      • Process.check_status()
      • Process.get_full_info()
      • Process.is_alive()
      • Process.periodically_check_status()
      • Process.read_stdout()
      • Process.start()
      • Process.stop()
      • Process.update_db_info()
      • Process.write_stdin()
    • RunProcess
      • RunProcess.get_full_info()
      • RunProcess.update_db_info()
  • chatsky_ui.services.process_manager module
    • Process manager
    • BuildManager
      • BuildManager.check_status()
      • BuildManager.fetch_build_logs()
      • BuildManager.get_build_info()
      • BuildManager.get_full_info()
      • BuildManager.get_full_info_with_runs_info()
      • BuildManager.start()
    • ProcessManager
      • ProcessManager.check_status()
      • ProcessManager.fetch_process_logs()
      • ProcessManager.get_full_info()
      • ProcessManager.get_last_id()
      • ProcessManager.get_process_info()
      • ProcessManager.get_status()
      • ProcessManager.logger
      • ProcessManager.set_logger()
      • ProcessManager.stop()
    • RunManager
      • RunManager.fetch_run_logs()
      • RunManager.get_full_info()
      • RunManager.get_run_info()
      • RunManager.start()
  • chatsky_ui.services.websocket_manager module
    • WebSocketManager
      • WebSocketManager.check_status()
      • WebSocketManager.connect()
      • WebSocketManager.disconnect()
      • WebSocketManager.forward_websocket_messages_to_process()
      • WebSocketManager.logger
      • WebSocketManager.send_process_output_to_websocket()
      • WebSocketManager.set_logger()
• chatsky_ui.tests package
  • Subpackages
    • chatsky_ui.tests.api package
      • chatsky_ui.tests.api.test_bot module
      • chatsky_ui.tests.api.test_flows module
    • chatsky_ui.tests.e2e package
      • chatsky_ui.tests.e2e.test_e2e module
    • chatsky_ui.tests.integration package
      • chatsky_ui.tests.integration.test_api_integration module
    • chatsky_ui.tests.services package
      • chatsky_ui.tests.services.test_process module
      • chatsky_ui.tests.services.test_process_manager module
      • chatsky_ui.tests.services.test_websocket_manager module
  • chatsky_ui.tests.conftest module
    • build_manager()
    • client()
    • override_dependency()
    • pagination()
    • preset()
    • run_manager()
    • run_process()
    • start_process()
    • websocket_manager()

cli module

chatsky_ui.cli.build_bot(build_id: int | None = None, project_dir: Path | None = None, preset: str = 'success')

Builds the bot with one of three various presets.

chatsky_ui.cli.build_scenario(build_id: int, project_dir: Path = '.')

Builds the bot with preset success

chatsky_ui.cli.init(destination: Path | None = None, no_input: bool = False, overwrite_if_exists: bool = True)

Initializes a new Chatsky-UI project using an off-the-shelf template.

chatsky_ui.cli.run_app(host: str | None = None, port: int | None = None, log_level: str | None = None, conf_reload: bool | None = None, project_dir: Path = PosixPath('.')) → None

Runs the UI for your project_dir on host:port.

chatsky_ui.cli.run_bot(build_id: int | None = None, project_dir: Path | None = None, preset: str = 'success')

Runs the bot with one of three various presets.

chatsky_ui.cli.run_scenario(build_id: int, project_dir: Path = '.')

Runs the bot with preset success

main module

chatsky_ui.main.lifespan(app: FastAPI)

async chatsky_ui.main.root() → Response

Redirect ‘/’ to index.html

async chatsky_ui.main.route_static_file(path: str)