sim_platform.models.contracts

Bounded model requests; credential material is never part of this contract.

sim_platform.models.contracts.local_server(url)[source]

Return (tls, host, port, path) for a local model server URL, or raise.

The URL must be http or https with a host on this machine or a private network: localhost, a loopback, private or link-local IP address. Public hosts are refused so a local profile can never send research data off premises.

Parameters:

url (str)

Return type:

Tuple[bool, str, int, str]

class sim_platform.models.contracts.ModelProfile(provider, model, credential_ref='', network_timeout_seconds=60, max_output_tokens=4096, temperature=None, base_url=None)[source]

Bases: object

Which provider and model an Agent uses, and the credential it is stored under.

Holds no secret: credential_ref names a CredentialStore entry. A local openai-compatible profile sets base_url (for example http://127.0.0.1:11434/v1 for Ollama or http://localhost:8000/v1 for vLLM) and may leave credential_ref empty when the server needs no key.

Parameters:
  • provider (str)

  • model (str)

  • credential_ref (str)

  • network_timeout_seconds (float)

  • max_output_tokens (int)

  • temperature (float | None)

  • base_url (str | None)

provider: str
model: str
credential_ref: str = ''
network_timeout_seconds: float = 60
max_output_tokens: int = 4096
temperature: float | None = None
base_url: str | None = None
exception sim_platform.models.contracts.ProviderError(code, retry_after_seconds=None)[source]

Bases: ContractError

A classified model failure; code (for example ‘RATE_LIMIT’) is safe to log.

retry_after_seconds is the provider’s suggested wait as decimal text, or None.

Parameters:
  • code (str)

  • retry_after_seconds (Optional[str])

Return type:

None

class sim_platform.models.contracts.ModelProvider(*args, **kwargs)[source]

Bases: Protocol

A model adapter run in the Agent process (for example OpenAIResponses).

Adapters may also provide request_received(profile, payload, secret, received), which calls received() once the complete raw reply has arrived.

request(profile, value, secret)[source]
Parameters:
  • profile (ModelProfile)

  • value (Dict[str, Any])

  • secret (str)

Return type:

Awaitable[Any]

sim_platform.models.contracts.validate_input(value)[source]

Return a detached copy of a model request, or raise if it is unsupported or too large.

Parameters:

value (Any)

Return type:

Dict[str, Any]