36 instantiations of ChatFinishReason
Microsoft.Extensions.AI.Abstractions (5)
ChatCompletion\ChatFinishReason.cs (5)
66public static ChatFinishReason Stop { get; } = new("stop"); 69public static ChatFinishReason Length { get; } = new("length"); 72public static ChatFinishReason ToolCalls { get; } = new("tool_calls"); 75public static ChatFinishReason ContentFilter { get; } = new("content_filter"); 83new(reader.GetString()!);
Microsoft.Extensions.AI.Abstractions.Tests (30)
ChatCompletion\ChatFinishReasonTests.cs (30)
15Assert.Equal("abc", new ChatFinishReason("abc").Value); 21Assert.Throws<ArgumentNullException>("value", () => new ChatFinishReason(null!)); 22Assert.Throws<ArgumentException>("value", () => new ChatFinishReason(" ")); 28Assert.True(new ChatFinishReason("abc").Equals(new ChatFinishReason("ABC"))); 29Assert.True(new ChatFinishReason("abc").Equals((object)new ChatFinishReason("ABC"))); 30Assert.True(new ChatFinishReason("abc") == new ChatFinishReason("ABC")); 31Assert.Equal(new ChatFinishReason("abc").GetHashCode(), new ChatFinishReason("ABC").GetHashCode()); 32Assert.False(new ChatFinishReason("abc") != new ChatFinishReason("ABC")); 34Assert.False(new ChatFinishReason("abc").Equals(new ChatFinishReason("def"))); 35Assert.False(new ChatFinishReason("abc").Equals((object)new ChatFinishReason("def"))); 36Assert.False(new ChatFinishReason("abc").Equals(null)); 37Assert.False(new ChatFinishReason("abc").Equals("abc")); 38Assert.False(new ChatFinishReason("abc") == new ChatFinishReason("def")); 39Assert.True(new ChatFinishReason("abc") != new ChatFinishReason("def")); 40Assert.NotEqual(new ChatFinishReason("abc").GetHashCode(), new ChatFinishReason("def").GetHashCode()); // not guaranteed due to possible hash code collisions 55Assert.Equal("test", new ChatFinishReason("test").Value); 56Assert.Equal("test", new ChatFinishReason("test").ToString()); 58Assert.Equal("TEST", new ChatFinishReason("TEST").Value); 59Assert.Equal("TEST", new ChatFinishReason("TEST").ToString()); 68ChatFinishReason role = new("abc");
Microsoft.Extensions.AI.OpenAI (1)
OpenAIChatClient.cs (1)
840_ => new ChatFinishReason(s),
105 references to ChatFinishReason
Microsoft.Extensions.AI (5)
ChatCompletion\OpenTelemetryChatClient.cs (1)
444if (response.FinishReason is ChatFinishReason finishReason)
Common\OtelMessageSerializer.cs (4)
39IEnumerable<ChatMessage> messages, ChatFinishReason? chatFinishReason = null, JsonSerializerOptions? customContentSerializerOptions = null) 45chatFinishReason == ChatFinishReason.Length ? "length" : 46chatFinishReason == ChatFinishReason.ContentFilter ? "content_filter" : 47chatFinishReason == ChatFinishReason.ToolCalls ? "tool_call" :
Microsoft.Extensions.AI.Abstractions (22)
ChatCompletion\ChatFinishReason.cs (20)
15public readonly struct ChatFinishReason : IEquatable<ChatFinishReason> 17/// <summary>Initializes a new instance of the <see cref="ChatFinishReason"/> struct with a string that describes the reason.</summary> 31public override bool Equals([NotNullWhen(true)] object? obj) => obj is ChatFinishReason other && Equals(other); 34public bool Equals(ChatFinishReason other) => StringComparer.OrdinalIgnoreCase.Equals(Value, other.Value); 45public static bool operator ==(ChatFinishReason left, ChatFinishReason right) 56public static bool operator !=(ChatFinishReason left, ChatFinishReason right) 65/// <summary>Gets a <see cref="ChatFinishReason"/> representing the model encountering a natural stop point or provided stop sequence.</summary> 66public static ChatFinishReason Stop { get; } = new("stop"); 68/// <summary>Gets a <see cref="ChatFinishReason"/> representing the model reaching the maximum length allowed for the request and/or response (typically in terms of tokens).</summary> 69public static ChatFinishReason Length { get; } = new("length"); 71/// <summary>Gets a <see cref="ChatFinishReason"/> representing the model requesting the use of a tool that was defined in the request.</summary> 72public static ChatFinishReason ToolCalls { get; } = new("tool_calls"); 74/// <summary>Gets a <see cref="ChatFinishReason"/> representing the model filtering content, whether for safety, prohibited content, sensitive content, or other such issues.</summary> 75public static ChatFinishReason ContentFilter { get; } = new("content_filter"); 77/// <summary>Provides a <see cref="JsonConverter{ChatFinishReason}"/> for serializing <see cref="ChatFinishReason"/> instances.</summary> 79public sealed class Converter : JsonConverter<ChatFinishReason> 82public override ChatFinishReason Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => 86public override void Write(Utf8JsonWriter writer, ChatFinishReason value, JsonSerializerOptions options) =>
ChatCompletion\ChatResponse.cs (1)
85public ChatFinishReason? FinishReason { get; set; }
ChatCompletion\ChatResponseUpdate.cs (1)
155public ChatFinishReason? FinishReason { get; set; }
Microsoft.Extensions.AI.Abstractions.Tests (28)
ChatCompletion\ChatFinishReasonTests.cs (8)
46Assert.Equal("stop", ChatFinishReason.Stop.Value); 47Assert.Equal("length", ChatFinishReason.Length.Value); 48Assert.Equal("tool_calls", ChatFinishReason.ToolCalls.Value); 49Assert.Equal("content_filter", ChatFinishReason.ContentFilter.Value); 61Assert.Equal("stop", default(ChatFinishReason).Value); 62Assert.Equal("stop", default(ChatFinishReason).ToString()); 68ChatFinishReason role = new("abc"); 72ChatFinishReason? result = JsonSerializer.Deserialize(json, TestJsonSerializerContext.Default.ChatFinishReason);
ChatCompletion\ChatResponseTests.cs (12)
65response.FinishReason = ChatFinishReason.ContentFilter; 66Assert.Equal(ChatFinishReason.ContentFilter, response.FinishReason); 93FinishReason = ChatFinishReason.ContentFilter, 111Assert.Equal(ChatFinishReason.ContentFilter, result.FinishReason); 130FinishReason = ChatFinishReason.ContentFilter, 149Assert.Equal(ChatFinishReason.ContentFilter, result.FinishReason); 215Assert.Equal(ChatFinishReason.ContentFilter, result.FinishReason); 245FinishReason = ChatFinishReason.ContentFilter, 258Assert.Equal(ChatFinishReason.ContentFilter, update0.FinishReason); 287FinishReason = ChatFinishReason.ContentFilter, 300Assert.Equal(ChatFinishReason.ContentFilter, update0.FinishReason); 309Assert.Equal(ChatFinishReason.ContentFilter, update1.FinishReason);
ChatCompletion\ChatResponseUpdateTests.cs (8)
80update.FinishReason = ChatFinishReason.ContentFilter; 81Assert.Equal(ChatFinishReason.ContentFilter, update.FinishReason); 133FinishReason = ChatFinishReason.ContentFilter, 166Assert.Equal(ChatFinishReason.ContentFilter, result.FinishReason); 196FinishReason = ChatFinishReason.ContentFilter, 230Assert.Equal(ChatFinishReason.ContentFilter, result.FinishReason); 259FinishReason = ChatFinishReason.ContentFilter, 451Assert.Equal(ChatFinishReason.ContentFilter, result.FinishReason);
Microsoft.Extensions.AI.OpenAI (14)
MicrosoftExtensionsAIChatExtensions.cs (2)
293/// <summary>Converts the <see cref="Microsoft.Extensions.AI.ChatFinishReason"/> to a <see cref="ChatFinishReason"/>.</summary> 294private static ChatFinishReason ToChatFinishReason(Microsoft.Extensions.AI.ChatFinishReason? finishReason) =>
OpenAIChatClient.cs (6)
355ChatFinishReason? finishReason = null; 832private static ChatFinishReason? FromOpenAIFinishReason(OpenAI.Chat.ChatFinishReason? finishReason) => 836OpenAI.Chat.ChatFinishReason.Stop => ChatFinishReason.Stop, 837OpenAI.Chat.ChatFinishReason.Length => ChatFinishReason.Length, 838OpenAI.Chat.ChatFinishReason.ContentFilter => ChatFinishReason.ContentFilter, 839OpenAI.Chat.ChatFinishReason.ToolCalls or OpenAI.Chat.ChatFinishReason.FunctionCall => ChatFinishReason.ToolCalls,
OpenAIResponsesChatClient.cs (6)
453(anyFunctions ? ChatFinishReason.ToolCalls : 454ChatFinishReason.Stop); 946/// <summary>Creates a <see cref="ChatFinishReason"/> from a <see cref="ResponseIncompleteStatusReason"/>.</summary> 947private static ChatFinishReason? AsFinishReason(ResponseIncompleteStatusReason? statusReason) => 948statusReason == ResponseIncompleteStatusReason.ContentFilter ? ChatFinishReason.ContentFilter : 949statusReason == ResponseIncompleteStatusReason.MaxOutputTokens ? ChatFinishReason.Length :
Microsoft.Extensions.AI.OpenAI.Tests (32)
OpenAIChatClientTests.cs (11)
170Assert.Equal(ChatFinishReason.Stop, response.FinishReason); 256Assert.Equal(i < 10 ? null : ChatFinishReason.Stop, updates[i].FinishReason); 304Assert.Equal(ChatFinishReason.Stop, updates[2].FinishReason); 876Assert.Equal(ChatFinishReason.Stop, response.FinishReason); 973Assert.Equal(ChatFinishReason.Stop, response.FinishReason); 1071Assert.Equal(ChatFinishReason.Stop, response.FinishReason); 1183Assert.Equal(ChatFinishReason.ToolCalls, response.FinishReason); 1268Assert.Equal(ChatFinishReason.Stop, response.FinishReason); 1377Assert.Equal(i < 7 ? null : ChatFinishReason.ToolCalls, updates[i].FinishReason); 1525Assert.Equal(ChatFinishReason.Stop, response.FinishReason); 1645Assert.Equal(ChatFinishReason.Stop, response.FinishReason);
OpenAIConversionTests.cs (15)
896Assert.Equal(ChatFinishReason.Length, response.FinishReason); 927Assert.Equal(ChatFinishReason.ToolCalls, response.FinishReason); 1528FinishReason = ChatFinishReason.Stop, 1596FinishReason = ChatFinishReason.ToolCalls 1625(ChatFinishReason.Stop, OpenAI.Chat.ChatFinishReason.Stop), 1626(ChatFinishReason.Length, OpenAI.Chat.ChatFinishReason.Length), 1627(ChatFinishReason.ContentFilter, OpenAI.Chat.ChatFinishReason.ContentFilter), 1628(ChatFinishReason.ToolCalls, OpenAI.Chat.ChatFinishReason.ToolCalls) 1717FinishReason = ChatFinishReason.Stop, 1909(ChatFinishReason.Stop, OpenAI.Chat.ChatFinishReason.Stop), 1910(ChatFinishReason.Length, OpenAI.Chat.ChatFinishReason.Length), 1911(ChatFinishReason.ContentFilter, OpenAI.Chat.ChatFinishReason.ContentFilter), 1912(ChatFinishReason.ToolCalls, OpenAI.Chat.ChatFinishReason.ToolCalls) 1949FinishReason = ChatFinishReason.Stop 2012FinishReason = ChatFinishReason.Stop
OpenAIResponseClientTests.cs (6)
343Assert.Equal(i < updates.Count - 1 ? null : ChatFinishReason.Stop, updates[i].FinishReason); 875Assert.Equal(i < updates.Count - 1 ? null : ChatFinishReason.Stop, updates[i].FinishReason); 1115Assert.Equal(i >= 4 ? ChatFinishReason.Stop : null, updates[i].FinishReason); 2519Assert.Equal(ChatFinishReason.Stop, response.FinishReason); 3251Assert.Equal(ChatFinishReason.Stop, updates[i].FinishReason); 5768Assert.Equal(ChatFinishReason.Length, response.FinishReason);
Microsoft.Extensions.AI.Tests (4)
ChatCompletion\DistributedCachingChatClientTest.cs (2)
396FinishReason = ChatFinishReason.Length, 422Assert.Equal(ChatFinishReason.Length, item.FinishReason);
ChatCompletion\OpenTelemetryChatClientTests.cs (2)
44FinishReason = ChatFinishReason.Stop, 82FinishReason = ChatFinishReason.Stop,