Model Reference extra

Version: 0.10.1

`common.SvBaseModel`

Base model for all Supervaize models.

No fields found.

`telemetry.Telemetry`

Inherits from: telemetry.TelemetryModel

Base class for all telemetry data in the Supervaize Control system.

Telemetry represents monitoring and observability data sent from agents to the control system. This includes logs, metrics, events, traces, exceptions, diagnostics and custom telemetry.

Inherits from TelemetryModel which defines the core telemetry attributes:

agentId: The ID of the agent sending the telemetry
type: The TelemetryType enum indicating the telemetry category (logs, metrics, etc)
category: The TelemetryCategory enum for the functional area (system, application, etc)
severity: The TelemetrySeverity enum indicating importance (debug, info, warning, etc)
details: A dictionary containing telemetry-specific details

No additional fields beyond parent class.

`agent.AgentCustomMethodParams`

Inherits from: agent.AgentMethodParams

Model Fields

Field	Type	Default	Description
`method_name`	`str`	required

`agent.AgentJobContextBase`

Base model for agent job context parameters

Field	Type	Default	Description
`job_context`	`JobContext`	required
`job_fields`	`Dict[str, Any]`	required

`agent.AgentMethodParams`

Method parameters for agent operations.

Field	Type	Default	Description
`params`	`Dict[str, Any]`	—	A simple key-value dictionary of parameters what will be passed to the AgentMethod.method as kwargs

`agent.AgentMethods`

Inherits from: agent.AgentMethodsAbstract

No additional fields beyond parent class.

`agent.AgentMethodsAbstract`

A base class for creating Pydantic models.

Field	Type	Default
`job_start`	`AgentMethod`	required
`job_stop`	`AgentMethod`	`None`
`job_status`	`AgentMethod`	`None`
`human_answer`	`AgentMethod`	`None`
`chat`	`AgentMethod`	`None`
`custom`	`dict[str, supervaizer.agent.AgentMethod]`	`None`

`agent.AgentResponse`

Response model for agent endpoints - values provided by Agent.registration_info

Field	Type	Default
`name`	`str`	required
`id`	`str`	required
`author`	`str`	`None`
`developer`	`str`	`None`
`maintainer`	`str`	`None`
`editor`	`str`	`None`
`version`	`str`	required
`api_path`	`str`	required
`description`	`str`	required
`tags`	`list[str]`	`None`
`methods`	`AgentMethods`	`None`
`parameters_setup`	`typing.List[typing.Dict[str, typing.Any]]`	`None`
`server_agent_id`	`str`	`None`
`server_agent_status`	`str`	`None`
`server_agent_onboarding_status`	`str`	`None`
`server_encrypted_parameters`	`str`	`None`

`case.CaseNodes`

Inherits from: common.SvBaseModel

Model Fields

Field	Type	Default	Description
`nodes`	`List[case.CaseNode]`	[]

`job.Job`

Inherits from: job.AbstractJob

Jobs are typically created by the platform and are not created by the agent.

Args: id (str): Unique identifier for the job - provided by the platform agent_name (str): Name (slug) of the agent running the job status (EntityStatus): Current status of the job job_context (JobContext): Context information for the job payload (Any, optional): Job payload data. Defaults to None result (Any, optional): Job result data. Defaults to None error (str, optional): Error message if job failed. Defaults to None responses (list[JobResponse], optional): List of job responses. Defaults to empty list finished_at (datetime, optional): When job completed. Defaults to None created_at (datetime, optional): When job was created. Defaults to None

No additional fields beyond parent class.

`job.JobContext`

Inherits from: common.SvBaseModel

Model Fields

Field	Type	Default
`workspace_id`	`str`	required
`job_id`	`str`	required
`started_by`	`str`	required
`started_at`	`datetime`	required
`mission_id`	`str`	required
`mission_name`	`str`	required
`mission_context`	`Any`	`None`
`job_instructions`	`JobInstructions`	`None`

