models
Class info¶
Classes¶
| Name | Children | Inherits |
|---|---|---|
| ApprovalOption pyt3client.native.models A choice an approval request offers (`ProviderApprovalOption`). |
||
| DomainEvent pyt3client.native.models A thread event (`OrchestrationV2DomainEvent`); `payload` depends on `type`. |
||
| NativeItemRef pyt3client.native.models The provider's own id of what an item stands for (`OrchestrationV2ProviderRef`). |
||
| Run pyt3client.native.models A run of a thread (`run.created` / `run.updated`). |
||
| RuntimeRequest pyt3client.native.models An approval or question a provider waits on (`OrchestrationV2RuntimeRequest`). |
||
| T3Model pyt3client.models._base Snake-case Python fields over T3 Code's camelCase wire names. |
||
| ThreadEvent pyt3client.native.models One event of the thread, in `sequence` order. |
||
| ThreadSnapshot pyt3client.native.models The thread as it is when the subscription starts; events continue after it. |
||
| ThreadSynchronized pyt3client.native.models The subscription caught up with the thread. |
||
| TurnItem pyt3client.native.models A timeline row (`OrchestrationV2TurnItem`): a message, reasoning, tool work, a request. |
||
| UnknownStreamItem pyt3client.native.models A stream item of a kind this client does not know (newer servers). |
||
| _Open pyt3client.native.models |
🛈 DocStrings¶
What orchestration.subscribeThread streams, as far as clients of pyt3client need it.
Hand-written, unlike the MCP models: the native contracts are Effect Schemas with
no JSON Schema endpoint. Fields not listed here are kept (extra="allow"), so
model_extra holds what newer servers add.
Upstream (packages/contracts/src/orchestrationV2.ts):
OrchestrationV2ThreadStreamItem:snapshot(the thread's projection), thenevents (OrchestrationV2DomainEvent, numbered bysequence),synchronized.OrchestrationV2TurnItem(the payload ofturn-item.updated): one row of the timeline. Text items grow in place whilestreamingis true.OrchestrationV2RuntimeRequest(runtime-request.updated): an approval or a question the provider waits on; answer it withruntime-request.respond.
ApprovalDecision
¶
ApprovalDecision = Literal['accept', 'acceptForSession', 'acceptAlways', 'decline', 'cancel']
ProviderApprovalDecision (upstream packages/contracts/src/providerPolicy.ts).
ApprovalOption
¶
Bases: _Open
A choice an approval request offers (ProviderApprovalOption).
Source code in src/pyt3client/native/models.py
34 35 36 37 38 39 | |
DomainEvent
¶
Bases: _Open
A thread event (OrchestrationV2DomainEvent); payload depends on type.
Source code in src/pyt3client/native/models.py
108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 | |
run
¶
run() -> Run | None
The run of a run.created or run.updated event.
Source code in src/pyt3client/native/models.py
122 123 124 125 126 | |
runtime_request
¶
runtime_request() -> RuntimeRequest | None
The request of a runtime-request.updated event.
Source code in src/pyt3client/native/models.py
128 129 130 131 132 | |
turn_item
¶
turn_item() -> TurnItem | None
The item of a turn-item.updated event.
Source code in src/pyt3client/native/models.py
116 117 118 119 120 | |
NativeItemRef
¶
Bases: _Open
The provider's own id of what an item stands for (OrchestrationV2ProviderRef).
An approval request shares it with the tool call it is about.
Source code in src/pyt3client/native/models.py
42 43 44 45 46 47 48 49 | |
Run
¶
Bases: _Open
A run of a thread (run.created / run.updated).
Source code in src/pyt3client/native/models.py
88 89 90 91 92 93 94 95 | |
status
instance-attribute
¶
status: str
preparing, queued, starting, running, waiting, completed,
interrupted, failed, cancelled or rolled_back.
RuntimeRequest
¶
Bases: _Open
An approval or question a provider waits on (OrchestrationV2RuntimeRequest).
Source code in src/pyt3client/native/models.py
98 99 100 101 102 103 104 105 | |
kind
instance-attribute
¶
kind: str
A ProviderRequestKind, or dynamic_tool_call, user_input, auth_refresh.
ThreadEvent
¶
Bases: _Open
One event of the thread, in sequence order.
Source code in src/pyt3client/native/models.py
144 145 146 147 148 149 | |
ThreadSnapshot
¶
Bases: _Open
The thread as it is when the subscription starts; events continue after it.
Source code in src/pyt3client/native/models.py
135 136 137 138 139 140 141 | |
projection
instance-attribute
¶
projection: dict[str, JsonValue]
OrchestrationV2ThreadProjection: thread, runs, turn items, requests, ...
ThreadSynchronized
¶
Bases: _Open
The subscription caught up with the thread.
Source code in src/pyt3client/native/models.py
152 153 154 155 | |
TurnItem
¶
Bases: _Open
A timeline row (OrchestrationV2TurnItem): a message, reasoning, tool work, a request.
type is e.g. user_message, assistant_message, reasoning, command_execution,
file_change, dynamic_tool, approval_request, user_input_request,
checkpoint. status is one of idle, pending, running, waiting,
completed, interrupted, failed, cancelled, rolled_back.
Source code in src/pyt3client/native/models.py
52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 | |
options
class-attribute
instance-attribute
¶
options: list[ApprovalOption] | None = None
For approval_request: the decisions on offer, when the provider names them.
prompt
class-attribute
instance-attribute
¶
prompt: str | None = None
For approval_request: what is to be approved, such as the command.
request_id
class-attribute
instance-attribute
¶
request_id: str | None = None
For approval_request and user_input_request: the runtime request to answer.
request_kind
class-attribute
instance-attribute
¶
request_kind: str | None = None
For approval_request: command, file-read, file-change, mcp-elicitation
or permission (ProviderRequestKind).
text
class-attribute
instance-attribute
¶
text: str | None = None
Text of message and reasoning items; complete once streaming is false.
UnknownStreamItem
¶
Bases: _Open
A stream item of a kind this client does not know (newer servers).
Source code in src/pyt3client/native/models.py
158 159 160 161 | |
parse_stream_item
¶
parse_stream_item(value: JsonValue) -> ThreadStreamItem
A subscribeThread stream value as a model.
Raises:
| Type | Description |
|---|---|
ValidationError
|
A known kind with an unexpected shape. |
Source code in src/pyt3client/native/models.py
167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 | |