SAMOrchestrator

SAM model of the Orchestrator kind, generated from the Smarter platform’s JSON Schema.

Do not edit: run scripts/generate_sam_models.py. See smarter.models.sam.

class smarter.models.sam.orchestrator.HarnessRole(*values)

Bases: Enum

Role an LLMClient (Harness) plays within an Orchestrator.

Values must stay aligned with smarter.apps.orchestrator.models.OrchestratorHarness.Role.

class smarter.models.sam.orchestrator.OrchestrationStrategy(*values)

Bases: Enum

Coordination pattern the Orchestrator applies across its member LLMClients.

Values must stay aligned with smarter.apps.orchestrator.models.OrchestrationStrategy.

class smarter.models.sam.orchestrator.SAMDependency(*, kind: str, name: str, **extra_data: Any)

Bases: SAMModel

A resource that depends on the resource that a manifest describes.

kind: str

Kind[String]: The SAM kind of the resource that depends on this resource, e.g. LLMClient.

Read only.

name: str

Name[String]: The name of the resource that depends on this resource.

Read only.

model_config = {'extra': 'allow', 'populate_by_name': True, 'protected_namespaces': (), 'regex_engine': 'python-re', 'use_attribute_docstrings': True}

Configuration for the model, should be a dictionary conforming to [`ConfigDict`][pydantic.config.ConfigDict].

class smarter.models.sam.orchestrator.SAMOrchestratorHarnessConfig(*, config: dict[str, Any] | None = None, executionOrder: Annotated[int, None, Interval(gt=None, ge=0, lt=None, le=None), None] | None = 0, isActive: bool | None = True, llmClientName: str, role: HarnessRole | None = 'executor', **extra_data: Any)

Bases: SAMModel

A single LLMClient (Harness) membership within the Orchestrator.

Mirrors smarter.apps.orchestrator.models.OrchestratorHarness. The llmClientName is a reference by name, not by primary key — resolved against the account’s existing LLMClients at apply time.

config: dict[str, Any] | None

Per-membership overrides (e.g. temperature, system prompt fragment, tool allowlist).

executionOrder: conint(ge=0) | None

Relative ordering for sequential/supervisor strategies.

llmClientName: str

Name of an existing LLMClient to attach as a Harness.

model_config = {'extra': 'allow', 'populate_by_name': True, 'protected_namespaces': (), 'regex_engine': 'python-re', 'use_attribute_docstrings': True}

Configuration for the model, should be a dictionary conforming to [`ConfigDict`][pydantic.config.ConfigDict].

class smarter.models.sam.orchestrator.SAMOrchestratorMetadata(*, annotations: None | list[dict[str, str | int | float | bool | date | datetime | UUID | bytes | list | dict[str, Any]]] = None, description: str | None, name: str, tags: list[str] | None = None, version: str | None, **extra_data: Any)

Bases: SAMModel

Smarter API Orchestrator Manifest - Metadata class.

annotations: None | list[dict[str, str | int | float | bool | date | datetime | UUID | bytes | list | dict[str, Any]]]

The manifest annotations.

Used for storing arbitrary metadata as

key-value pairs. Example: [{‘smarter.sh/test-manifest/project-name’: ‘Scooby dooby do’}]. The key should be a valid url-friendly string. The value accepts multi-line string values (YAML block scalars) and various scalar types including str, int, float, bool, datetime.date, datetime.datetime, decimal.Decimal, uuid.UUID, bytes, list, dict.

description: str | None

The description for this resource.

Be brief. Keep it under 255 characters.

name: str

The camelCase name of the manifest resource.

tags: list[str] | None

The tags of the manifest.

Used for generic resource categorization and search. Example: [‘tag1’, ‘tag2’]

version: str | None

The semantic version of the manifest.

Example: 0.1.0

model_config = {'extra': 'allow', 'populate_by_name': True, 'protected_namespaces': (), 'regex_engine': 'python-re', 'use_attribute_docstrings': True}

Configuration for the model, should be a dictionary conforming to [`ConfigDict`][pydantic.config.ConfigDict].

