forked from openai/chatkit-python
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathtest_chatkit_server.py
More file actions
2227 lines (1962 loc) · 78 KB
/
Copy pathtest_chatkit_server.py
File metadata and controls
2227 lines (1962 loc) · 78 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
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
import asyncio
import base64
import sqlite3
from contextlib import contextmanager
from datetime import datetime
from typing import Any, AsyncIterator, Callable, cast
import pytest
from helpers.mock_store import SQLiteStore
from pydantic import AnyUrl, TypeAdapter
from chatkit.actions import Action
from chatkit.errors import ErrorCode
from chatkit.server import (
ChatKitServer,
NonStreamingResult,
StreamingResult,
stream_widget,
)
from chatkit.store import (
AttachmentStore,
NotFoundError,
StoreItemType,
default_generate_id,
)
from chatkit.types import (
AssistantMessageContent,
AssistantMessageContentPartTextDelta,
AssistantMessageItem,
Attachment,
AttachmentCreateParams,
AttachmentDeleteParams,
AttachmentsCreateReq,
AttachmentsDeleteReq,
AttachmentUploadDescriptor,
AudioInput,
ClientToolCallItem,
CustomTask,
FeedbackKind,
FileAttachment,
ImageAttachment,
InferenceOptions,
InputTranscribeParams,
InputTranscribeReq,
ItemFeedbackParams,
ItemsFeedbackReq,
ItemsListParams,
ItemsListReq,
LockedStatus,
Page,
ProgressUpdateEvent,
SyncCustomActionResponse,
Thread,
ThreadAddClientToolOutputParams,
ThreadAddUserMessageParams,
ThreadCreatedEvent,
ThreadCreateParams,
ThreadCustomActionParams,
ThreadDeleteParams,
ThreadGetByIdParams,
ThreadItem,
ThreadItemAddedEvent,
ThreadItemDoneEvent,
ThreadItemRemovedEvent,
ThreadItemReplacedEvent,
ThreadItemUpdatedEvent,
ThreadListParams,
ThreadMetadata,
ThreadRetryAfterItemParams,
ThreadsAddClientToolOutputReq,
ThreadsAddUserMessageReq,
ThreadsCreateReq,
ThreadsCustomActionReq,
ThreadsDeleteReq,
ThreadsGetByIdReq,
ThreadsListReq,
ThreadsRetryAfterItemReq,
ThreadsSyncCustomActionReq,
ThreadStreamEvent,
ThreadsUpdateReq,
ThreadUpdatedEvent,
ThreadUpdateParams,
ToolChoice,
TranscriptionResult,
UserMessageInput,
UserMessageItem,
UserMessageTextContent,
WidgetItem,
WidgetRootUpdated,
Workflow,
WorkflowItem,
WorkflowTaskAdded,
)
from chatkit.widgets import Card, Text
from tests._types import RequestContext
from tests.test_store import make_thread_items
server_id = 0
DEFAULT_CONTEXT = RequestContext(user_id="test_user")
class InMemoryFileStore(AttachmentStore):
def __init__(self):
self.files = {}
async def delete_attachment(self, attachment_id: str, context: Any) -> None:
del self.files[attachment_id]
async def create_attachment(
self, input: AttachmentCreateParams, context: RequestContext
) -> Attachment:
# Simple in-memory attachment creation
id = f"atc_{len(self.files) + 1}"
metadata = {"source": "test"}
if input.mime_type.startswith("image/"):
attachment = ImageAttachment(
id=id,
mime_type=input.mime_type,
name=input.name,
preview_url=AnyUrl(f"https://example.com/{id}/preview"),
upload_descriptor=AttachmentUploadDescriptor(
url=AnyUrl(f"https://example.com/{id}/upload"),
method="PUT",
headers={"X-My-Header": "my-value"},
),
metadata=metadata,
)
else:
attachment = FileAttachment(
id=id,
mime_type=input.mime_type,
name=input.name,
upload_descriptor=AttachmentUploadDescriptor(
url=AnyUrl(f"https://example.com/{id}/upload"),
method="PUT",
headers={"X-My-Header": "my-value"},
),
metadata=metadata,
)
self.files[attachment.id] = attachment
return attachment
def decode_event(event: bytes) -> ThreadStreamEvent:
return TypeAdapter(ThreadStreamEvent).validate_json(event.split(b"data: ")[1])
async def decode_streaming_result(
streaming_result: StreamingResult,
) -> list[ThreadStreamEvent]:
return [decode_event(event) async for event in streaming_result.json_events]
@contextmanager
def make_server(
responder: Callable[
[ThreadMetadata, UserMessageItem | None, Any], AsyncIterator[ThreadStreamEvent]
]
| None = None,
handle_feedback: Callable[[str, list[str], FeedbackKind, Any], None] | None = None,
action_callback: Callable[
[ThreadMetadata, Action[str, Any], WidgetItem | None, Any],
AsyncIterator[ThreadStreamEvent],
]
| None = None,
sync_action_callback: Callable[
[ThreadMetadata, Action[str, Any], WidgetItem | None, Any],
SyncCustomActionResponse,
]
| None = None,
file_store: AttachmentStore | None = None,
transcribe_callback: Callable[[AudioInput, Any], TranscriptionResult] | None = None,
):
global server_id
db_path = f"file:{server_id}?mode=memory&cache=shared"
server_id += 1
# Keep the shared in-memory database from being deleted when the last connection is closed
db = sqlite3.connect(db_path, uri=True)
class TestChatKitServer(ChatKitServer):
def __init__(self):
super().__init__(SQLiteStore(db_path), file_store)
def action(
self,
thread: ThreadMetadata,
action: Action[str, Any],
sender: WidgetItem | None,
context: Any,
) -> AsyncIterator[ThreadStreamEvent]:
if action_callback is None:
raise ValueError("action_callback not wired up")
return action_callback(thread, action, sender, context)
async def sync_action(
self,
thread: ThreadMetadata,
action: Action[str, Any],
sender: WidgetItem | None,
context: Any,
) -> SyncCustomActionResponse:
if sync_action_callback is None:
raise ValueError("sync_action_callback not wired up")
return sync_action_callback(thread, action, sender, context)
def respond(
self,
thread: ThreadMetadata,
input_user_message: UserMessageItem | None,
context: Any,
) -> AsyncIterator[ThreadStreamEvent]:
if responder is None:
return self._empty_responder()
return responder(thread, input_user_message, context)
async def _empty_responder(self) -> AsyncIterator[ThreadStreamEvent]:
return
yield
async def add_feedback(
self,
thread_id: str,
item_ids: list[str],
feedback: FeedbackKind,
context: Any,
) -> None:
if handle_feedback is None:
return
handle_feedback(thread_id, item_ids, feedback, context)
async def transcribe(
self, audio_input: AudioInput, context: Any
) -> TranscriptionResult:
if transcribe_callback is None:
return await super().transcribe(audio_input, context)
return transcribe_callback(audio_input, context)
async def process_streaming(
self, request_obj, context: Any | None = None
) -> list[ThreadStreamEvent]:
result = await self.process(
request_obj.model_dump_json(), context or DEFAULT_CONTEXT
)
assert isinstance(result, StreamingResult)
return await decode_streaming_result(result)
async def process_non_streaming(self, request_obj, context: Any | None = None):
result = await self.process(
request_obj.model_dump_json(), context or DEFAULT_CONTEXT
)
assert isinstance(result, NonStreamingResult)
return result
try:
yield TestChatKitServer()
finally:
db.close()
async def test_stream_cancellation_persists_pending_assistant_message_and_hidden_context():
async def responder(
thread: ThreadMetadata, input: UserMessageItem | None, context: Any
) -> AsyncIterator[ThreadStreamEvent]:
yield ThreadItemAddedEvent(
item=AssistantMessageItem(
id="assistant-message-pending",
created_at=datetime.now(),
content=[AssistantMessageContent(text="Hello, ")],
thread_id=thread.id,
)
)
yield ThreadItemUpdatedEvent(
item_id="assistant-message-pending",
update=AssistantMessageContentPartTextDelta(
content_index=0,
delta="World!",
),
)
raise asyncio.CancelledError()
with make_server(responder) as server:
# Allow hidden_context id generation in this test store
original_generate_item_id = server.store.generate_item_id
def generate_item_id(
item_type: StoreItemType, thread: ThreadMetadata, context: Any
):
if item_type == "sdk_hidden_context":
return default_generate_id("sdk_hidden_context")
return original_generate_item_id(item_type, thread, context)
server.store.generate_item_id = generate_item_id # type: ignore[method-assign]
stream = await server.process(
ThreadsCreateReq(
params=ThreadCreateParams(
input=UserMessageInput(
content=[UserMessageTextContent(text="Hello")],
attachments=[],
inference_options=InferenceOptions(),
)
)
).model_dump_json(),
DEFAULT_CONTEXT,
)
assert isinstance(stream, StreamingResult)
events: list[ThreadStreamEvent] = []
with pytest.raises(asyncio.CancelledError): # noqa: PT012
async for raw in stream.json_events:
events.append(decode_event(raw))
thread = next(e.thread for e in events if e.type == "thread.created")
items = await server.store.load_thread_items(
thread.id, None, 1, "desc", DEFAULT_CONTEXT
)
hidden_context_item = items.data[-1]
assert hidden_context_item.type == "sdk_hidden_context"
assert (
hidden_context_item.content
== "The user cancelled the stream. Stop responding to the prior request."
)
assistant_message_item = await server.store.load_item(
thread.id, "assistant-message-pending", DEFAULT_CONTEXT
)
assert assistant_message_item.type == "assistant_message"
assert assistant_message_item.content[0].text == "Hello, World!"
async def test_stream_cancellation_does_not_persist_pending_empty_assistant_message():
async def responder(
thread: ThreadMetadata, input: UserMessageItem | None, context: Any
) -> AsyncIterator[ThreadStreamEvent]:
yield ThreadItemAddedEvent(
item=AssistantMessageItem(
id="assistant-message-pending",
created_at=datetime.now(),
content=[],
thread_id=thread.id,
)
)
raise asyncio.CancelledError()
with make_server(responder) as server:
original_generate_item_id = server.store.generate_item_id
def generate_item_id(
item_type: StoreItemType, thread: ThreadMetadata, context: Any
):
if item_type == "sdk_hidden_context":
return default_generate_id("sdk_hidden_context")
return original_generate_item_id(item_type, thread, context)
server.store.generate_item_id = generate_item_id # type: ignore[method-assign]
stream = await server.process(
ThreadsCreateReq(
params=ThreadCreateParams(
input=UserMessageInput(
content=[UserMessageTextContent(text="Hello")],
attachments=[],
inference_options=InferenceOptions(),
)
)
).model_dump_json(),
DEFAULT_CONTEXT,
)
assert isinstance(stream, StreamingResult)
events: list[ThreadStreamEvent] = []
with pytest.raises(asyncio.CancelledError): # noqa: PT012
async for raw in stream.json_events:
events.append(decode_event(raw))
thread = next(e.thread for e in events if e.type == "thread.created")
items = await server.store.load_thread_items(
thread.id, None, 1, "desc", DEFAULT_CONTEXT
)
hidden_context_item = items.data[-1]
assert hidden_context_item.type == "sdk_hidden_context"
assert (
hidden_context_item.content
== "The user cancelled the stream. Stop responding to the prior request."
)
with pytest.raises(NotFoundError):
await server.store.load_item(
thread.id, "assistant-message-pending", DEFAULT_CONTEXT
)
async def test_workflow_task_not_duplicated_on_done_event():
"""
Regression test to make sure pending item updates do not modify the
origin item that was streamed.
"""
async def responder(
thread: ThreadMetadata, input: UserMessageItem | None, context: Any
) -> AsyncIterator[ThreadStreamEvent]:
workflow_item = WorkflowItem(
id="workflow-item",
created_at=datetime.now(),
thread_id=thread.id,
workflow=Workflow(type="custom", tasks=[]),
)
yield ThreadItemAddedEvent(item=workflow_item)
task = CustomTask(title="foo", content="bar")
yield ThreadItemUpdatedEvent(
item_id=workflow_item.id,
update=WorkflowTaskAdded(task=task, task_index=0),
)
workflow_item.workflow.tasks.append(task)
yield ThreadItemDoneEvent(item=workflow_item)
with make_server(responder) as server:
events = await server.process_streaming(
ThreadsCreateReq(
params=ThreadCreateParams(
input=UserMessageInput(
content=[UserMessageTextContent(text="Hello")],
attachments=[],
inference_options=InferenceOptions(),
)
)
)
)
thread = next(e.thread for e in events if e.type == "thread.created")
workflow_done_event = next(
e
for e in events
if isinstance(e, ThreadItemDoneEvent) and isinstance(e.item, WorkflowItem)
)
workflow_done_item = cast(WorkflowItem, workflow_done_event.item)
assert len(workflow_done_item.workflow.tasks) == 1
assert workflow_done_item.workflow.tasks[0].title == "foo"
stored = await server.store.load_item(
thread.id, workflow_done_item.id, DEFAULT_CONTEXT
)
assert isinstance(stored, WorkflowItem)
stored_workflow = cast(WorkflowItem, stored)
assert len(stored_workflow.workflow.tasks) == 1
assert stored_workflow.workflow.tasks[0].title == "foo"
async def test_flows_context_to_responder():
responder_context = None
add_feedback_context = None
async def responder(
thread: ThreadMetadata, input: UserMessageItem | None, context: Any
) -> AsyncIterator[ThreadStreamEvent]:
nonlocal responder_context
responder_context = context
yield ThreadItemDoneEvent(
item=AssistantMessageItem(
id="msg_1",
created_at=datetime.now(),
content=[AssistantMessageContent(text="Hello, world!")],
thread_id=thread.id,
),
)
def add_feedback(
thread_id: str, item_ids: list[str], feedback: FeedbackKind, context: Any
) -> None:
nonlocal add_feedback_context
add_feedback_context = context
context = RequestContext(user_id="text_ctx")
with make_server(responder, add_feedback) as server:
events = await server.process_streaming(
ThreadsCreateReq(
params=ThreadCreateParams(
input=UserMessageInput(
content=[UserMessageTextContent(text="Hello, world!")],
attachments=[],
inference_options=InferenceOptions(),
)
)
),
context,
)
assert responder_context == context
thread = next(
event.thread for event in events if event.type == "thread.created"
)
item = next(
event.item
for event in events
if event.type == "thread.item.done"
and event.item.type == "assistant_message"
)
await server.process_non_streaming(
ItemsFeedbackReq(
params=ItemFeedbackParams(
thread_id=thread.id,
item_ids=[item.id],
kind="positive",
)
),
context,
)
assert add_feedback_context == context
async def test_creates_thread():
async def responder(
thread: ThreadMetadata, input: UserMessageItem | None, context: Any
) -> AsyncIterator[ThreadStreamEvent]:
return
yield
with make_server(responder) as server:
events = await server.process_streaming(
ThreadsCreateReq(
params=ThreadCreateParams(
input=UserMessageInput(
content=[UserMessageTextContent(text="Hello, world!")],
attachments=[],
inference_options=InferenceOptions(),
quoted_text="Quoted text",
)
)
)
)
thread_created_event = next(
event for event in events if event.type == "thread.created"
)
assert thread_created_event.thread.title is None
item_done_event = next(
event.item for event in events if event.type == "thread.item.done"
)
assert item_done_event.type == "user_message"
assert item_done_event.content[0].text == "Hello, world!"
assert item_done_event.quoted_text == "Quoted text"
async def test_saves_thread_title():
async def responder(
thread: ThreadMetadata, input: UserMessageItem | None, context: Any
) -> AsyncIterator[ThreadStreamEvent]:
thread.title = "Updated title"
return
yield
with make_server(responder) as server:
events = await server.process_streaming(
ThreadsCreateReq(
params=ThreadCreateParams(
input=UserMessageInput(
content=[UserMessageTextContent(text="Hello, world!")],
attachments=[],
inference_options=InferenceOptions(),
)
)
)
)
thread = next(
event.thread for event in events if event.type == "thread.created"
)
assert (
await server.store.load_thread(
thread.id, RequestContext(user_id="test_user")
)
).title == "Updated title"
assert events[-1].type == "thread.updated"
assert events[-1].thread.title == "Updated title"
async def test_saves_thread_metadata():
async def responder(
thread: ThreadMetadata, input: UserMessageItem | None, context: Any
) -> AsyncIterator[ThreadStreamEvent]:
thread.metadata["test_key"] = "test_value"
return
yield
with make_server(responder) as server:
events = await server.process_streaming(
ThreadsCreateReq(
params=ThreadCreateParams(
input=UserMessageInput(
content=[UserMessageTextContent(text="Hello, world!")],
attachments=[],
inference_options=InferenceOptions(),
)
)
)
)
thread = next(
event.thread for event in events if event.type == "thread.created"
)
assert (await server.store.load_thread(thread.id, DEFAULT_CONTEXT)).metadata[
"test_key"
] == "test_value"
assert events[-1].type == "thread.updated"
async def test_saves_thread_locked_fields():
async def responder(
thread: ThreadMetadata, input: UserMessageItem | None, context: Any
) -> AsyncIterator[ThreadStreamEvent]:
thread.status = LockedStatus(reason="Because")
return
yield
with make_server(responder) as server:
events = await server.process_streaming(
ThreadsCreateReq(
params=ThreadCreateParams(
input=UserMessageInput(
content=[UserMessageTextContent(text="Hello, world!")],
attachments=[],
inference_options=InferenceOptions(),
)
)
)
)
thread = next(
event.thread for event in events if event.type == "thread.created"
)
loaded = await server.store.load_thread(
thread.id, RequestContext(user_id="test_user")
)
assert loaded.status == LockedStatus(reason="Because")
assert events[-1].type == "thread.updated"
assert events[-1].thread.status == LockedStatus(reason="Because")
async def test_emits_thread_updated_mid_stream_and_persists():
async def responder(
thread: ThreadMetadata, input: UserMessageItem | None, context: Any
) -> AsyncIterator[ThreadStreamEvent]:
# First assistant message
yield ThreadItemDoneEvent(
item=AssistantMessageItem(
id="assistant_a",
content=[AssistantMessageContent(text="A")],
created_at=datetime.now(),
thread_id=thread.id,
),
)
# Update the thread mid-stream
thread.title = "Mid-stream title"
# Second assistant message, after which thread.updated should be emitted
yield ThreadItemDoneEvent(
item=AssistantMessageItem(
id="assistant_b",
content=[AssistantMessageContent(text="B")],
created_at=datetime.now(),
thread_id=thread.id,
),
)
# Continue streaming after the update event
yield ThreadItemDoneEvent(
item=AssistantMessageItem(
id="assistant_c",
content=[AssistantMessageContent(text="C")],
created_at=datetime.now(),
thread_id=thread.id,
),
)
with make_server(responder) as server:
events = await server.process_streaming(
ThreadsCreateReq(
params=ThreadCreateParams(
input=UserMessageInput(
content=[UserMessageTextContent(text="Hello")],
attachments=[],
inference_options=InferenceOptions(),
)
)
)
)
# Find the created thread
thread = next(e.thread for e in events if isinstance(e, ThreadCreatedEvent))
# Ensure a thread.updated event occurs right after assistant_b
idx_b = next(
i
for i, e in enumerate(events)
if isinstance(e, ThreadItemDoneEvent)
and isinstance(e.item, AssistantMessageItem)
and e.item.id == "assistant_b"
)
assert isinstance(events[idx_b + 1], ThreadUpdatedEvent)
updated_event = cast(ThreadUpdatedEvent, events[idx_b + 1])
assert updated_event.thread.title == "Mid-stream title"
# Streaming continues after the update event
assert isinstance(events[idx_b + 2], ThreadItemDoneEvent)
done_event = cast(ThreadItemDoneEvent, events[idx_b + 2])
assert isinstance(done_event.item, AssistantMessageItem)
assert done_event.item.id == "assistant_c"
# Persisted in the store
saved = await server.store.load_thread(thread.id, DEFAULT_CONTEXT)
assert saved.title == "Mid-stream title"
async def test_respond_with_tool_call():
async def responder(
thread: ThreadMetadata, input: UserMessageItem | None, context: Any
) -> AsyncIterator[ThreadStreamEvent]:
if isinstance(input, UserMessageItem):
yield ThreadItemDoneEvent(
item=ClientToolCallItem(
id="msg_1",
created_at=datetime.now(),
name="tool_call_1",
arguments={"arg1": "val1", "arg2": False},
call_id="tool_call_1",
thread_id=thread.id,
),
)
elif input is None:
yield ThreadItemDoneEvent(
item=AssistantMessageItem(
id="msg_2",
content=[
AssistantMessageContent(text="Glad the tool call succeeded!")
],
created_at=datetime.now(),
thread_id=thread.id,
),
)
with make_server(responder) as server:
events = await server.process_streaming(
ThreadsCreateReq(
params=ThreadCreateParams(
input=UserMessageInput(
content=[UserMessageTextContent(text="Hello, world!")],
attachments=[],
inference_options=InferenceOptions(),
)
)
)
)
assert len(events) == 4
assert events[0].type == "thread.created"
thread = events[0].thread
assert events[1].type == "thread.item.done"
assert events[1].item.type == "user_message"
assert events[2].type == "stream_options"
assert events[3].type == "thread.item.done"
assert events[3].item.type == "client_tool_call"
assert events[3].item.id == "msg_1"
assert events[3].item.name == "tool_call_1"
assert events[3].item.arguments == {"arg1": "val1", "arg2": False}
assert events[3].item.call_id == "tool_call_1"
events = await server.process_streaming(
ThreadsAddClientToolOutputReq(
params=ThreadAddClientToolOutputParams(
thread_id=thread.id,
result={"text": "Wow!"},
)
)
)
assert len(events) == 2
assert events[0].type == "stream_options"
assert events[1].type == "thread.item.done"
assert events[1].item.type == "assistant_message"
async def test_respond_with_tool_status():
async def responder(
thread: ThreadMetadata, input: UserMessageItem | None, context: Any
) -> AsyncIterator[ThreadStreamEvent]:
yield ProgressUpdateEvent(text="Tool status")
yield ThreadItemDoneEvent(
item=AssistantMessageItem(
id="msg_4",
content=[AssistantMessageContent(text="Hello, world!")],
created_at=datetime.now(),
thread_id=thread.id,
),
)
with make_server(responder) as server:
events = await server.process_streaming(
ThreadsCreateReq(
params=ThreadCreateParams(
input=UserMessageInput(
content=[UserMessageTextContent(text="Hello, world!")],
attachments=[],
inference_options=InferenceOptions(),
)
)
)
)
assert len(events) == 5
assert events[0].type == "thread.created"
assert events[1].type == "thread.item.done"
assert events[2].type == "stream_options"
assert events[3].type == "progress_update"
assert events[4].type == "thread.item.done"
async def test_list_threads_response():
with make_server() as server:
for i in range(25):
await server.process_streaming(
ThreadsCreateReq(
params=ThreadCreateParams(
input=UserMessageInput(
content=[UserMessageTextContent(text=f"Thread {i}")],
attachments=[],
inference_options=InferenceOptions(),
)
)
)
)
list_result = await server.process_non_streaming(
ThreadsListReq(params=ThreadListParams(limit=20))
)
threads = TypeAdapter(Page[ThreadMetadata]).validate_json(list_result.json)
assert len(threads.data) == 20
# Newest first
assert threads.data[0].created_at > threads.data[1].created_at
assert threads.has_more is True
assert threads.after is not None
more_threads = await server.process_non_streaming(
ThreadsListReq(params=ThreadListParams(after=threads.data[-1].id))
)
threads = TypeAdapter(Page[ThreadMetadata]).validate_json(more_threads.json)
assert len(threads.data) == 5
assert threads.has_more is False
assert not threads.after
async def test_list_items_response():
async def responder(
thread: ThreadMetadata, input: UserMessageItem | None, context: Any
) -> AsyncIterator[ThreadStreamEvent]:
for i in range(25):
yield ThreadItemDoneEvent(
item=UserMessageItem(
id=f"msg_{i}",
content=[UserMessageTextContent(text=f"Message {i}")],
attachments=[],
inference_options=InferenceOptions(),
thread_id=thread.id,
created_at=datetime.now(),
),
)
with make_server(responder) as server:
events = await server.process_streaming(
ThreadsCreateReq(
params=ThreadCreateParams(
input=UserMessageInput(
content=[UserMessageTextContent(text="Thread 1")],
attachments=[],
inference_options=InferenceOptions(),
)
)
)
)
thread = next(
event.thread for event in events if event.type == "thread.created"
)
list_result = await server.process_non_streaming(
ItemsListReq(params=ItemsListParams(thread_id=thread.id))
)
items = TypeAdapter(Page[ThreadItem]).validate_json(list_result.json)
assert len(items.data) == 20
# Newest first
assert items.data[0].created_at > items.data[1].created_at
assert items.has_more is True
assert items.after is not None
list_result = await server.process_non_streaming(
ItemsListReq(
params=ItemsListParams(thread_id=thread.id, after=items.data[-1].id)
)
)
items = TypeAdapter(Page[ThreadItem]).validate_json(list_result.json)
assert len(items.data) == 6 # +1 for user message
assert items.has_more is False
async def test_calls_action():
actions = []
async def responder(
thread: ThreadMetadata,
input: UserMessageItem | None,
context: Any,
) -> AsyncIterator[ThreadStreamEvent]:
yield ThreadItemDoneEvent(
item=WidgetItem(
id="widget_1",
type="widget",
created_at=datetime.now(),
thread_id=thread.id,
widget=Card(
children=[
Text(
key="text_1",
value="test",
)
],
),
),
)
async def action(
thread: ThreadMetadata,
action: Action[str, Any],
sender: WidgetItem | None,
context: Any,
) -> AsyncIterator[ThreadStreamEvent]:
actions.append((action, sender))
assert sender
yield ThreadItemUpdatedEvent(
item_id=sender.id,
update=WidgetRootUpdated(
widget=Card(
children=[
Text(value="Email sent!"),
]
),
),
)
with make_server(responder, action_callback=action) as server:
events = await server.process_streaming(
ThreadsCreateReq(
params=ThreadCreateParams(
input=UserMessageInput(
content=[UserMessageTextContent(text="Show widget")],
attachments=[],
inference_options=InferenceOptions(),
)
)
)
)
thread = next(
event.thread for event in events if event.type == "thread.created"
)
widget_item = next(
event.item
for event in events
if isinstance(event, ThreadItemDoneEvent)
and isinstance(event.item, WidgetItem)
)
events = await server.process_streaming(
ThreadsCustomActionReq(
params=ThreadCustomActionParams(
thread_id=thread.id,
item_id=widget_item.id,
action=Action(type="create_user", payload={"user_id": "123"}),
)
)
)
assert actions
assert actions[0] == (
Action(type="create_user", payload={"user_id": "123"}),
widget_item,
)
assert len(events) == 2
assert events[0].type == "stream_options"
assert events[1].type == "thread.item.updated"
assert isinstance(events[1], ThreadItemUpdatedEvent)
assert events[1].update.type == "widget.root.updated"
assert events[1].update.widget == Card(children=[Text(value="Email sent!")])
async def test_calls_action_sync():