Member Junction
    Preparing search index...

    Interface ResponseTypeInclusionRules

    Granular control over which parts of the response type definition to include. When specified as an object, enables fine-grained control over type sections. Sections auto-align with their corresponding documentation flags unless explicitly overridden.

    // Minimal response type - only core fields
    const minimal: ResponseTypeInclusionRules = {
        payload: false,
        responseForms: false,
        commands: false,
        forEach: false,
        while: false
    };
    interface ResponseTypeInclusionRules {
        artifactToolCalls?: boolean;
        commands?: boolean;
        decisions?: boolean;
        finishIf?: boolean;
        forEach?: boolean;
        payload?: boolean;
        pipeline?: boolean;
        responseForms?: boolean;
        scratchpad?: boolean;
        tasks?: boolean;
        while?: boolean;
    }
    Index

    Properties

    artifactToolCalls? commands? decisions? finishIf? forEach? payload? pipeline? responseForms? scratchpad? tasks? while?

    Properties

    artifactToolCalls?: boolean

    Include artifactToolCalls field in the response interface. Auto-aligns with includeArtifactToolsDocs unless explicitly set.

    true
    commands?: boolean

    Include actionableCommands/automaticCommands type definitions. Auto-aligns with includeCommandDocs unless explicitly set.

    true
    decisions?: boolean

    Include decisions field in the response interface. Auto-aligns with includeDecisionsDocs unless explicitly set, and so is off unless the agent opts in with includeDecisionsDocs: true. Always off unless decisionsEnabled is true, even when set explicitly.

    true
    finishIf?: boolean

    Include finishIf field in the nextStep response interface. Auto-aligns with includeFinishIfDocs unless explicitly set, and so is off whenever finishIfMode is 'off', the default. Always off unless decisionsEnabled is true, even when set explicitly.

    true
    forEach?: boolean

    Include ForEach operation in nextStep.type union and forEach property. Auto-aligns with includeForEachDocs unless explicitly set.

    true
    payload?: boolean

    Include payloadChangeRequest type definition in the response interface. Auto-aligns with includePayloadInPrompt unless explicitly set.

    true
    pipeline?: boolean

    Include the pipeline field in the response interface. Auto-aligns with includePipelineDocs unless explicitly set.

    true
    responseForms?: boolean

    Include responseForm type definition in the response interface. Auto-aligns with includeResponseFormDocs unless explicitly set.

    true
    scratchpad?: boolean

    Include scratchpad field in the response interface. Auto-aligns with includeScratchpadDocs unless explicitly set.

    true
    tasks?: boolean

    Include 'Tasks' in the nextStep.type union and the tasks property. Auto-aligns with enableTaskGraphs unless explicitly set.

    Unlike its siblings this defaults to false, because enableTaskGraphs does: an agent that has not opted in must not even see the type, or the model will reach for it.

    false
    while?: boolean

    Include While operation in nextStep.type union and while property. Auto-aligns with includeWhileDocs unless explicitly set.

    true

    Settings

    Member Visibility

    On This Page

    Properties