-
Notifications
You must be signed in to change notification settings - Fork 46
Expand file tree
/
Copy pathindex.html
More file actions
181 lines (166 loc) · 10.3 KB
/
Copy pathindex.html
File metadata and controls
181 lines (166 loc) · 10.3 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
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
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
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
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
<!doctype html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Sequential Responses — aimock</title>
<link rel="icon" type="image/svg+xml" href="../favicon.svg" />
<link rel="preconnect" href="https://fonts.googleapis.com" />
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin />
<link
href="https://fonts.googleapis.com/css2?family=JetBrains+Mono:ital,wght@0,300;0,400;0,500;0,600;0,700;1,400&family=Instrument+Sans:wght@400;500;600;700&display=swap"
rel="stylesheet"
/>
<link rel="stylesheet" href="../style.css" />
<script src="/pixels.js" defer></script>
</head>
<body>
<nav class="top-nav">
<div class="nav-inner">
<div style="display: flex; align-items: center; gap: 1rem">
<button
class="sidebar-toggle"
onclick="document.querySelector('.sidebar').classList.toggle('open')"
aria-label="Toggle sidebar"
>
☰
</button>
<a href="/" class="nav-brand"> <span class="prompt">$</span> aimock </a>
</div>
<ul class="nav-links">
<li><a href="/">Home</a></li>
<li><a href="/docs" style="color: var(--accent)">Docs</a></li>
<li>
<a href="https://github.com/CopilotKit/aimock" class="gh-link" target="_blank"
><svg width="16" height="16" viewBox="0 0 16 16" fill="currentColor">
<path
d="M8 0C3.58 0 0 3.58 0 8c0 3.54 2.29 6.53 5.47 7.59.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82.64-.18 1.32-.27 2-.27.68 0 1.36.09 2 .27 1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.013 8.013 0 0016 8c0-4.42-3.58-8-8-8z"
/>
</svg>
GitHub</a
>
</li>
</ul>
</div>
</nav>
<div class="docs-layout">
<aside class="sidebar" id="sidebar"></aside>
<main class="docs-content">
<h1>Sequential / Stateful Responses</h1>
<p class="lead">
Use <code>sequenceIndex</code> in fixture match criteria to return different responses for
the same query on each successive call. This enables testing multi-step agent
conversations and retry logic.
</p>
<h2>How It Works</h2>
<ul>
<li>The router tracks how many times each unique match pattern has been hit</li>
<li>
<code>sequenceIndex: 0</code> matches the first request,
<code>sequenceIndex: 1</code> the second, etc.
</li>
<li>Different match patterns have independent counters</li>
<li>
If a sequenceIndex fixture does not match the current count, routing falls through to
the next fixture
</li>
<li>
Fixtures without <code>sequenceIndex</code> match any occurrence (backward compatible)
</li>
<li>Counters reset on <code>mock.reset()</code></li>
</ul>
<h2>Unit Test: 2-Step Sequence</h2>
<div class="code-block">
<div class="code-block-header">sequence.test.ts <span class="lang-tag">ts</span></div>
<pre><code><span class="kw">const</span> <span class="op">mock</span> = <span class="kw">new</span> <span class="type">LLMock</span>();
<span class="kw">await</span> <span class="op">mock</span>.<span class="fn">start</span>();
<span class="op">mock</span>.<span class="fn">on</span>({ <span class="prop">userMessage</span>: <span class="str">"plan"</span>, <span class="prop">sequenceIndex</span>: <span class="num">0</span> }, { <span class="prop">content</span>: <span class="str">"Step 1: planning..."</span> });
<span class="op">mock</span>.<span class="fn">on</span>({ <span class="prop">userMessage</span>: <span class="str">"plan"</span>, <span class="prop">sequenceIndex</span>: <span class="num">1</span> }, { <span class="prop">content</span>: <span class="str">"Step 2: done!"</span> });
<span class="cm">// First request → first response</span>
<span class="kw">const</span> <span class="op">res1</span> = <span class="kw">await</span> <span class="fn">fetch</span>(<span class="str">`${mock.url}/v1/chat/completions`</span>, {
<span class="prop">method</span>: <span class="str">"POST"</span>,
<span class="prop">headers</span>: { <span class="str">"Content-Type"</span>: <span class="str">"application/json"</span> },
<span class="prop">body</span>: <span class="type">JSON</span>.<span class="fn">stringify</span>({
<span class="prop">model</span>: <span class="str">"gpt-4"</span>,
<span class="prop">messages</span>: [{ <span class="prop">role</span>: <span class="str">"user"</span>, <span class="prop">content</span>: <span class="str">"plan"</span> }],
<span class="prop">stream</span>: <span class="kw">false</span>,
}),
});
<span class="kw">const</span> <span class="op">body1</span> = <span class="kw">await</span> <span class="op">res1</span>.<span class="fn">json</span>();
<span class="fn">expect</span>(<span class="op">body1</span>.<span class="prop">choices</span>[<span class="num">0</span>].<span class="prop">message</span>.<span class="prop">content</span>).<span class="fn">toBe</span>(<span class="str">"Step 1: planning..."</span>);
<span class="cm">// Second request → second response</span>
<span class="kw">const</span> <span class="op">res2</span> = <span class="kw">await</span> <span class="fn">fetch</span>(<span class="str">`${mock.url}/v1/chat/completions`</span>, {
<span class="prop">method</span>: <span class="str">"POST"</span>,
<span class="prop">headers</span>: { <span class="str">"Content-Type"</span>: <span class="str">"application/json"</span> },
<span class="prop">body</span>: <span class="type">JSON</span>.<span class="fn">stringify</span>({
<span class="prop">model</span>: <span class="str">"gpt-4"</span>,
<span class="prop">messages</span>: [{ <span class="prop">role</span>: <span class="str">"user"</span>, <span class="prop">content</span>: <span class="str">"plan"</span> }],
<span class="prop">stream</span>: <span class="kw">false</span>,
}),
});
<span class="kw">const</span> <span class="op">body2</span> = <span class="kw">await</span> <span class="op">res2</span>.<span class="fn">json</span>();
<span class="fn">expect</span>(<span class="op">body2</span>.<span class="prop">choices</span>[<span class="num">0</span>].<span class="prop">message</span>.<span class="prop">content</span>).<span class="fn">toBe</span>(<span class="str">"Step 2: done!"</span>);</code></pre>
</div>
<h2>Fallback After Sequence Exhaustion</h2>
<div class="code-block">
<div class="code-block-header">
sequence-fallback.test.ts <span class="lang-tag">ts</span>
</div>
<pre><code><span class="cm">// First call matches sequenceIndex 0, subsequent calls fall through to fallback</span>
<span class="op">mock</span>.<span class="fn">on</span>({ <span class="prop">userMessage</span>: <span class="str">"once"</span>, <span class="prop">sequenceIndex</span>: <span class="num">0</span> }, { <span class="prop">content</span>: <span class="str">"only-first-time"</span> });
<span class="op">mock</span>.<span class="fn">on</span>({ <span class="prop">userMessage</span>: <span class="str">"once"</span> }, { <span class="prop">content</span>: <span class="str">"fallback"</span> });
<span class="cm">// Request 1 → "only-first-time" (sequenceIndex 0 matches)</span>
<span class="cm">// Request 2 → "fallback" (sequenceIndex 0 won't match, falls through)</span></code></pre>
</div>
<h2>JSON Fixture</h2>
<div class="code-block">
<div class="code-block-header">
fixtures/sequence.json <span class="lang-tag">json</span>
</div>
<pre><code>{
<span class="key">"fixtures"</span>: [
{
<span class="key">"match"</span>: { <span class="key">"userMessage"</span>: <span class="str">"plan"</span>, <span class="key">"sequenceIndex"</span>: <span class="num">0</span> },
<span class="key">"response"</span>: { <span class="key">"content"</span>: <span class="str">"Step 1: planning..."</span> }
},
{
<span class="key">"match"</span>: { <span class="key">"userMessage"</span>: <span class="str">"plan"</span>, <span class="key">"sequenceIndex"</span>: <span class="num">1</span> },
<span class="key">"response"</span>: { <span class="key">"content"</span>: <span class="str">"Step 2: done!"</span> }
}
]
}</code></pre>
</div>
<div class="info-box">
<p>
Sequence counters are per-fixture-match, not global. If you have fixtures matching
"alpha" and "beta", their counters are tracked independently.
</p>
</div>
<div class="info-box">
<p>
<strong>Need stateless matching?</strong> <code>sequenceIndex</code> uses a server-side
counter that resets on <code>mock.reset()</code> and can drift when multiple clients
share an instance. If your use case is “different response based on conversation
depth” (not “different response for the Nth identical request”),
prefer the stateless <code>turnIndex</code> or <code>hasToolResult</code> fields
instead. See <a href="/multi-turn">Multi-Turn Conversations</a>.
</p>
</div>
</main>
<aside class="page-toc" id="page-toc"></aside>
</div>
<footer class="docs-footer">
<div class="footer-inner">
<div class="footer-left"><span>$</span> aimock · MIT License</div>
<ul class="footer-links">
<li><a href="https://github.com/CopilotKit/aimock" target="_blank">GitHub</a></li>
<li>
<a href="https://www.npmjs.com/package/@copilotkit/aimock" target="_blank">npm</a>
</li>
</ul>
</div>
</footer>
<script src="../sidebar.js"></script>
<script src="../cli-tabs.js"></script>
</body>
</html>