-
Notifications
You must be signed in to change notification settings - Fork 46
Expand file tree
/
Copy pathindex.html
More file actions
190 lines (173 loc) · 10.3 KB
/
Copy pathindex.html
File metadata and controls
190 lines (173 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
182
183
184
185
186
187
188
189
190
<!doctype html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Responses API — 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>OpenAI Responses API</h1>
<p class="lead">
The Responses API uses <code>event:</code> + <code>data:</code> SSE format over HTTP, and
is also available over WebSocket. aimock supports both transports with the same fixtures.
</p>
<h2>Endpoints</h2>
<table class="endpoint-table">
<thead>
<tr>
<th>Method</th>
<th>Path</th>
<th>Format</th>
</tr>
</thead>
<tbody>
<tr>
<td>POST</td>
<td>/v1/responses</td>
<td>HTTP SSE (event: + data:)</td>
</tr>
<tr>
<td>WS</td>
<td>/v1/responses</td>
<td>WebSocket JSON messages</td>
</tr>
</tbody>
</table>
<h2>Unit Test: HTTP SSE Text Response</h2>
<div class="code-block">
<div class="code-block-header">
responses-text.test.ts <span class="lang-tag">ts</span>
</div>
<pre><code><span class="kw">import</span> { <span class="fn">createServer</span>, <span class="kw">type</span> <span class="type">ServerInstance</span> } <span class="kw">from</span> <span class="str">"@copilotkit/aimock/server"</span>;
<span class="kw">const</span> <span class="op">instance</span> = <span class="kw">await</span> <span class="fn">createServer</span>([
{ <span class="prop">match</span>: { <span class="prop">userMessage</span>: <span class="str">"hello"</span> }, <span class="prop">response</span>: { <span class="prop">content</span>: <span class="str">"Hi there!"</span> } }
]);
<span class="kw">const</span> <span class="op">res</span> = <span class="kw">await</span> <span class="fn">post</span>(<span class="str">`${instance.url}/v1/responses`</span>, {
<span class="prop">model</span>: <span class="str">"gpt-4o"</span>,
<span class="prop">input</span>: [{ <span class="prop">role</span>: <span class="str">"user"</span>, <span class="prop">content</span>: <span class="str">"hello"</span> }],
});
<span class="cm">// Parse event: + data: SSE format</span>
<span class="kw">const</span> <span class="op">events</span> = <span class="op">res</span>.<span class="prop">body</span>.<span class="fn">split</span>(<span class="str">"\n\n"</span>)
.<span class="fn">filter</span>(<span class="op">b</span> <span class="kw">=></span> <span class="op">b</span>.<span class="fn">includes</span>(<span class="str">"event: "</span>) && <span class="op">b</span>.<span class="fn">includes</span>(<span class="str">"data: "</span>))
.<span class="fn">map</span>(<span class="op">b</span> <span class="kw">=></span> ({
<span class="prop">type</span>: <span class="op">b</span>.<span class="fn">match</span>(<span class="str">/^event: (.+)$/m</span>)[<span class="num">1</span>],
<span class="prop">data</span>: <span class="type">JSON</span>.<span class="fn">parse</span>(<span class="op">b</span>.<span class="fn">match</span>(<span class="str">/^data: (.+)$/m</span>)[<span class="num">1</span>]),
}));
<span class="kw">const</span> <span class="op">types</span> = <span class="op">events</span>.<span class="fn">map</span>(<span class="op">e</span> <span class="kw">=></span> <span class="op">e</span>.<span class="prop">type</span>);
<span class="fn">expect</span>(<span class="op">types</span>).<span class="fn">toContain</span>(<span class="str">"response.created"</span>);
<span class="fn">expect</span>(<span class="op">types</span>).<span class="fn">toContain</span>(<span class="str">"response.output_text.delta"</span>);
<span class="fn">expect</span>(<span class="op">types</span>).<span class="fn">toContain</span>(<span class="str">"response.completed"</span>);</code></pre>
</div>
<h2>Unit Test: Tool Call Response</h2>
<div class="code-block">
<div class="code-block-header">
responses-tools.test.ts <span class="lang-tag">ts</span>
</div>
<pre><code><span class="kw">const</span> <span class="op">instance</span> = <span class="kw">await</span> <span class="fn">createServer</span>([
{
<span class="prop">match</span>: { <span class="prop">userMessage</span>: <span class="str">"weather"</span> },
<span class="prop">response</span>: {
<span class="prop">toolCalls</span>: [{ <span class="prop">name</span>: <span class="str">"get_weather"</span>, <span class="prop">arguments</span>: { <span class="prop">city</span>: <span class="str">"NYC"</span> } }]
}
}
]);
<span class="kw">const</span> <span class="op">res</span> = <span class="kw">await</span> <span class="fn">post</span>(<span class="str">`${instance.url}/v1/responses`</span>, {
<span class="prop">model</span>: <span class="str">"gpt-4o"</span>,
<span class="prop">input</span>: [{ <span class="prop">role</span>: <span class="str">"user"</span>, <span class="prop">content</span>: <span class="str">"what is the weather?"</span> }],
});
<span class="kw">const</span> <span class="op">events</span> = <span class="fn">parseTypedSSE</span>(<span class="op">res</span>.<span class="prop">body</span>);
<span class="kw">const</span> <span class="op">types</span> = <span class="op">events</span>.<span class="fn">map</span>(<span class="op">e</span> <span class="kw">=></span> <span class="op">e</span>.<span class="prop">type</span>);
<span class="fn">expect</span>(<span class="op">types</span>).<span class="fn">toContain</span>(<span class="str">"response.function_call_arguments.delta"</span>);
<span class="fn">expect</span>(<span class="op">types</span>).<span class="fn">toContain</span>(<span class="str">"response.output_item.done"</span>);</code></pre>
</div>
<h2>SSE Event Sequence</h2>
<p>The Responses API uses typed events. A text response produces this sequence:</p>
<ol>
<li><code>response.created</code></li>
<li><code>response.in_progress</code></li>
<li><code>response.output_item.added</code></li>
<li><code>response.content_part.added</code></li>
<li><code>response.output_text.delta</code> (one per chunk)</li>
<li><code>response.output_text.done</code></li>
<li><code>response.content_part.done</code></li>
<li><code>response.output_item.done</code></li>
<li><code>response.completed</code></li>
</ol>
<p>
Tool call responses follow the same pattern but use
<code>response.function_call_arguments.delta</code> and
<code>response.function_call_arguments.done</code> events.
</p>
<div class="info-box">
<p>
The same fixtures work for both HTTP SSE and WebSocket transports. See the
<a href="/websocket">WebSocket APIs</a> page for WebSocket-specific details.
</p>
</div>
<h2>Ordered blocks (tool-first)</h2>
<p>
A combined <code>content</code> + <code>toolCalls</code> fixture accepts an optional
<code>blocks</code> array to control stream order — see
<a href="/fixtures#ordered-blocks">Ordered blocks</a>. The Responses API has
<strong>full</strong> support: <code>output</code> items (message vs
<code>function_call</code>) are assigned <code>output_index</code> in array order, so a
tool call can precede the message and SDKs honor the ordering.
</p>
</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>