Skip to content

chore(contracts): sync the worker's steering v2 contract #9727

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
waleedlatif1 merged 1 commit into from
Nov 6, 2026
+87 −0
Merged

chore(contracts): sync the worker's steering v2 contract #9727

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions apps/sim/lib/mothership/generated/mothership-stream-v1.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ export type MothershipStreamV1EventEnvelope =
| MothershipStreamV1RunResumedEventEnvelope
| MothershipStreamV1CompactionStartEventEnvelope
| MothershipStreamV1CompactionDoneEventEnvelope
| MothershipStreamV1SteeringAppliedEventEnvelope
| MothershipStreamV1TaskArmedEventEnvelope
| MothershipStreamV1TaskDeliveredEventEnvelope
| MothershipStreamV1ErrorEventEnvelope
Expand Down Expand Up @@ -371,6 +372,25 @@ export interface MothershipStreamV1CompactionDonePayload {
export interface MothershipStreamV1CompactionDoneData {
summary_chars: number
}
export interface MothershipStreamV1SteeringAppliedEventEnvelope {
payload: MothershipStreamV1SteeringAppliedPayload
scope?: MothershipStreamV1StreamScope
seq: number
stream: MothershipStreamV1StreamRef
trace?: MothershipStreamV1Trace
ts: string
type: 'run'
v: 1
}
export interface MothershipStreamV1SteeringAppliedPayload {
content?: string
eventSeq?: number
kind: 'steering_applied'
messageId?: string
mode?: 'deferred' | 'interrupt'
steeringId: string
textOffset?: number
}
export interface MothershipStreamV1TaskArmedEventEnvelope {
payload: MothershipStreamV1TaskArmedPayload
scope?: MothershipStreamV1StreamScope
Expand Down
67 changes: 67 additions & 0 deletions apps/sim/lib/mothership/generated/protocol.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -511,6 +511,73 @@ export interface SteerRequest {
content: string;
}

/**
* The images one run takes in steers over its whole life. With a turn's own five they stay
* under the twenty image and document blocks a model request holds.
*/
export const MAX_RUN_STEERED_IMAGES = 10;

/** The most attachments and mentions one steer carries: Sim's MAX_CHAT_CONTEXTS for a turn. */
export const MAX_STEER_CONTEXTS = 100;

/**
* POST /api/streams/steer/v2: steer the live run `messageId` with one immutable input, answered
* with its durable disposition, which a retry of the same body reads back. Only `not_applied`
* (or a 422) lets the caller send the input as a new turn, with the steeringId as its
* messageId; a turn for an input a run applied is refused. Refusals keep nothing:
* - 400: an invalid body, or images outside an organization chat (`steering_scope`).
* - 404 `steering_target_missing`: no such run (or not admitted yet).
* - 409 `steering_conflict`: a different input under this steeringId.
* - 422 `steering_image_limit`: past MAX_RUN_STEERED_IMAGES, applied images included. Final
* for the run: send the input as the next turn once the run ends.
* - 429 `steering_capacity`: the pending queue is full; retryable once the run applies it.
*/
export const SteerV2Request = z.strictObject({
messageId: z.uuid(),
steeringId: z.uuid(),
content: z.string().min(1).max(1_048_576),
/** Attachments and @-mentions, rendered into the steer the way a turn renders its own. */
context: ChatPayloadSchema.shape.context.unwrap().max(MAX_STEER_CONTEXTS).default([]),
/** Only an organization chat accepts images, as for a turn (400 otherwise). */
assistantImages: ChatPayloadSchema.shape.assistantImages,
});
export type SteerV2Request = z.infer<typeof SteerV2Request>;

/**
* - `queued`: accepted; the run applies it at its next model step, or ends first and then
* reports `not_applied`.
* - `applied`: logged into the run's model input, which its next model request carries (as
* v1's frame means). `eventSeq` is its steering_input event in the chat
* log and `textOffset` the main answer's length when it applied (UTF-16 code units), the
* same values the `steering_applied` frame carries.
* - `not_applied`: the run ended, or was stopped, before applying it, and never will. A run
* that would apply it only by exceeding its usage limit, or one whose input the request
* supplies (an execution, a structured response), ends instead and reports this.
*
* A steeringId belongs to the run of the chat that first accepted it: a retry naming another
* run of the chat reads that run's disposition.
*/
export const SteerV2Response = z.discriminatedUnion("status", [
z.strictObject({ steeringId: z.string(), status: z.literal("queued") }),
z.strictObject({
steeringId: z.string(),
status: z.literal("applied"),
eventSeq: z.number().int().positive(),
textOffset: z.number().int().nonnegative(),
}),
z.strictObject({ steeringId: z.string(), status: z.literal("not_applied") }),
]);
export type SteerV2Response = z.infer<typeof SteerV2Response>;

/** The `run`/`steering_applied` frame: a steer reached the run's model input. */
export interface StreamSteeringApplied {
kind: "steering_applied";
steeringId: string;
/** As in SteerV2Response's `applied`; absent only on frames from workers without steer v2. */
eventSeq?: number | undefined;
textOffset?: number | undefined;
}

/** POST /api/chats/fork — copy a selected conversation snapshot, never live execution. */
export const ForkChatRequest = z
.strictObject({
Expand Down
Loading