class smarter.models.sam.orchestrator.SAMOrchestratorSpecConfig(*, harnesses: Annotated[list[SAMOrchestratorHarnessConfig], MinLen(min_length=1)], isActive: bool | None = True, maxIterations: Annotated[int, None, Interval(gt=None, ge=1, lt=None, le=None), None] | None = 10, strategy: OrchestrationStrategy | None = 'sequential', **extra_data: Any)

Bases: SAMModel

Spec block for an Orchestrator SAM manifest.

Mirrors smarter.apps.orchestrator.models.Orchestrator. Consumed by the manifest controller to create/update the corresponding Orchestrator model instance and its OrchestratorHarness memberships.

harnesses: list[SAMOrchestratorHarnessConfig]

LLMClients (Harnesses) that participate in this Orchestrator.

maxIterations: conint(ge=1) | None

Upper bound on orchestration loop iterations.

model_config = {'extra': 'allow', 'populate_by_name': True, 'protected_namespaces': (), 'regex_engine': 'python-re', 'use_attribute_docstrings': True}

Configuration for the model, should be a dictionary conforming to [`ConfigDict`][pydantic.config.ConfigDict].

class smarter.models.sam.orchestrator.SAMOrchestratorStatus(*, accountNumber: str, created: datetime, dependencies: list[SAMDependency] | None = None, modified: datetime, recordLocator: str, username: str, **extra_data: Any)

Bases: SAMModel

Smarter API Orchestrator Manifest - Status class.

accountNumber: str

Orchestrator.status.account_number: The account owner of this Orchestrator.

Read only.

model_config = {'extra': 'allow', 'populate_by_name': True, 'protected_namespaces': (), 'regex_engine': 'python-re', 'use_attribute_docstrings': True}

Configuration for the model, should be a dictionary conforming to [`ConfigDict`][pydantic.config.ConfigDict].

created: datetime

The date in which this resource was created.

Read only.

dependencies: list[SAMDependency] | None

Dependencies[List]: The resources that depend on this resource, and that must be deleted, or stop referring to it, before it can be deleted.

Lists only the resources that you can read. Read only.

modified: datetime

The date in which this resource was most recently changed.

Read only.

recordLocator: str

RecordLocator[String]: An optional identifier used to locate the resource record associated with this manifest.

Read only.

username: str

Orchestrator.status.username: The Smarter user who created this Orchestrator.

Read only.

class smarter.models.sam.orchestrator.SAMOrchestratorSpec(*, config: SAMOrchestratorSpecConfig, **extra_data: Any)

Bases: SAMModel

Smarter API Orchestrator Manifest Orchestrator.spec.

model_config = {'extra': 'allow', 'populate_by_name': True, 'protected_namespaces': (), 'regex_engine': 'python-re', 'use_attribute_docstrings': True}

Configuration for the model, should be a dictionary conforming to [`ConfigDict`][pydantic.config.ConfigDict].

config: SAMOrchestratorSpecConfig

Orchestrator.spec.config[object].

The configuration for the Orchestrator.

class smarter.models.sam.orchestrator.SAMOrchestrator(*, apiVersion: str, kind: str, metadata: SAMOrchestratorMetadata, spec: SAMOrchestratorSpec, status: SAMOrchestratorStatus | None = None, **extra_data: Any)

Bases: SAMModel

Smarter API Manifest - Orchestrator.

model_config = {'extra': 'allow', 'populate_by_name': True, 'protected_namespaces': (), 'regex_engine': 'python-re', 'use_attribute_docstrings': True}

Configuration for the model, should be a dictionary conforming to [`ConfigDict`][pydantic.config.ConfigDict].

apiVersion: str

ApiVersion[String]: Required.

The API version of the AbstractSAMBase.

kind: str

Kind[String]: Required.

The kind of resource described by the manifest.

metadata: SAMOrchestratorMetadata

Orchestrator.metadata[obj]: Required, the Orchestrator metadata.

spec: SAMOrchestratorSpec

Orchestrator.spec[obj]: Required, the Orchestrator specification.

status: SAMOrchestratorStatus | None

Orchestrator.status[obj]: Optional, Read-only.

Stateful status information about the Orchestrator.