ChatOptions

ChatCompletion\ChatClientStructuredOutputExtensions.cs (1)

193options = options is not null ? options.Clone() : new();

ChatCompletion\ConfigureOptionsChatClient.cs (1)

54options = options?.Clone() ?? new();

ChatCompletion\ChatOptions.cs (1)

106ChatOptions options = new()

ChatCompletion\ChatClientExtensionsTests.cs (2)

104var expectedOptions = new ChatOptions(); 131var expectedOptions = new ChatOptions();

ChatCompletion\ChatOptionsTests.cs (3)

15ChatOptions options = new(); 51ChatOptions options = new(); 120ChatOptions options = new();

ChatCompletion\DelegatingChatClientTests.cs (2)

25var expectedChatOptions = new ChatOptions(); 57var expectedChatOptions = new ChatOptions();

AzureAIInferenceChatClientTests.cs (9)

159var response = await client.GetResponseAsync(messages, new() 232await foreach (var update in client.GetStreamingResponseAsync(messages, new() 295Assert.NotNull(await client.GetResponseAsync("hello", new() 343Assert.NotNull(await client.GetResponseAsync("hello", new() 379Assert.NotNull(await client.GetResponseAsync("hello", new() 436Assert.NotNull(await client.GetResponseAsync("hello", new() 543var response = await client.GetResponseAsync(messages, new() 797var response = await client.GetResponseAsync("How old is Alice?", new() 884await foreach (var update in client.GetStreamingResponseAsync("How old is Alice?", new()

AdditionalContextTests.cs (1)

26new ChatOptions

EndToEndTests.cs (1)

28new ChatOptions

RelevanceTruthAndCompletenessEvaluator.cs (1)

57new ChatOptions

SingleNumericMetricEvaluator.cs (1)

41new ChatOptions

Utilities\JsonOutputFixer.cs (1)

59new ChatOptions

ChatClientIntegrationTests.cs (7)

125var response = _chatClient.GetStreamingResponseAsync("Explain in 10 words how AI works", new() 208var response = await chatClient.GetResponseAsync(messages, new() 233var response = await chatClient.GetResponseAsync("What is the result of SecretComputation on 42 and 84?", new() 248var response = chatClient.GetStreamingResponseAsync("What is the result of SecretComputation on 42 and 84?", new() 276var response = await chatClient.GetResponseAsync("How much older is Elsa than Anna? Return the age difference as a single number.", new() 308var response = await chatClient.GetResponseAsync("Are birds real?", new() 329var response = await chatClient.GetResponseAsync("What's the current secret number?", new()

OllamaChatClientIntegrationTests.cs (2)

42var response = await chatClient.GetResponseAsync("What is the current secret number? Answer with digits only.", new ChatOptions 77var response = await chatClient.GetResponseAsync("What's the stock price for Microsoft in British pounds?", new ChatOptions

OllamaChatClientTests.cs (4)

114var response = await client.GetResponseAsync("hello", new() 174var streamingResponse = client.GetStreamingResponseAsync("hello", new() 272var response = await client.GetResponseAsync(messages, new() 372var response = await client.GetResponseAsync("How old is Alice?", new()

OpenAIModelMapper.ChatCompletion.cs (1)

182ChatOptions result = new();

OpenAIChatClientTests.cs (6)

190var response = await client.GetResponseAsync("hello", new() 271await foreach (var update in client.GetStreamingResponseAsync("hello", new() 350Assert.NotNull(await client.GetResponseAsync("hello", new() 447var response = await client.GetResponseAsync(messages, new() 768var response = await client.GetResponseAsync("How old is Alice?", new() 872await foreach (var update in client.GetStreamingResponseAsync("How old is Alice?", new()

ChatCompletion\ConfigureOptionsChatClientTests.cs (1)

35ChatOptions? providedOptions = nullProvidedOptions ? null : new() { ModelId = "test" };

ChatCompletion\DistributedCachingChatClientTest.cs (6)

536var result1 = await outer.GetResponseAsync([], new ChatOptions 540var result2 = await outer.GetResponseAsync([], new ChatOptions 551var result3 = await outer.GetResponseAsync([], new ChatOptions 555var result4 = await outer.GetResponseAsync([], new ChatOptions 587var result1 = await outer.GetResponseAsync([], new ChatOptions 591var result2 = await outer.GetResponseAsync([], new ChatOptions

ChatCompletion\FunctionInvokingChatClientTests.cs (12)

44var options = new ChatOptions 76var options = new ChatOptions 126var options = new ChatOptions 167var options = new ChatOptions 206var options = new ChatOptions 245var options = new ChatOptions 283var options = new ChatOptions 339ChatOptions options = new() 387var options = new ChatOptions 445var options = new ChatOptions 502var options = new ChatOptions 561var options = new ChatOptions

ChatCompletion\LoggingChatClientTests.cs (2)

70new ChatOptions { FrequencyPenalty = 3.0f }); 119new ChatOptions { FrequencyPenalty = 3.0f }))

ChatCompletion\OpenTelemetryChatClientTests.cs (1)

118var options = new ChatOptions

ChatCompletion\UseDelegateChatClientTests.cs (4)

29ChatOptions expectedOptions = new(); 79ChatOptions expectedOptions = new(); 121ChatOptions expectedOptions = new(); 172ChatOptions expectedOptions = new();

Llama3CausalLMChatClient.cs (2)

32options ??= new ChatOptions(); 51options ??= new ChatOptions();

Phi3\Phi3CausalLMChatClient.cs (2)

37options ??= new ChatOptions(); 56options ??= new ChatOptions();

AspireAzureOpenAIClientBuilderChatClientExtensionsTests.cs (1)

220static Task<ChatResponse> TestMiddleware(IEnumerable<ChatMessage> list, ChatOptions? options, IChatClient client, CancellationToken token)

AspireOpenAIClientBuilderChatClientExtensionsTests.cs (1)

268private static Task<ChatResponse> TestMiddleware(IEnumerable<ChatMessage> list, ChatOptions? options, IChatClient client, CancellationToken token)

ChatCompletion\AnonymousDelegatingChatClient.cs (11)

ChatCompletion\CachingChatClient.cs (2)

49IEnumerable<ChatMessage> messages, ChatOptions? options = null, CancellationToken cancellationToken = default) 69IEnumerable<ChatMessage> messages, ChatOptions? options = null, [EnumeratorCancellation] CancellationToken cancellationToken = default)

ChatCompletion\ChatClientBuilder.cs (4)

105public ChatClientBuilder Use(Func<IEnumerable<ChatMessage>, ChatOptions?, Func<IEnumerable<ChatMessage>, ChatOptions?, CancellationToken, Task>, CancellationToken, Task> sharedFunc) 139Func<IEnumerable<ChatMessage>, ChatOptions?, IChatClient, CancellationToken, Task<ChatResponse>>? getResponseFunc, 140Func<IEnumerable<ChatMessage>, ChatOptions?, IChatClient, CancellationToken, IAsyncEnumerable<ChatResponseUpdate>>? getStreamingResponseFunc)

ChatCompletion\ChatClientStructuredOutputExtensions.cs (6)

45ChatOptions? options = null, 65ChatOptions? options = null, 85ChatOptions? options = null, 107ChatOptions? options = null, 129ChatOptions? options = null, 154ChatOptions? options = null,

ChatCompletion\ConfigureOptionsChatClient.cs (13)

13/// <summary>Represents a delegating chat client that configures a <see cref="ChatOptions"/> instance used by the remainder of the pipeline.</summary> 17private readonly Action<ChatOptions> _configureOptions; 22/// The delegate to invoke to configure the <see cref="ChatOptions"/> instance. It is passed a clone of the caller-supplied <see cref="ChatOptions"/> instance 26/// The <paramref name="configure"/> delegate is passed either a new instance of <see cref="ChatOptions"/> if 27/// the caller didn't supply a <see cref="ChatOptions"/> instance, or a clone (via <see cref="ChatOptions.Clone"/> of the caller-supplied 30public ConfigureOptionsChatClient(IChatClient innerClient, Action<ChatOptions> configure) 38IEnumerable<ChatMessage> messages, ChatOptions? options = null, CancellationToken cancellationToken = default) => 43IEnumerable<ChatMessage> messages, ChatOptions? options = null, [EnumeratorCancellation] CancellationToken cancellationToken = default) 51/// <summary>Creates and configures the <see cref="ChatOptions"/> to pass along to the inner client.</summary> 52private ChatOptions Configure(ChatOptions? options)

ChatCompletion\ConfigureOptionsChatClientBuilderExtensions.cs (7)

15/// Adds a callback that configures a <see cref="ChatOptions"/> to be passed to the next client in the pipeline. 19/// The delegate to invoke to configure the <see cref="ChatOptions"/> instance. 20/// It is passed a clone of the caller-supplied <see cref="ChatOptions"/> instance (or a newly constructed instance if the caller-supplied instance is <see langword="null"/>). 24/// <see cref="ChatOptions"/> if the caller didn't supply a <see cref="ChatOptions"/> instance, or a clone (via <see cref="ChatOptions.Clone"/>) 31this ChatClientBuilder builder, Action<ChatOptions> configure)

ChatCompletion\FunctionInvocationContext.cs (1)

49public ChatOptions? Options { get; set; }

ChatCompletion\FunctionInvokingChatClient.cs (9)

23/// A delegating chat client that invokes functions defined on <see cref="ChatOptions"/>. 29/// by calling the corresponding <see cref="AIFunction"/> defined in <see cref="ChatOptions.Tools"/>, 36/// <see cref="AIFunction"/> instances employed as part of the supplied <see cref="ChatOptions"/> are also safe. 41/// ASP.NET web request should only be used as part of a single <see cref="ChatOptions"/> at a time, and only with 184IEnumerable<ChatMessage> messages, ChatOptions? options = null, CancellationToken cancellationToken = default) 270IEnumerable<ChatMessage> messages, ChatOptions? options = null, [EnumeratorCancellation] CancellationToken cancellationToken = default) 449private static bool UpdateOptionsForMode(ContinueMode mode, ref ChatOptions options, string? chatThreadId) 500List<ChatMessage> messages, ChatOptions options, List<FunctionCallContent> functionCallContents, int iteration, CancellationToken cancellationToken) 582List<ChatMessage> messages, ChatOptions options, List<FunctionCallContent> callContents,

ChatCompletion\LoggingChatClient.cs (2)

47IEnumerable<ChatMessage> messages, ChatOptions? options = null, CancellationToken cancellationToken = default) 93IEnumerable<ChatMessage> messages, ChatOptions? options = null, [EnumeratorCancellation] CancellationToken cancellationToken = default)

ChatCompletion\OpenTelemetryChatClient.cs (3)

125IEnumerable<ChatMessage> messages, ChatOptions? options = null, CancellationToken cancellationToken = default) 156IEnumerable<ChatMessage> messages, ChatOptions? options = null, [EnumeratorCancellation] CancellationToken cancellationToken = default) 215private Activity? CreateAndConfigureActivity(ChatOptions? options)

ChatCompletion\ChatClientExtensions.cs (4)

94ChatOptions? options = null, 114ChatOptions? options = null, 134ChatOptions? options = null, 154ChatOptions? options = null,

ChatCompletion\ChatClientMetadata.cs (1)

38/// An individual request may override this value via <see cref="ChatOptions.ModelId"/>.

ChatCompletion\ChatOptions.cs (4)

97/// <summary>Produces a clone of the current <see cref="ChatOptions"/> instance.</summary> 98/// <returns>A clone of the current <see cref="ChatOptions"/> instance.</returns> 104public virtual ChatOptions Clone() 106ChatOptions options = new()

ChatCompletion\ChatResponse.cs (1)

71/// and it should be used in a subsequent <see cref="ChatOptions.ChatThreadId"/> instead of supplying the same messages

ChatCompletion\ChatResponseUpdate.cs (1)

115/// and it should be used in a subsequent <see cref="ChatOptions.ChatThreadId"/> instead of supplying the same messages

ChatCompletion\ChatToolMode.cs (4)

33/// <see cref="ChatOptions.Tools"/> can contain zero or more <see cref="AITool"/> 42/// <see cref="ChatOptions.Tools"/> can contain zero or more <see cref="AITool"/> 52/// but that any tool can be selected. At least one tool must be provided in <see cref="ChatOptions.Tools"/>. 59/// must match an entry in <see cref="ChatOptions.Tools"/>.

ChatCompletion\DelegatingChatClient.cs (2)

42IEnumerable<ChatMessage> messages, ChatOptions? options = null, CancellationToken cancellationToken = default) => 47IEnumerable<ChatMessage> messages, ChatOptions? options = null, CancellationToken cancellationToken = default) =>

ChatCompletion\IChatClient.cs (2)

36ChatOptions? options = null, 47ChatOptions? options = null,

Utilities\AIJsonUtilities.Defaults.cs (1)

81[JsonSerializable(typeof(ChatOptions))]

ChatCompletion\ChatClientExtensionsTests.cs (2)

104var expectedOptions = new ChatOptions(); 131var expectedOptions = new ChatOptions();

ChatCompletion\ChatOptionsTests.cs (6)

15ChatOptions options = new(); 31ChatOptions clone = options.Clone(); 51ChatOptions options = new(); 100ChatOptions clone = options.Clone(); 120ChatOptions options = new(); 154ChatOptions? deserialized = JsonSerializer.Deserialize(json, TestJsonSerializerContext.Default.ChatOptions);

ChatCompletion\DelegatingChatClientTests.cs (2)

25var expectedChatOptions = new ChatOptions(); 57var expectedChatOptions = new ChatOptions();

TestChatClient.cs (4)

20public Func<IEnumerable<ChatMessage>, ChatOptions?, CancellationToken, Task<ChatResponse>>? GetResponseAsyncCallback { get; set; } 22public Func<IEnumerable<ChatMessage>, ChatOptions?, CancellationToken, IAsyncEnumerable<ChatResponseUpdate>>? GetStreamingResponseAsyncCallback { get; set; } 29public Task<ChatResponse> GetResponseAsync(IEnumerable<ChatMessage> messages, ChatOptions? options = null, CancellationToken cancellationToken = default) 32public IAsyncEnumerable<ChatResponseUpdate> GetStreamingResponseAsync(IEnumerable<ChatMessage> messages, ChatOptions? options = null, CancellationToken cancellationToken = default)

TestJsonSerializerContext.cs (1)

19[JsonSerializable(typeof(ChatOptions))]

AzureAIInferenceChatClient.cs (4)

41/// <param name="modelId">The ID of the model to use. If null, it can be provided per request via <see cref="ChatOptions.ModelId"/>.</param> 87IEnumerable<ChatMessage> messages, ChatOptions? options = null, CancellationToken cancellationToken = default) 141IEnumerable<ChatMessage> messages, ChatOptions? options = null, [EnumeratorCancellation] CancellationToken cancellationToken = default) 284private ChatCompletionsOptions ToAzureAIOptions(IEnumerable<ChatMessage> chatContents, ChatOptions? options)

AzureAIInferenceExtensions.cs (2)

13/// <param name="modelId">The ID of the model to use. If null, it can be provided per request via <see cref="ChatOptions.ModelId"/>.</param> 21/// <param name="modelId">The ID of the model to use. If null, it can be provided per request via <see cref="ChatOptions.ModelId"/>.</param>

AdditionalContextTests.cs (1)

20private static readonly ChatOptions _chatOptions;

EndToEndTests.cs (1)

22private static readonly ChatOptions _chatOptions;

RelevanceTruthAndCompletenessEvaluator.cs (1)

56private readonly ChatOptions _chatOptions =

SingleNumericMetricEvaluator.cs (1)

40private readonly ChatOptions _chatOptions =

Utilities\JsonOutputFixer.cs (1)

58ChatOptions chatOptions =

ReportingConfiguration.cs (1)

51/// the configured <see cref="IChatClient"/> and the <see cref="ChatOptions"/> that are supplied as part of

CallCountingChatClient.cs (2)

20IEnumerable<ChatMessage> messages, ChatOptions? options = null, CancellationToken cancellationToken = default) 27IEnumerable<ChatMessage> messages, ChatOptions? options = null, CancellationToken cancellationToken = default)

PromptBasedFunctionCallingChatClient.cs (2)

44IEnumerable<ChatMessage> messages, ChatOptions? options = null, CancellationToken cancellationToken = default) 139IEnumerable<ChatMessage> messages, ChatOptions? options = null, [EnumeratorCancellation] CancellationToken cancellationToken = default)

ReducingChatClientTests.cs (2)

76IEnumerable<ChatMessage> messages, ChatOptions? options = null, CancellationToken cancellationToken = default) 85IEnumerable<ChatMessage> messages, ChatOptions? options = null, [EnumeratorCancellation] CancellationToken cancellationToken = default)

test\Libraries\Microsoft.Extensions.AI.Abstractions.Tests\TestChatClient.cs (4)

20public Func<IEnumerable<ChatMessage>, ChatOptions?, CancellationToken, Task<ChatResponse>>? GetResponseAsyncCallback { get; set; } 22public Func<IEnumerable<ChatMessage>, ChatOptions?, CancellationToken, IAsyncEnumerable<ChatResponseUpdate>>? GetStreamingResponseAsyncCallback { get; set; } 29public Task<ChatResponse> GetResponseAsync(IEnumerable<ChatMessage> messages, ChatOptions? options = null, CancellationToken cancellationToken = default) 32public IAsyncEnumerable<ChatResponseUpdate> GetStreamingResponseAsync(IEnumerable<ChatMessage> messages, ChatOptions? options = null, CancellationToken cancellationToken = default)

OllamaChatClient.cs (7)

43/// The ID of the model to use. This ID can also be overridden per request via <see cref="ChatOptions.ModelId"/>. 44/// Either this parameter or <see cref="ChatOptions.ModelId"/> must provide a valid model ID. 55/// The ID of the model to use. This ID can also be overridden per request via <see cref="ChatOptions.ModelId"/>. 56/// Either this parameter or <see cref="ChatOptions.ModelId"/> must provide a valid model ID. 84IEnumerable<ChatMessage> messages, ChatOptions? options = null, CancellationToken cancellationToken = default) 120IEnumerable<ChatMessage> messages, ChatOptions? options = null, [EnumeratorCancellation] CancellationToken cancellationToken = default) 299private OllamaChatRequest ToOllamaChatRequest(IEnumerable<ChatMessage> messages, ChatOptions? options, bool stream)

OllamaEmbeddingGenerator.cs (4)

32/// The ID of the model to use. This ID can also be overridden per request via <see cref="ChatOptions.ModelId"/>. 33/// Either this parameter or <see cref="ChatOptions.ModelId"/> must provide a valid model ID. 44/// The ID of the model to use. This ID can also be overridden per request via <see cref="ChatOptions.ModelId"/>. 45/// Either this parameter or <see cref="ChatOptions.ModelId"/> must provide a valid model ID.

OllamaChatClientIntegrationTests.cs (1)

109IEnumerable<ChatMessage> messages, ChatOptions? options = null, CancellationToken cancellationToken = default)

OpenAIAssistantClient.cs (5)

39/// <summary>The thread ID to use if none is supplied in <see cref="ChatOptions.ChatThreadId"/>.</summary> 46/// The ID of the thread to use. If not supplied here, it should be supplied per request in <see cref="ChatOptions.ChatThreadId"/>. 73IEnumerable<ChatMessage> messages, ChatOptions? options = null, CancellationToken cancellationToken = default) => 78IEnumerable<ChatMessage> messages, ChatOptions? options = null, [EnumeratorCancellation] CancellationToken cancellationToken = default) 181IEnumerable<ChatMessage> messages, ChatOptions? options)

OpenAIChatClient.cs (2)

106IEnumerable<ChatMessage> messages, ChatOptions? options = null, CancellationToken cancellationToken = default) 121IEnumerable<ChatMessage> messages, ChatOptions? options = null, CancellationToken cancellationToken = default)

OpenAIClientExtensions.cs (1)

32/// The ID of the thread to use. If not supplied here, it should be supplied per request in <see cref="ChatOptions.ChatThreadId"/>.

OpenAIModelMapper.ChatCompletion.cs (4)

76public static ChatResponse FromOpenAIChatCompletion(ChatCompletion openAICompletion, ChatOptions? options, ChatCompletionOptions chatCompletionOptions) 180public static ChatOptions FromOpenAIOptions(ChatCompletionOptions? options) 182ChatOptions result = new(); 279public static ChatCompletionOptions ToOpenAIOptions(ChatOptions? options)

OpenAIModelMapper.ChatMessage.cs (1)

21ChatOptions chatOptions = FromOpenAIOptions(chatCompletionOptions);

OpenAISerializationHelpers.cs (1)

23/// Deserializes a chat completion request in the OpenAI wire format into a pair of <see cref="ChatMessage"/> and <see cref="ChatOptions"/> values.

ChatCompletion\ConfigureOptionsChatClientTests.cs (2)

35ChatOptions? providedOptions = nullProvidedOptions ? null : new() { ModelId = "test" }; 36ChatOptions? returnedOptions = null;

ChatCompletion\DistributedCachingChatClientTest.cs (1)

807if (value is ChatOptions options)

ChatCompletion\FunctionInvokingChatClientTests.cs (15)

ChatCompletion\OpenTelemetryChatClientTests.cs (2)

65IEnumerable<ChatMessage> messages, ChatOptions? options, [EnumeratorCancellation] CancellationToken cancellationToken) 118var options = new ChatOptions

ChatCompletion\UseDelegateChatClientTests.cs (6)

29ChatOptions expectedOptions = new(); 79ChatOptions expectedOptions = new(); 121ChatOptions expectedOptions = new(); 147IEnumerable<ChatMessage> messages, ChatOptions? options, IChatClient innerClient, [EnumeratorCancellation] CancellationToken cancellationToken) 172ChatOptions expectedOptions = new(); 218IEnumerable<ChatMessage> messages, ChatOptions? options, IChatClient innerClient, [EnumeratorCancellation] CancellationToken cancellationToken)

test\Libraries\Microsoft.Extensions.AI.Abstractions.Tests\TestChatClient.cs (4)

20public Func<IEnumerable<ChatMessage>, ChatOptions?, CancellationToken, Task<ChatResponse>>? GetResponseAsyncCallback { get; set; } 22public Func<IEnumerable<ChatMessage>, ChatOptions?, CancellationToken, IAsyncEnumerable<ChatResponseUpdate>>? GetStreamingResponseAsyncCallback { get; set; } 29public Task<ChatResponse> GetResponseAsync(IEnumerable<ChatMessage> messages, ChatOptions? options = null, CancellationToken cancellationToken = default) 32public IAsyncEnumerable<ChatResponseUpdate> GetStreamingResponseAsync(IEnumerable<ChatMessage> messages, ChatOptions? options = null, CancellationToken cancellationToken = default)

TestJsonSerializerContext.cs (1)

28[JsonSerializable(typeof(ChatOptions))]

CausalLMPipelineChatClient.cs (2)

36public virtual Task<ChatResponse> GetResponseAsync(IEnumerable<ChatMessage> messages, ChatOptions? options = null, CancellationToken cancellationToken = default) 60ChatOptions? options = null,

Utility\IChatTemplateBuilder.cs (1)

35string BuildPrompt(IEnumerable<ChatMessage> messages, ChatOptions? options = null, bool appendAssistantTag = true);

Llama3_1ChatTemplateBuilder.cs (1)

91public string BuildPrompt(IEnumerable<ChatMessage> messages, ChatOptions? options = null, bool appendAssistantTag = true)

Llama3CausalLMChatClient.cs (2)

29ChatOptions? options = null, 48ChatOptions? options = null,

Phi3\Phi3CausalLMChatClient.cs (2)

34ChatOptions? options = null, 53ChatOptions? options = null,

Phi3\Phi3ChatTemplateBuilder.cs (1)

92public string BuildPrompt(IEnumerable<ChatMessage> messages, ChatOptions? options = null, bool appendAssistantTag = true)