`job.JobResponse`

Inherits from: common.SvBaseModel

Model Fields

Field	Type	Default
`job_id`	`str`	required
`status`	`<enum 'EntityStatus'>`	required
`message`	`str`	required
`payload`	`dict[str, typing.Any]`	`None`
`error_message`	`str`	`None`
`error_traceback`	`str`	`None`

`event.JobStartConfirmationEvent`

Inherits from: event.Event

No additional fields beyond parent class.

`case.Case`

Inherits from: case.CaseAbstractModel

No additional fields beyond parent class.

`case.CaseAbstractModel`

Inherits from: common.SvBaseModel

Model Fields

Field	Type	Default
`id`	`str`	required
`job_id`	`str`	required
`name`	`str`	required
`account`	`ForwardRef('Account')`	required
`description`	`str`	required
`status`	`<enum 'EntityStatus'>`	required
`updates`	`List[case.CaseNodeUpdate]`	[]
`total_cost`	`float`	0.0
`final_delivery`	`typing.Dict[str, typing.Any]`	`None`
`finished_at`	`datetime`	`None`

`case.CaseNode`

Inherits from: common.SvBaseModel

Model Fields

Field	Type	Default
`name`	`str`	required
`type`	`<enum 'CaseNodeType'>`	required
`factory`	`Callable[..., case.CaseNodeUpdate]`	required
`description`	`str`	`None`
`can_be_confirmed`	`bool`	False

`case.CaseNodeUpdate`

Inherits from: common.SvBaseModel

CaseNodeUpdate is a class that represents an update to a case node.

Returns: CaseNodeUpdate: CaseNodeUpdate object

Model Fields

Field	Type	Default
`index`	`int`	`None`
`cost`	`float`	`None`
`name`	`str`	`None`
`payload`	`typing.Dict[str, typing.Any]`	`None`
`is_final`	`bool`	False
`error`	`str`	`None`

`deploy.drivers.base.DeploymentPlan`

Deployment plan containing all actions to be taken.

Field	Type	Default
`platform`	`str`	required
`service_name`	`str`	required
`environment`	`str`	required
`region`	`str`	required
`project_id`	`str`	`None`
`actions`	`List[deploy.drivers.base.ResourceAction]`	[]
`total_cost_estimate`	`str`	`None`
`estimated_duration`	`str`	`None`
`current_image`	`str`	`None`
`current_url`	`str`	`None`
`current_status`	`str`	`None`
`target_image`	`str`	required
`target_port`	`int`	8000
`target_env_vars`	`Dict[str, str]`
`target_secrets`	`Dict[str, str]`

`deploy.drivers.base.DeploymentResult`

Result of a deployment operation.

Field	Type	Default
`success`	`bool`	required
`service_url`	`str`	`None`
`service_id`	`str`	`None`
`revision`	`str`	`None`
`image_digest`	`str`	`None`
`status`	`str`	'unknown'
`health_status`	`str`	'unknown'
`deployment_time`	`float`	`None`
`error_message`	`str`	`None`
`error_details`	`typing.Dict[str, typing.Any]`	`None`

`deploy.state.DeploymentState`

Deployment state model.

