-
Notifications
You must be signed in to change notification settings - Fork 857
Expand file tree
/
Copy pathFunctionInvokingChatClientTests.cs
More file actions
3164 lines (2690 loc) · 128 KB
/
FunctionInvokingChatClientTests.cs
File metadata and controls
3164 lines (2690 loc) · 128 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
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
using System;
using System.Collections.Generic;
using System.Diagnostics;
using System.Linq;
using System.Text.Json;
using System.Threading;
using System.Threading.Tasks;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Logging;
using Microsoft.Extensions.Logging.Testing;
using OpenTelemetry.Trace;
using Xunit;
#pragma warning disable SA1118 // Parameter should not span multiple lines
#pragma warning disable SA1204 // Static elements should appear before instance elements
namespace Microsoft.Extensions.AI;
public class FunctionInvokingChatClientTests
{
[Fact]
public void InvalidArgs_Throws()
{
Assert.Throws<ArgumentNullException>("innerClient", () => new FunctionInvokingChatClient(null!));
Assert.Throws<ArgumentNullException>("builder", () => ((ChatClientBuilder)null!).UseFunctionInvocation());
}
[Fact]
public void Ctor_HasExpectedDefaults()
{
using TestChatClient innerClient = new();
using FunctionInvokingChatClient client = new(innerClient);
Assert.False(client.AllowConcurrentInvocation);
Assert.False(client.IncludeDetailedErrors);
Assert.Equal(40, client.MaximumIterationsPerRequest);
Assert.Equal(3, client.MaximumConsecutiveErrorsPerRequest);
Assert.Null(client.FunctionInvoker);
Assert.Null(client.AdditionalTools);
}
[Fact]
public void Properties_Roundtrip()
{
using TestChatClient innerClient = new();
using FunctionInvokingChatClient client = new(innerClient);
Assert.False(client.AllowConcurrentInvocation);
client.AllowConcurrentInvocation = true;
Assert.True(client.AllowConcurrentInvocation);
Assert.False(client.IncludeDetailedErrors);
client.IncludeDetailedErrors = true;
Assert.True(client.IncludeDetailedErrors);
Assert.Equal(40, client.MaximumIterationsPerRequest);
client.MaximumIterationsPerRequest = 5;
Assert.Equal(5, client.MaximumIterationsPerRequest);
Assert.Equal(3, client.MaximumConsecutiveErrorsPerRequest);
client.MaximumConsecutiveErrorsPerRequest = 1;
Assert.Equal(1, client.MaximumConsecutiveErrorsPerRequest);
Assert.Null(client.FunctionInvoker);
Func<FunctionInvocationContext, CancellationToken, ValueTask<object?>> invoker = (ctx, ct) => new ValueTask<object?>("test");
client.FunctionInvoker = invoker;
Assert.Same(invoker, client.FunctionInvoker);
Assert.Null(client.AdditionalTools);
IList<AITool> additionalTools = [AIFunctionFactory.Create(() => "Additional Tool")];
client.AdditionalTools = additionalTools;
Assert.Same(additionalTools, client.AdditionalTools);
}
[Fact]
public async Task SupportsSingleFunctionCallPerRequestAsync()
{
var options = new ChatOptions
{
Tools =
[
AIFunctionFactory.Create(() => "Result 1", "Func1"),
AIFunctionFactory.Create((int i) => $"Result 2: {i}", "Func2"),
AIFunctionFactory.Create((int i) => { }, "VoidReturn"),
]
};
List<ChatMessage> plan =
[
new ChatMessage(ChatRole.User, "hello"),
new ChatMessage(ChatRole.Assistant, [new FunctionCallContent("callId1", "Func1")]),
new ChatMessage(ChatRole.Tool, [new FunctionResultContent("callId1", result: "Result 1")]),
new ChatMessage(ChatRole.Assistant, [new FunctionCallContent("callId2", "Func2", arguments: new Dictionary<string, object?> { { "i", 42 } })]),
new ChatMessage(ChatRole.Tool, [new FunctionResultContent("callId2", result: "Result 2: 42")]),
new ChatMessage(ChatRole.Assistant, [new FunctionCallContent("callId3", "VoidReturn", arguments: new Dictionary<string, object?> { { "i", 43 } })]),
new ChatMessage(ChatRole.Tool, [new FunctionResultContent("callId3", result: "Success: Function completed.")]),
new ChatMessage(ChatRole.Assistant, "world"),
];
await InvokeAndAssertAsync(options, plan);
await InvokeAndAssertStreamingAsync(options, plan);
}
[Theory]
[InlineData(false)]
[InlineData(true)]
public async Task SupportsToolsProvidedByAdditionalTools(bool provideOptions)
{
ChatOptions? options = provideOptions ?
new() { Tools = [AIFunctionFactory.Create(() => "Shouldn't be invoked", "ChatOptionsFunc")] } :
null;
Func<ChatClientBuilder, ChatClientBuilder> configure = builder =>
builder.UseFunctionInvocation(configure: c => c.AdditionalTools =
[
AIFunctionFactory.Create(() => "Result 1", "Func1"),
AIFunctionFactory.Create((int i) => $"Result 2: {i}", "Func2"),
AIFunctionFactory.Create((int i) => { }, "VoidReturn"),
]);
List<ChatMessage> plan =
[
new ChatMessage(ChatRole.User, "hello"),
new ChatMessage(ChatRole.Assistant, [new FunctionCallContent("callId1", "Func1")]),
new ChatMessage(ChatRole.Tool, [new FunctionResultContent("callId1", result: "Result 1")]),
new ChatMessage(ChatRole.Assistant, [new FunctionCallContent("callId2", "Func2", arguments: new Dictionary<string, object?> { { "i", 42 } })]),
new ChatMessage(ChatRole.Tool, [new FunctionResultContent("callId2", result: "Result 2: 42")]),
new ChatMessage(ChatRole.Assistant, [new FunctionCallContent("callId3", "VoidReturn", arguments: new Dictionary<string, object?> { { "i", 43 } })]),
new ChatMessage(ChatRole.Tool, [new FunctionResultContent("callId3", result: "Success: Function completed.")]),
new ChatMessage(ChatRole.Assistant, "world"),
];
await InvokeAndAssertAsync(options, plan, configurePipeline: configure);
await InvokeAndAssertStreamingAsync(options, plan, configurePipeline: configure);
}
[Fact]
public async Task PrefersToolsProvidedByChatOptions()
{
ChatOptions options = new()
{
Tools = [AIFunctionFactory.Create(() => "Result 1", "Func1")]
};
Func<ChatClientBuilder, ChatClientBuilder> configure = builder =>
builder.UseFunctionInvocation(configure: c => c.AdditionalTools =
[
AIFunctionFactory.Create(() => "Should never be invoked", "Func1"),
AIFunctionFactory.Create((int i) => $"Result 2: {i}", "Func2"),
AIFunctionFactory.Create((int i) => { }, "VoidReturn"),
]);
List<ChatMessage> plan =
[
new ChatMessage(ChatRole.User, "hello"),
new ChatMessage(ChatRole.Assistant, [new FunctionCallContent("callId1", "Func1")]),
new ChatMessage(ChatRole.Tool, [new FunctionResultContent("callId1", result: "Result 1")]),
new ChatMessage(ChatRole.Assistant, [new FunctionCallContent("callId2", "Func2", arguments: new Dictionary<string, object?> { { "i", 42 } })]),
new ChatMessage(ChatRole.Tool, [new FunctionResultContent("callId2", result: "Result 2: 42")]),
new ChatMessage(ChatRole.Assistant, [new FunctionCallContent("callId3", "VoidReturn", arguments: new Dictionary<string, object?> { { "i", 43 } })]),
new ChatMessage(ChatRole.Tool, [new FunctionResultContent("callId3", result: "Success: Function completed.")]),
new ChatMessage(ChatRole.Assistant, "world"),
];
await InvokeAndAssertAsync(options, plan, configurePipeline: configure);
await InvokeAndAssertStreamingAsync(options, plan, configurePipeline: configure);
}
[Theory]
[InlineData(false)]
[InlineData(true)]
public async Task SupportsMultipleFunctionCallsPerRequestAsync(bool concurrentInvocation)
{
var options = new ChatOptions
{
Tools =
[
AIFunctionFactory.Create((int? i = 42) => "Result 1", "Func1"),
AIFunctionFactory.Create((int i) => $"Result 2: {i}", "Func2"),
]
};
List<ChatMessage> plan =
[
new ChatMessage(ChatRole.User, "hello"),
new ChatMessage(ChatRole.Assistant,
[
new FunctionCallContent("callId1", "Func1"),
new FunctionCallContent("callId2", "Func2", arguments: new Dictionary<string, object?> { { "i", 34 } }),
new FunctionCallContent("callId3", "Func2", arguments: new Dictionary<string, object?> { { "i", 56 } }),
]),
new ChatMessage(ChatRole.Tool,
[
new FunctionResultContent("callId1", result: "Result 1"),
new FunctionResultContent("callId2", result: "Result 2: 34"),
new FunctionResultContent("callId3", result: "Result 2: 56"),
]),
new ChatMessage(ChatRole.Assistant,
[
new FunctionCallContent("callId4", "Func2", arguments: new Dictionary<string, object?> { { "i", 78 } }),
new FunctionCallContent("callId5", "Func1")
]),
new ChatMessage(ChatRole.Tool,
[
new FunctionResultContent("callId4", result: "Result 2: 78"),
new FunctionResultContent("callId5", result: "Result 1")
]),
new ChatMessage(ChatRole.Assistant, "world"),
];
Func<ChatClientBuilder, ChatClientBuilder> configure = b => b.Use(
s => new FunctionInvokingChatClient(s) { AllowConcurrentInvocation = concurrentInvocation });
await InvokeAndAssertAsync(options, plan, configurePipeline: configure);
await InvokeAndAssertStreamingAsync(options, plan, configurePipeline: configure);
}
[Fact]
public async Task ParallelFunctionCallsMayBeInvokedConcurrentlyAsync()
{
int remaining = 2;
var tcs = new TaskCompletionSource<bool>();
var options = new ChatOptions
{
Tools =
[
AIFunctionFactory.Create(async (string arg) =>
{
if (Interlocked.Decrement(ref remaining) == 0)
{
tcs.SetResult(true);
}
await tcs.Task;
return arg + arg;
}, "Func"),
]
};
List<ChatMessage> plan =
[
new ChatMessage(ChatRole.User, "hello"),
new ChatMessage(ChatRole.Assistant,
[
new FunctionCallContent("callId1", "Func", arguments: new Dictionary<string, object?> { { "arg", "hello" } }),
new FunctionCallContent("callId2", "Func", arguments: new Dictionary<string, object?> { { "arg", "world" } }),
]),
new ChatMessage(ChatRole.Tool,
[
new FunctionResultContent("callId1", result: "hellohello"),
new FunctionResultContent("callId2", result: "worldworld"),
]),
new ChatMessage(ChatRole.Assistant, "done"),
];
Func<ChatClientBuilder, ChatClientBuilder> configure = b => b.Use(
s => new FunctionInvokingChatClient(s) { AllowConcurrentInvocation = true });
await InvokeAndAssertAsync(options, plan, configurePipeline: configure);
await InvokeAndAssertStreamingAsync(options, plan, configurePipeline: configure);
}
[Fact]
public async Task ConcurrentInvocationOfParallelCallsDisabledByDefaultAsync()
{
int activeCount = 0;
var options = new ChatOptions
{
Tools =
[
AIFunctionFactory.Create(async (string arg) =>
{
Interlocked.Increment(ref activeCount);
await Task.Delay(100);
Assert.Equal(1, activeCount);
Interlocked.Decrement(ref activeCount);
return arg + arg;
}, "Func"),
]
};
List<ChatMessage> plan =
[
new ChatMessage(ChatRole.User, "hello"),
new ChatMessage(ChatRole.Assistant,
[
new FunctionCallContent("callId1", "Func", arguments: new Dictionary<string, object?> { { "arg", "hello" } }),
new FunctionCallContent("callId2", "Func", arguments: new Dictionary<string, object?> { { "arg", "world" } }),
]),
new ChatMessage(ChatRole.Tool,
[
new FunctionResultContent("callId1", result: "hellohello"),
new FunctionResultContent("callId2", result: "worldworld"),
]),
new ChatMessage(ChatRole.Assistant, "done"),
];
await InvokeAndAssertAsync(options, plan);
await InvokeAndAssertStreamingAsync(options, plan);
}
[Fact]
public async Task FunctionInvokerDelegateOverridesHandlingAsync()
{
var options = new ChatOptions
{
Tools =
[
AIFunctionFactory.Create(() => "Result 1", "Func1"),
AIFunctionFactory.Create((int i) => $"Result 2: {i}", "Func2"),
AIFunctionFactory.Create((int i) => { }, "VoidReturn"),
]
};
List<ChatMessage> plan =
[
new ChatMessage(ChatRole.User, "hello"),
new ChatMessage(ChatRole.Assistant, [new FunctionCallContent("callId1", "Func1")]),
new ChatMessage(ChatRole.Tool, [new FunctionResultContent("callId1", result: "Result 1 from delegate")]),
new ChatMessage(ChatRole.Assistant, [new FunctionCallContent("callId2", "Func2", arguments: new Dictionary<string, object?> { { "i", 42 } })]),
new ChatMessage(ChatRole.Tool, [new FunctionResultContent("callId2", result: "Result 2: 42 from delegate")]),
new ChatMessage(ChatRole.Assistant, [new FunctionCallContent("callId3", "VoidReturn", arguments: new Dictionary<string, object?> { { "i", 43 } })]),
new ChatMessage(ChatRole.Tool, [new FunctionResultContent("callId3", result: "Success: Function completed.")]),
new ChatMessage(ChatRole.Assistant, "world"),
];
Func<ChatClientBuilder, ChatClientBuilder> configure = b => b.Use(
s => new FunctionInvokingChatClient(s)
{
FunctionInvoker = async (ctx, cancellationToken) =>
{
Assert.NotNull(ctx);
var result = await ctx.Function.InvokeAsync(ctx.Arguments, cancellationToken);
return result is JsonElement e ?
JsonSerializer.SerializeToElement($"{e.GetString()} from delegate", AIJsonUtilities.DefaultOptions) :
result;
}
});
await InvokeAndAssertAsync(options, plan, configurePipeline: configure);
await InvokeAndAssertStreamingAsync(options, plan, configurePipeline: configure);
}
[Theory]
[InlineData(false)]
[InlineData(true)]
public async Task FunctionReturningFunctionResultContentWithMatchingCallId_UsesItDirectly(bool streaming)
{
FunctionResultContent? returnedFrc = null;
var options = new ChatOptions
{
Tools =
[
AIFunctionFactory.Create(() => "Result 1", "Func1"),
]
};
using var innerClient = new TestChatClient
{
GetResponseAsyncCallback = (msgs, opts, ct) =>
{
var toolMessage = msgs.FirstOrDefault(m => m.Role == ChatRole.Tool);
if (toolMessage is null)
{
return Task.FromResult(new ChatResponse(
new ChatMessage(ChatRole.Assistant, [new FunctionCallContent("callId1", "Func1")])));
}
else
{
return Task.FromResult(new ChatResponse(new ChatMessage(ChatRole.Assistant, "done")));
}
},
GetStreamingResponseAsyncCallback = (msgs, opts, ct) =>
{
var toolMessage = msgs.FirstOrDefault(m => m.Role == ChatRole.Tool);
if (toolMessage is null)
{
return YieldAsync(new ChatResponse(
new ChatMessage(ChatRole.Assistant, [new FunctionCallContent("callId1", "Func1")])).ToChatResponseUpdates());
}
else
{
return YieldAsync(new ChatResponse(new ChatMessage(ChatRole.Assistant, "done")).ToChatResponseUpdates());
}
}
};
using var client = new FunctionInvokingChatClient(innerClient)
{
FunctionInvoker = (ctx, cancellationToken) =>
{
returnedFrc = new FunctionResultContent(ctx.CallContent.CallId, "Custom result from function")
{
RawRepresentation = "CustomRaw"
};
return new ValueTask<object?>(returnedFrc);
}
};
var messages = new List<ChatMessage>
{
new ChatMessage(ChatRole.User, "hello"),
};
ChatResponse response;
if (streaming)
{
response = await client.GetStreamingResponseAsync(messages, options).ToChatResponseAsync();
}
else
{
response = await client.GetResponseAsync(messages, options);
}
// Verify that the FunctionResultContent was used directly (same reference)
var toolMessage = response.Messages.First(m => m.Role == ChatRole.Tool);
var capturedFrc = Assert.Single(toolMessage.Contents.OfType<FunctionResultContent>());
Assert.Same(returnedFrc, capturedFrc);
Assert.Equal("Custom result from function", capturedFrc.Result);
Assert.Equal("CustomRaw", capturedFrc.RawRepresentation);
Assert.Equal("callId1", capturedFrc.CallId);
}
[Theory]
[InlineData(false)]
[InlineData(true)]
public async Task FunctionReturningFunctionResultContentWithMismatchedCallId_WrapsIt(bool streaming)
{
FunctionResultContent? returnedFrc = null;
var options = new ChatOptions
{
Tools =
[
AIFunctionFactory.Create(() => "Result 1", "Func1"),
]
};
using var innerClient = new TestChatClient
{
GetResponseAsyncCallback = (msgs, opts, ct) =>
{
var toolMessage = msgs.FirstOrDefault(m => m.Role == ChatRole.Tool);
if (toolMessage is null)
{
return Task.FromResult(new ChatResponse(
new ChatMessage(ChatRole.Assistant, [new FunctionCallContent("callId1", "Func1")])));
}
else
{
return Task.FromResult(new ChatResponse(new ChatMessage(ChatRole.Assistant, "done")));
}
},
GetStreamingResponseAsyncCallback = (msgs, opts, ct) =>
{
var toolMessage = msgs.FirstOrDefault(m => m.Role == ChatRole.Tool);
if (toolMessage is null)
{
return YieldAsync(new ChatResponse(
new ChatMessage(ChatRole.Assistant, [new FunctionCallContent("callId1", "Func1")])).ToChatResponseUpdates());
}
else
{
return YieldAsync(new ChatResponse(new ChatMessage(ChatRole.Assistant, "done")).ToChatResponseUpdates());
}
}
};
using var client = new FunctionInvokingChatClient(innerClient)
{
FunctionInvoker = (ctx, cancellationToken) =>
{
// Return a FunctionResultContent with a different CallId
returnedFrc = new FunctionResultContent("differentCallId", "Result from function");
return new ValueTask<object?>(returnedFrc);
}
};
var messages = new List<ChatMessage>
{
new ChatMessage(ChatRole.User, "hello"),
};
ChatResponse response;
if (streaming)
{
response = await client.GetStreamingResponseAsync(messages, options).ToChatResponseAsync();
}
else
{
response = await client.GetResponseAsync(messages, options);
}
// Verify the result is wrapped - the outer FunctionResultContent has the correct CallId
// and the inner one is reference-equal to what was returned
var toolMessage = response.Messages.First(m => m.Role == ChatRole.Tool);
var frc = Assert.Single(toolMessage.Contents.OfType<FunctionResultContent>());
Assert.Equal("callId1", frc.CallId);
Assert.Same(returnedFrc, frc.Result);
var innerFrc = (FunctionResultContent)frc.Result!;
Assert.Equal("differentCallId", innerFrc.CallId);
Assert.Equal("Result from function", innerFrc.Result);
}
[Theory]
[InlineData(false)]
[InlineData(true)]
public async Task FunctionReturningDerivedFunctionResultContent_PropagatesInstanceToInnerClient(bool streaming)
{
DerivedFunctionResultContent? returnedFrc = null;
var options = new ChatOptions
{
Tools =
[
AIFunctionFactory.Create(() => "Result 1", "Func1"),
]
};
using var innerClient = new TestChatClient
{
GetResponseAsyncCallback = (msgs, opts, ct) =>
{
var toolMessage = msgs.FirstOrDefault(m => m.Role == ChatRole.Tool);
if (toolMessage is null)
{
return Task.FromResult(new ChatResponse(
new ChatMessage(ChatRole.Assistant, [new FunctionCallContent("callId1", "Func1")])));
}
else
{
return Task.FromResult(new ChatResponse(new ChatMessage(ChatRole.Assistant, "done")));
}
},
GetStreamingResponseAsyncCallback = (msgs, opts, ct) =>
{
var toolMessage = msgs.FirstOrDefault(m => m.Role == ChatRole.Tool);
if (toolMessage is null)
{
return YieldAsync(new ChatResponse(
new ChatMessage(ChatRole.Assistant, [new FunctionCallContent("callId1", "Func1")])).ToChatResponseUpdates());
}
else
{
return YieldAsync(new ChatResponse(new ChatMessage(ChatRole.Assistant, "done")).ToChatResponseUpdates());
}
}
};
using var client = new FunctionInvokingChatClient(innerClient)
{
FunctionInvoker = (ctx, cancellationToken) =>
{
// Return a derived FunctionResultContent
returnedFrc = new DerivedFunctionResultContent(ctx.CallContent.CallId, "Derived result")
{
CustomProperty = "CustomValue"
};
return new ValueTask<object?>(returnedFrc);
}
};
var messages = new List<ChatMessage>
{
new ChatMessage(ChatRole.User, "hello"),
};
ChatResponse response;
if (streaming)
{
response = await client.GetStreamingResponseAsync(messages, options).ToChatResponseAsync();
}
else
{
response = await client.GetResponseAsync(messages, options);
}
// Verify that the derived FunctionResultContent instance was propagated to the inner client
// and is reference-equal to what was returned
var toolMessage = response.Messages.First(m => m.Role == ChatRole.Tool);
var capturedFrc = Assert.Single(toolMessage.Contents.OfType<FunctionResultContent>());
Assert.Same(returnedFrc, capturedFrc);
Assert.IsType<DerivedFunctionResultContent>(capturedFrc);
var derivedFrc = (DerivedFunctionResultContent)capturedFrc;
Assert.Equal("callId1", derivedFrc.CallId);
Assert.Equal("Derived result", derivedFrc.Result);
Assert.Equal("CustomValue", derivedFrc.CustomProperty);
}
/// <summary>A derived FunctionResultContent for testing purposes.</summary>
private sealed class DerivedFunctionResultContent : FunctionResultContent
{
public DerivedFunctionResultContent(string callId, object? result)
: base(callId, result)
{
}
public string? CustomProperty { get; set; }
}
[Fact]
public async Task ContinuesWithSuccessfulCallsUntilMaximumIterations()
{
var maxIterations = 7;
Func<ChatClientBuilder, ChatClientBuilder> configurePipeline = pipeline => pipeline
.UseFunctionInvocation(configure: functionInvokingChatClient =>
{
functionInvokingChatClient.MaximumIterationsPerRequest = maxIterations;
});
var actualCallCount = 0;
var options = new ChatOptions
{
Tools =
[
AIFunctionFactory.Create(() => { actualCallCount++; }, "VoidReturn"),
]
};
List<ChatMessage> plan =
[
new ChatMessage(ChatRole.User, "hello"),
new ChatMessage(ChatRole.Assistant, [new FunctionCallContent($"callId0", "VoidReturn")]),
];
// Note that this plan ends with a function call. Normally we would expect the system to try to resolve
// the call, but it won't because of the maximum iterations limit.
for (var i = 0; i < maxIterations; i++)
{
plan.Add(new ChatMessage(ChatRole.Tool, [new FunctionResultContent($"callId{i}", result: "Success: Function completed.")]));
plan.Add(new ChatMessage(ChatRole.Assistant, [new FunctionCallContent($"callId{(i + 1)}", "VoidReturn")]));
}
await InvokeAndAssertAsync(options, plan, configurePipeline: configurePipeline);
Assert.Equal(maxIterations, actualCallCount);
actualCallCount = 0;
await InvokeAndAssertStreamingAsync(options, plan, configurePipeline: configurePipeline);
Assert.Equal(maxIterations, actualCallCount);
}
[Fact]
public async Task LastIteration_RemovesFunctionDeclarationTools_NonStreaming()
{
List<ChatOptions?> capturedOptions = [];
var maxIterations = 2;
using var innerClient = new TestChatClient
{
GetResponseAsyncCallback = (contents, options, cancellationToken) =>
{
capturedOptions.Add(options?.Clone());
var message = new ChatMessage(ChatRole.Assistant, [new FunctionCallContent($"callId{capturedOptions.Count}", "Func1")]);
return Task.FromResult(new ChatResponse(message));
}
};
using var client = new FunctionInvokingChatClient(innerClient)
{
MaximumIterationsPerRequest = maxIterations
};
var options = new ChatOptions
{
Tools = [AIFunctionFactory.Create(() => "Result", "Func1")],
ToolMode = ChatToolMode.Auto
};
await client.GetResponseAsync("hello", options);
Assert.Equal(maxIterations + 1, capturedOptions.Count);
for (int i = 0; i < maxIterations; i++)
{
Assert.NotNull(capturedOptions[i]?.Tools);
Assert.Single(capturedOptions[i]!.Tools!);
}
var lastOptions = capturedOptions[maxIterations];
Assert.NotNull(lastOptions);
Assert.Null(lastOptions!.Tools);
Assert.Null(lastOptions.ToolMode);
}
[Fact]
public async Task LastIteration_RemovesFunctionDeclarationTools_Streaming()
{
List<ChatOptions?> capturedOptions = [];
var maxIterations = 2;
using var innerClient = new TestChatClient
{
GetStreamingResponseAsyncCallback = (contents, options, cancellationToken) =>
{
capturedOptions.Add(options?.Clone());
var message = new ChatMessage(ChatRole.Assistant, [new FunctionCallContent($"callId{capturedOptions.Count}", "Func1")]);
return YieldAsync(new ChatResponse(message).ToChatResponseUpdates());
}
};
using var client = new FunctionInvokingChatClient(innerClient)
{
MaximumIterationsPerRequest = maxIterations
};
var options = new ChatOptions
{
Tools = [AIFunctionFactory.Create(() => "Result", "Func1")],
ToolMode = ChatToolMode.Auto
};
await client.GetStreamingResponseAsync("hello", options).ToChatResponseAsync();
Assert.Equal(maxIterations + 1, capturedOptions.Count);
for (int i = 0; i < maxIterations; i++)
{
Assert.NotNull(capturedOptions[i]?.Tools);
Assert.Single(capturedOptions[i]!.Tools!);
}
var lastOptions = capturedOptions[maxIterations];
Assert.NotNull(lastOptions);
Assert.Null(lastOptions!.Tools);
Assert.Null(lastOptions.ToolMode);
}
[Fact]
public async Task LastIteration_PreservesNonFunctionDeclarationTools()
{
var hostedTool = new HostedWebSearchTool();
List<ChatOptions?> capturedOptions = [];
var maxIterations = 1;
using var innerClient = new TestChatClient
{
GetResponseAsyncCallback = (contents, options, cancellationToken) =>
{
capturedOptions.Add(options?.Clone());
if (capturedOptions.Count == 1)
{
var message = new ChatMessage(ChatRole.Assistant, [new FunctionCallContent("callId1", "Func1")]);
return Task.FromResult(new ChatResponse(message));
}
else
{
var message = new ChatMessage(ChatRole.Assistant, "Done");
return Task.FromResult(new ChatResponse(message));
}
}
};
using var client = new FunctionInvokingChatClient(innerClient)
{
MaximumIterationsPerRequest = maxIterations
};
var options = new ChatOptions
{
Tools = [AIFunctionFactory.Create(() => "Result", "Func1"), hostedTool],
ToolMode = ChatToolMode.Auto
};
await client.GetResponseAsync("hello", options);
Assert.Equal(2, capturedOptions.Count);
Assert.NotNull(capturedOptions[0]?.Tools);
Assert.Equal(2, capturedOptions[0]!.Tools!.Count);
Assert.NotNull(capturedOptions[1]?.Tools);
Assert.Single(capturedOptions[1]!.Tools!);
Assert.IsType<HostedWebSearchTool>(capturedOptions[1]!.Tools![0]);
Assert.NotNull(capturedOptions[1]?.ToolMode);
}
[Fact]
public async Task LastIteration_DoesNotModifyOriginalOptions()
{
List<ChatOptions?> capturedOptions = [];
var maxIterations = 1;
using var innerClient = new TestChatClient
{
GetResponseAsyncCallback = (contents, options, cancellationToken) =>
{
capturedOptions.Add(options);
var message = new ChatMessage(ChatRole.Assistant, [new FunctionCallContent("callId1", "Func1")]);
return Task.FromResult(new ChatResponse(message));
}
};
using var client = new FunctionInvokingChatClient(innerClient)
{
MaximumIterationsPerRequest = maxIterations
};
var originalTool = AIFunctionFactory.Create(() => "Result", "Func1");
var originalOptions = new ChatOptions
{
Tools = [originalTool],
ToolMode = ChatToolMode.Auto
};
await client.GetResponseAsync("hello", originalOptions);
Assert.NotNull(originalOptions.Tools);
Assert.Single(originalOptions.Tools);
Assert.Same(originalTool, originalOptions.Tools[0]);
Assert.NotNull(originalOptions.ToolMode);
}
[Theory]
[InlineData(false)]
[InlineData(true)]
public async Task ContinuesWithFailingCallsUntilMaximumConsecutiveErrors(bool allowConcurrentInvocation)
{
Func<ChatClientBuilder, ChatClientBuilder> configurePipeline = pipeline => pipeline
.UseFunctionInvocation(configure: functionInvokingChatClient =>
{
functionInvokingChatClient.MaximumConsecutiveErrorsPerRequest = 2;
functionInvokingChatClient.AllowConcurrentInvocation = allowConcurrentInvocation;
});
var options = new ChatOptions
{
Tools =
[
AIFunctionFactory.Create((bool shouldThrow, int callIndex) =>
{
if (shouldThrow)
{
throw new InvalidTimeZoneException($"Exception from call {callIndex}");
}
}, "Func"),
]
};
var callIndex = 0;
List<ChatMessage> plan =
[
new ChatMessage(ChatRole.User, "hello"),
// A single failure isn't enough to stop the cycle
..CreateFunctionCallIterationPlan(ref callIndex, true, false),
// Now NumConsecutiveErrors = 1
// We can reset the number of consecutive errors by having a successful iteration
..CreateFunctionCallIterationPlan(ref callIndex, false, false, false),
// Now NumConsecutiveErrors = 0
// Any failure within an iteration causes the whole iteration to be treated as failed
..CreateFunctionCallIterationPlan(ref callIndex, false, true, false),
// Now NumConsecutiveErrors = 1
// Even if several calls in the same iteration fail, that only counts as a single iteration having failed, so won't exceed the limit yet
..CreateFunctionCallIterationPlan(ref callIndex, true, true, true),
// Now NumConsecutiveErrors = 2
// Any more failures will now exceed the limit
..CreateFunctionCallIterationPlan(ref callIndex, true, true),
];
if (allowConcurrentInvocation)
{
// With concurrent invocation, we always make all the calls in the iteration
// and combine their exceptions into an AggregateException
var ex = await Assert.ThrowsAsync<AggregateException>(() =>
InvokeAndAssertAsync(options, plan, configurePipeline: configurePipeline));
Assert.Equal(2, ex.InnerExceptions.Count);
Assert.Equal("Exception from call 11", ex.InnerExceptions[0].Message);
Assert.Equal("Exception from call 12", ex.InnerExceptions[1].Message);
ex = await Assert.ThrowsAsync<AggregateException>(() =>
InvokeAndAssertStreamingAsync(options, plan, configurePipeline: configurePipeline));
Assert.Equal(2, ex.InnerExceptions.Count);
Assert.Equal("Exception from call 11", ex.InnerExceptions[0].Message);
Assert.Equal("Exception from call 12", ex.InnerExceptions[1].Message);
}
else
{
// With serial invocation, we allow the threshold-crossing exception to propagate
// directly and terminate the iteration
var ex = await Assert.ThrowsAsync<InvalidTimeZoneException>(() =>
InvokeAndAssertAsync(options, plan, configurePipeline: configurePipeline));
Assert.Equal("Exception from call 11", ex.Message);
ex = await Assert.ThrowsAsync<InvalidTimeZoneException>(() =>
InvokeAndAssertStreamingAsync(options, plan, configurePipeline: configurePipeline));
Assert.Equal("Exception from call 11", ex.Message);
}
}
[Theory]
[InlineData(false)]
[InlineData(true)]
public async Task CanFailOnFirstException(bool allowConcurrentInvocation)
{
Func<ChatClientBuilder, ChatClientBuilder> configurePipeline = pipeline => pipeline
.UseFunctionInvocation(configure: functionInvokingChatClient =>
{
functionInvokingChatClient.MaximumConsecutiveErrorsPerRequest = 0;
functionInvokingChatClient.AllowConcurrentInvocation = allowConcurrentInvocation;
});
var options = new ChatOptions
{
Tools =
[
AIFunctionFactory.Create(() =>
{
throw new InvalidTimeZoneException($"It failed");
}, "Func"),
]
};
var callIndex = 0;
List<ChatMessage> plan =
[
new ChatMessage(ChatRole.User, "hello"),
..CreateFunctionCallIterationPlan(ref callIndex, true),
];
// Regardless of AllowConcurrentInvocation, if there's only a single exception,
// we don't wrap it in an AggregateException
var ex = await Assert.ThrowsAsync<InvalidTimeZoneException>(() =>
InvokeAndAssertAsync(options, plan, configurePipeline: configurePipeline));
Assert.Equal("It failed", ex.Message);
ex = await Assert.ThrowsAsync<InvalidTimeZoneException>(() =>
InvokeAndAssertStreamingAsync(options, plan, configurePipeline: configurePipeline));
Assert.Equal("It failed", ex.Message);
}
private static IEnumerable<ChatMessage> CreateFunctionCallIterationPlan(ref int callIndex, params bool[] shouldThrow)
{
var assistantMessage = new ChatMessage(ChatRole.Assistant, []);
var toolMessage = new ChatMessage(ChatRole.Tool, []);
foreach (var callShouldThrow in shouldThrow)
{
var thisCallIndex = callIndex++;
var callId = $"callId{thisCallIndex}";
assistantMessage.Contents.Add(new FunctionCallContent(callId, "Func",
arguments: new Dictionary<string, object?> { { "shouldThrow", callShouldThrow }, { "callIndex", thisCallIndex } }));
toolMessage.Contents.Add(new FunctionResultContent(callId, result: callShouldThrow ? "Error: Function failed." : "Success"));
}
return [assistantMessage, toolMessage];
}
[Fact]
public async Task KeepsFunctionCallingContent()
{
var options = new ChatOptions
{
Tools =
[
AIFunctionFactory.Create(() => "Result 1", "Func1"),
AIFunctionFactory.Create((int i) => $"Result 2: {i}", "Func2"),
AIFunctionFactory.Create((int i) => { }, "VoidReturn"),
]
};
List<ChatMessage> plan =
[
new ChatMessage(ChatRole.User, "hello"),
new ChatMessage(ChatRole.Assistant, [new TextContent("extra"), new FunctionCallContent("callId1", "Func1"), new TextContent("stuff")]),
new ChatMessage(ChatRole.Tool, [new FunctionResultContent("callId2", result: "Result 1")]),
new ChatMessage(ChatRole.Assistant, [new FunctionCallContent("callId2", "Func2", arguments: new Dictionary<string, object?> { { "i", 42 } })]),
new ChatMessage(ChatRole.Tool, [new FunctionResultContent("callId2", result: "Result 2: 42")]),
new ChatMessage(ChatRole.Assistant, [new FunctionCallContent("callId3", "VoidReturn", arguments: new Dictionary<string, object?> { { "i", 43 } }), new TextContent("more")]),
new ChatMessage(ChatRole.Tool, [new FunctionResultContent("callId3", result: "Success: Function completed.")]),
new ChatMessage(ChatRole.Assistant, "world"),
];
#pragma warning disable SA1005, S125
Validate(await InvokeAndAssertAsync(options, plan));
Validate(await InvokeAndAssertStreamingAsync(options, plan));
static void Validate(List<ChatMessage> finalChat)
{
IEnumerable<AIContent> content = finalChat.SelectMany(m => m.Contents);