37 instantiations of ChatFinishReason
Microsoft.Extensions.AI.Abstractions (5)
ChatCompletion\ChatFinishReason.cs (5)
69public static ChatFinishReason Stop { get; } = new("stop"); 72public static ChatFinishReason Length { get; } = new("length"); 75public static ChatFinishReason ToolCalls { get; } = new("tool_calls"); 78public static ChatFinishReason ContentFilter { get; } = new("content_filter"); 86new(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.AzureAIInference (1)
AzureAIInferenceChatClient.cs (1)
284new(s);
Microsoft.Extensions.AI.OpenAI (1)
OpenAIChatClient.cs (1)
729_ => new ChatFinishReason(s),
101 references to ChatFinishReason
Microsoft.Extensions.AI (1)
ChatCompletion\OpenTelemetryChatClient.cs (1)
384if (response.FinishReason is ChatFinishReason finishReason)
Microsoft.Extensions.AI.Abstractions (22)
ChatCompletion\ChatFinishReason.cs (20)
15public readonly struct ChatFinishReason : IEquatable<ChatFinishReason> 20/// <summary>Initializes a new instance of the <see cref="ChatFinishReason"/> struct with a string that describes the reason.</summary> 34public override bool Equals([NotNullWhen(true)] object? obj) => obj is ChatFinishReason other && Equals(other); 37public bool Equals(ChatFinishReason other) => StringComparer.OrdinalIgnoreCase.Equals(Value, other.Value); 48public static bool operator ==(ChatFinishReason left, ChatFinishReason right) 59public static bool operator !=(ChatFinishReason left, ChatFinishReason right) 68/// <summary>Gets a <see cref="ChatFinishReason"/> representing the model encountering a natural stop point or provided stop sequence.</summary> 69public static ChatFinishReason Stop { get; } = new("stop"); 71/// <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> 72public static ChatFinishReason Length { get; } = new("length"); 74/// <summary>Gets a <see cref="ChatFinishReason"/> representing the model requesting the use of a tool that was defined in the request.</summary> 75public static ChatFinishReason ToolCalls { get; } = new("tool_calls"); 77/// <summary>Gets a <see cref="ChatFinishReason"/> representing the model filtering content, whether for safety, prohibited content, sensitive content, or other such issues.</summary> 78public static ChatFinishReason ContentFilter { get; } = new("content_filter"); 80/// <summary>Provides a <see cref="JsonConverter{ChatFinishReason}"/> for serializing <see cref="ChatFinishReason"/> instances.</summary> 82public sealed class Converter : JsonConverter<ChatFinishReason> 85public override ChatFinishReason Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => 89public override void Write(Utf8JsonWriter writer, ChatFinishReason value, JsonSerializerOptions options) =>
ChatCompletion\ChatResponse.cs (1)
86public ChatFinishReason? FinishReason { get; set; }
ChatCompletion\ChatResponseUpdate.cs (1)
136public ChatFinishReason? FinishReason { get; set; }
Microsoft.Extensions.AI.Abstractions.Tests (21)
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 (9)
65response.FinishReason = ChatFinishReason.ContentFilter; 66Assert.Equal(ChatFinishReason.ContentFilter, response.FinishReason); 92FinishReason = ChatFinishReason.ContentFilter, 109Assert.Equal(ChatFinishReason.ContentFilter, result.FinishReason); 134FinishReason = ChatFinishReason.ContentFilter, 147Assert.Equal(ChatFinishReason.ContentFilter, update0.FinishReason); 176FinishReason = ChatFinishReason.ContentFilter, 189Assert.Equal(ChatFinishReason.ContentFilter, update0.FinishReason); 198Assert.Equal(ChatFinishReason.ContentFilter, update1.FinishReason);
ChatCompletion\ChatResponseUpdateTests.cs (4)
80update.FinishReason = ChatFinishReason.ContentFilter; 81Assert.Equal(ChatFinishReason.ContentFilter, update.FinishReason); 131FinishReason = ChatFinishReason.ContentFilter, 162Assert.Equal(ChatFinishReason.ContentFilter, result.FinishReason);
Microsoft.Extensions.AI.AzureAIInference (6)
AzureAIInferenceChatClient.cs (6)
148ChatFinishReason? finishReason = default; 278private static ChatFinishReason? ToFinishReason(CompletionsFinishReason? finishReason) => 280finishReason == CompletionsFinishReason.Stopped ? ChatFinishReason.Stop : 281finishReason == CompletionsFinishReason.TokenLimitReached ? ChatFinishReason.Length : 282finishReason == CompletionsFinishReason.ContentFiltered ? ChatFinishReason.ContentFilter : 283finishReason == CompletionsFinishReason.ToolCalls ? ChatFinishReason.ToolCalls :
Microsoft.Extensions.AI.AzureAIInference.Tests (6)
AzureAIInferenceChatClientTests.cs (6)
162Assert.Equal(ChatFinishReason.Stop, response.FinishReason); 243Assert.Equal(i < 10 ? null : ChatFinishReason.Stop, updates[i].FinishReason); 1011Assert.Equal(ChatFinishReason.Stop, response.FinishReason); 1145Assert.Equal(ChatFinishReason.Stop, response.FinishReason); 1260Assert.Equal(ChatFinishReason.ToolCalls, response.FinishReason); 1355Assert.Equal(i < 7 ? null : ChatFinishReason.ToolCalls, updates[i].FinishReason);
Microsoft.Extensions.AI.OpenAI (14)
MicrosoftExtensionsAIChatExtensions.cs (2)
266/// <summary>Converts the <see cref="Microsoft.Extensions.AI.ChatFinishReason"/> to a <see cref="ChatFinishReason"/>.</summary> 267private static ChatFinishReason ToChatFinishReason(Microsoft.Extensions.AI.ChatFinishReason? finishReason) =>
OpenAIChatClient.cs (6)
314ChatFinishReason? finishReason = null; 721private static ChatFinishReason? FromOpenAIFinishReason(OpenAI.Chat.ChatFinishReason? finishReason) => 725OpenAI.Chat.ChatFinishReason.Stop => ChatFinishReason.Stop, 726OpenAI.Chat.ChatFinishReason.Length => ChatFinishReason.Length, 727OpenAI.Chat.ChatFinishReason.ContentFilter => ChatFinishReason.ContentFilter, 728OpenAI.Chat.ChatFinishReason.ToolCalls or OpenAI.Chat.ChatFinishReason.FunctionCall => ChatFinishReason.ToolCalls,
OpenAIResponsesChatClient.cs (6)
231(functionCallInfos is not null ? ChatFinishReason.ToolCalls : 232ChatFinishReason.Stop); 362/// <summary>Creates a <see cref="ChatFinishReason"/> from a <see cref="ResponseIncompleteStatusReason"/>.</summary> 363private static ChatFinishReason? ToFinishReason(ResponseIncompleteStatusReason? statusReason) => 364statusReason == ResponseIncompleteStatusReason.ContentFilter ? ChatFinishReason.ContentFilter : 365statusReason == ResponseIncompleteStatusReason.MaxOutputTokens ? ChatFinishReason.Length :
Microsoft.Extensions.AI.OpenAI.Tests (26)
OpenAIChatClientTests.cs (10)
169Assert.Equal(ChatFinishReason.Stop, response.FinishReason); 255Assert.Equal(i < 10 ? null : ChatFinishReason.Stop, updates[i].FinishReason); 827Assert.Equal(ChatFinishReason.Stop, response.FinishReason); 924Assert.Equal(ChatFinishReason.Stop, response.FinishReason); 1022Assert.Equal(ChatFinishReason.Stop, response.FinishReason); 1134Assert.Equal(ChatFinishReason.ToolCalls, response.FinishReason); 1218Assert.Equal(ChatFinishReason.Stop, response.FinishReason); 1327Assert.Equal(i < 7 ? null : ChatFinishReason.ToolCalls, updates[i].FinishReason); 1475Assert.Equal(ChatFinishReason.Stop, response.FinishReason); 1590Assert.Equal(ChatFinishReason.Stop, response.FinishReason);
OpenAIConversionTests.cs (15)
220Assert.Equal(ChatFinishReason.Length, response.FinishReason); 251Assert.Equal(ChatFinishReason.ToolCalls, response.FinishReason); 406FinishReason = ChatFinishReason.Stop, 474FinishReason = ChatFinishReason.ToolCalls 503(ChatFinishReason.Stop, OpenAI.Chat.ChatFinishReason.Stop), 504(ChatFinishReason.Length, OpenAI.Chat.ChatFinishReason.Length), 505(ChatFinishReason.ContentFilter, OpenAI.Chat.ChatFinishReason.ContentFilter), 506(ChatFinishReason.ToolCalls, OpenAI.Chat.ChatFinishReason.ToolCalls) 595FinishReason = ChatFinishReason.Stop, 787(ChatFinishReason.Stop, OpenAI.Chat.ChatFinishReason.Stop), 788(ChatFinishReason.Length, OpenAI.Chat.ChatFinishReason.Length), 789(ChatFinishReason.ContentFilter, OpenAI.Chat.ChatFinishReason.ContentFilter), 790(ChatFinishReason.ToolCalls, OpenAI.Chat.ChatFinishReason.ToolCalls) 827FinishReason = ChatFinishReason.Stop 891FinishReason = ChatFinishReason.Stop
OpenAIResponseClientTests.cs (1)
272Assert.Equal(i < updates.Count - 1 ? null : ChatFinishReason.Stop, updates[i].FinishReason);
Microsoft.Extensions.AI.Tests (4)
ChatCompletion\DistributedCachingChatClientTest.cs (2)
395FinishReason = ChatFinishReason.Length, 421Assert.Equal(ChatFinishReason.Length, item.FinishReason);
ChatCompletion\OpenTelemetryChatClientTests.cs (2)
44FinishReason = ChatFinishReason.Stop, 80FinishReason = ChatFinishReason.Stop,
Microsoft.ML.GenAI.Core (1)
CausalLMPipelineChatClient.cs (1)
51FinishReason = ChatFinishReason.Stop,