Field	Type	Default	Description
`version`	`int`	2	State file format version
`service_name`	`str`	required	Name of the deployed service
`platform`	`str`	required	Target platform (cloud-run
`environment`	`str`	required	Environment (dev
`region`	`str`	required	Provider region
`project_id`	`str`	`None`	GCP project / AWS account / DO project
`image_tag`	`str`	required	Docker image tag
`image_digest`	`str`	`None`	Docker image digest
`service_url`	`str`	`None`	Public service URL
`revision`	`str`	`None`	Service revision/version
`created_at`	`datetime`	—	Deployment creation time
`updated_at`	`datetime`	—	Last update time
`status`	`str`	'unknown'	Deployment status
`health_status`	`str`	'unknown'	Health check status
`port`	`int`	8000	Application port
`api_key_generated`	`bool`	False	Whether API key was generated
`rsa_key_generated`	`bool`	False	Whether RSA key was generated
`provider_data`	`Dict[str, Any]`	—	Platform-specific data

`deploy.drivers.base.ResourceAction`

Represents an action to be taken on a resource.

Field	Type	Default
`resource_type`	`<enum 'ResourceType'>`	required
`action_type`	`<enum 'ActionType'>`	required
`resource_name`	`str`	required
`description`	`str`	required
`cost_estimate`	`str`	`None`
`metadata`	`typing.Dict[str, typing.Any]`	`None`

`deploy.health.HealthCheckConfig`

Configuration for health check operations.

Field	Type	Default
`timeout`	`int`	60
`max_retries`	`int`	5
`base_delay`	`float`	1.0
`max_delay`	`float`	30.0
`backoff_multiplier`	`float`	2.0
`success_threshold`	`int`	1
`endpoints`	`typing.List[str]`	`None`

`deploy.health.HealthCheckResult`

Result of a health check operation.

Field	Type	Default
`status`	`<enum 'HealthStatus'>`	required
`response_time`	`float`	required
`status_code`	`int`	`None`
`error_message`	`str`	`None`
`endpoint`	`str`	`None`
`timestamp`	`float`	0.0

`event.AbstractEvent`

Inherits from: common.SvBaseModel

Model Fields

Field	Type	Default
`source`	`Dict[str, Any]`	required
`account`	`Any`	required
`type`	`<enum 'EventType'>`	required
`object_type`	`str`	required
`details`	`Dict[str, Any]`	required

`event.AgentRegisterEvent`

Inherits from: event.Event

Event sent when an agent registers with the control system.

Test in tests/test_agent_register_event.py

No additional fields beyond parent class.

`event.CaseStartEvent`

Inherits from: event.Event

No additional fields beyond parent class.

`event.CaseUpdateEvent`

Inherits from: event.Event

No additional fields beyond parent class.

`event.Event`

Inherits from: event.AbstractEvent

Base class for all events in the Supervaize Control system.

Events represent messages sent from agents to the control system to communicate status, anomalies, deliverables and other information.

Inherits from AbstractEvent which defines the core event attributes:

source: The source/origin of the event (e.g. agent/server URI)
type: The EventType enum indicating the event category
account: The account that the event belongs to
details: A dictionary containing event-specific details

Tests in tests/test_event.py

No additional fields beyond parent class.

`event.JobFinishedEvent`

Inherits from: event.Event

No additional fields beyond parent class.

`event.ServerRegisterEvent`

Inherits from: event.Event

No additional fields beyond parent class.

`job.AbstractJob`

Inherits from: common.SvBaseModel

Model Fields

Field	Type	Default
`id`	`str`	required
`name`	`str`	required
`agent_name`	`str`	required
`status`	`<enum 'EntityStatus'>`	required
`job_context`	`JobContext`	required
`payload`	`Any`	`None`
`result`	`Any`	`None`
`error`	`str`	`None`
`responses`	`list[job.JobResponse]`	[]
`finished_at`	`datetime`	`None`
`created_at`	`datetime`	`None`
`agent_parameters`	`list[dict[str, typing.Any]]`	`None`
`case_ids`	`list[str]`	[]

`job.JobInstructions`

Inherits from: common.SvBaseModel

Model Fields

Field	Type	Default
`max_cases`	`int`	`None`
`max_duration`	`int`	`None`
`max_cost`	`float`	`None`
`stop_on_warning`	`bool`	False
`stop_on_error`	`bool`	True
`job_start_time`	`float`	`None`

`routes.CaseUpdateRequest`

Inherits from: common.SvBaseModel

Request model for updating a case with answer to a question.

Model Fields

Field	Type	Default	Description
`answer`	`Dict[str, Any]`	required
`message`	`str`	`None`

`server_utils.ErrorResponse`

Standard error response model

Field	Type	Default
`error`	`str`	required
`error_type`	`<enum 'ErrorType'>`	required
`detail`	`str`	`None`
`timestamp`	`datetime`	datetime.datetime(2026, 1, 25, 14, 28, 58, 746390)
`status_code`	`int`	required

`server.ServerInfo`

Complete server information for storage.

Field	Type	Default
`id`	`str`	'server_instance'
`host`	`str`	required
`port`	`int`	required
`api_version`	`str`	required
`environment`	`str`	required
`agents`	`List[Dict[str, str]]`	required
`start_time`	`float`	required
`created_at`	`str`	required
`updated_at`	`str`	required

`telemetry.TelemetryModel`

A base class for creating Pydantic models.

Field	Type	Default
`agentId`	`str`	required
`type`	`<enum 'TelemetryType'>`	required
`category`	`<enum 'TelemetryCategory'>`	required
`severity`	`<enum 'TelemetrySeverity'>`	required
`details`	`Dict[str, Any]`	required

Uploaded on 2026-01-25 14:28:59

common.SvBaseModel​

telemetry.Telemetry​

agent.AgentCustomMethodParams​

Model Fields​

agent.AgentJobContextBase​

agent.AgentMethodParams​

agent.AgentMethods​

agent.AgentMethodsAbstract​

agent.AgentResponse​

case.CaseNodes​

Model Fields​

job.Job​

job.JobContext​

Model Fields​

job.JobResponse​

Model Fields​

event.JobStartConfirmationEvent​

case.Case​

case.CaseAbstractModel​

Model Fields​

case.CaseNode​

Model Fields​

case.CaseNodeUpdate​

Model Fields​

deploy.drivers.base.DeploymentPlan​

deploy.drivers.base.DeploymentResult​

deploy.state.DeploymentState​

deploy.drivers.base.ResourceAction​

deploy.health.HealthCheckConfig​

deploy.health.HealthCheckResult​

event.AbstractEvent​

Model Fields​

event.AgentRegisterEvent​

event.CaseStartEvent​

event.CaseUpdateEvent​

event.Event​

event.JobFinishedEvent​

event.ServerRegisterEvent​

job.AbstractJob​

Model Fields​

job.JobInstructions​

Model Fields​

routes.CaseUpdateRequest​

Model Fields​

server_utils.ErrorResponse​

server.ServerInfo​

telemetry.TelemetryModel​

`common.SvBaseModel`

`telemetry.Telemetry`

`agent.AgentCustomMethodParams`

Model Fields

`agent.AgentJobContextBase`

`agent.AgentMethodParams`

`agent.AgentMethods`

`agent.AgentMethodsAbstract`

`agent.AgentResponse`

`case.CaseNodes`

Model Fields

`job.Job`

`job.JobContext`

Model Fields

`job.JobResponse`

Model Fields

`event.JobStartConfirmationEvent`

`case.Case`

`case.CaseAbstractModel`

Model Fields

`case.CaseNode`

Model Fields

`case.CaseNodeUpdate`

Model Fields

`deploy.drivers.base.DeploymentPlan`

`deploy.drivers.base.DeploymentResult`

`deploy.state.DeploymentState`

`deploy.drivers.base.ResourceAction`

`deploy.health.HealthCheckConfig`

`deploy.health.HealthCheckResult`

`event.AbstractEvent`

Model Fields

`event.AgentRegisterEvent`

`event.CaseStartEvent`

`event.CaseUpdateEvent`

`event.Event`

`event.JobFinishedEvent`

`event.ServerRegisterEvent`

`job.AbstractJob`

Model Fields

`job.JobInstructions`

Model Fields

`routes.CaseUpdateRequest`

Model Fields

`server_utils.ErrorResponse`

`server.ServerInfo`

`telemetry.TelemetryModel`