ChatOptions

ChatCompletion\ChatClientStructuredOutputExtensions.cs (1)

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

ChatCompletion\ConfigureOptionsChatClient.cs (1)

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

ChatCompletion\ChatOptions.cs (1)

106ChatOptions options = new()

ChatCompletion\ChatClientExtensionsTests.cs (2)

52var expectedOptions = new ChatOptions(); 79var 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)

154var response = await client.CompleteAsync(chatMessages, new() 222await foreach (var update in client.CompleteStreamingAsync(chatMessages, new() 285Assert.NotNull(await client.CompleteAsync("hello", new() 333Assert.NotNull(await client.CompleteAsync("hello", new() 369Assert.NotNull(await client.CompleteAsync("hello", new() 408Assert.NotNull(await client.CompleteAsync("hello", new() 515var response = await client.CompleteAsync(messages, new() 769var response = await client.CompleteAsync("How old is Alice?", new() 857await foreach (var update in client.CompleteStreamingAsync("How old is Alice?", new()

ChatClientIntegrationTests.cs (7)

115var response = _chatClient.CompleteStreamingAsync("Explain in 10 words how AI works", new() 180var response = await chatClient.CompleteAsync(messages, new() 206var response = await chatClient.CompleteAsync("What is the result of SecretComputation on 42 and 84?", new() 222var response = chatClient.CompleteStreamingAsync("What is the result of SecretComputation on 42 and 84?", new() 250var response = await chatClient.CompleteAsync("How much older is Elsa than Anna? Return the age difference as a single number.", new() 282var response = await chatClient.CompleteAsync("Are birds real?", new() 304var response = await chatClient.CompleteAsync("What's the current secret number?", new()

OllamaChatClientIntegrationTests.cs (2)

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

OllamaChatClientTests.cs (4)

114var response = await client.CompleteAsync("hello", new() 174await foreach (var update in client.CompleteStreamingAsync("hello", new() 267var response = await client.CompleteAsync(messages, new() 367var response = await client.CompleteAsync("How old is Alice?", new()

OpenAIModelMapper.ChatCompletion.cs (1)

182ChatOptions result = new();

OpenAIChatClientTests.cs (6)

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

ChatCompletion\ConfigureOptionsChatClientTests.cs (1)

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

ChatCompletion\FunctionInvokingChatClientTests.cs (13)

ChatCompletion\OpenTelemetryChatClientTests.cs (1)

120var options = new ChatOptions

ChatCompletion\UseDelegateChatClientTests.cs (4)

37ChatOptions expectedOptions = new(); 87ChatOptions expectedOptions = new(); 129ChatOptions expectedOptions = new(); 180ChatOptions 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<ChatCompletion> TestMiddleware(IList<ChatMessage> list, ChatOptions? options, IChatClient client, CancellationToken token)

AspireOpenAIClientBuilderChatClientExtensionsTests.cs (1)

221static Task<ChatCompletion> TestMiddleware(IList<ChatMessage> list, ChatOptions? options, IChatClient client, CancellationToken token)

ChatCompletion\AnonymousDelegatingChatClient.cs (9)

20private readonly Func<IList<ChatMessage>, ChatOptions?, IChatClient, CancellationToken, Task<ChatCompletion>>? _completeFunc; 28private readonly Func<IList<ChatMessage>, ChatOptions?, IChatClient, CancellationToken, IAsyncEnumerable<StreamingChatCompletionUpdate>>? _completeStreamingFunc; 74Func<IList<ChatMessage>, ChatOptions?, IChatClient, CancellationToken, Task<ChatCompletion>>? completeFunc, 75Func<IList<ChatMessage>, ChatOptions?, IChatClient, CancellationToken, IAsyncEnumerable<StreamingChatCompletionUpdate>>? completeStreamingFunc) 86IList<ChatMessage> chatMessages, ChatOptions? options = null, CancellationToken cancellationToken = default) 94async Task<ChatCompletion> CompleteViaSharedAsync(IList<ChatMessage> chatMessages, ChatOptions? options, CancellationToken cancellationToken) 124IList<ChatMessage> chatMessages, ChatOptions? options = null, CancellationToken cancellationToken = default) 210ChatOptions? options, 211Func<IList<ChatMessage>, ChatOptions?, CancellationToken, Task> nextAsync,

ChatCompletion\CachingChatClient.cs (6)

48public override async Task<ChatCompletion> CompleteAsync(IList<ChatMessage> chatMessages, ChatOptions? options = null, CancellationToken cancellationToken = default) 68IList<ChatMessage> chatMessages, ChatOptions? options = null, [EnumeratorCancellation] CancellationToken cancellationToken = default) 135/// This is used when there is a call to <see cref="IChatClient.CompleteAsync(IList{ChatMessage}, ChatOptions?, CancellationToken)"/>. 144/// This is used when there is a call to <see cref="IChatClient.CompleteStreamingAsync(IList{ChatMessage}, ChatOptions?, CancellationToken)"/>. 153/// This is used when there is a call to <see cref="IChatClient.CompleteAsync(IList{ChatMessage}, ChatOptions?, CancellationToken)"/>. 163/// This is used when there is a call to <see cref="IChatClient.CompleteStreamingAsync(IList{ChatMessage}, ChatOptions?, CancellationToken)"/>.

ChatCompletion\ChatClientBuilder.cs (2)

132Func<IList<ChatMessage>, ChatOptions?, IChatClient, CancellationToken, Task<ChatCompletion>>? completeFunc, 133Func<IList<ChatMessage>, ChatOptions?, IChatClient, CancellationToken, IAsyncEnumerable<StreamingChatCompletionUpdate>>? completeStreamingFunc)

ChatCompletion\ChatClientStructuredOutputExtensions.cs (6)

47ChatOptions? options = null, 67ChatOptions? options = null, 87ChatOptions? options = null, 109ChatOptions? options = null, 131ChatOptions? options = null, 157ChatOptions? 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) 37public override async Task<ChatCompletion> CompleteAsync(IList<ChatMessage> chatMessages, ChatOptions? options = null, CancellationToken cancellationToken = default) 44IList<ChatMessage> chatMessages, ChatOptions? options = null, [EnumeratorCancellation] CancellationToken cancellationToken = default) 52/// <summary>Creates and configures the <see cref="ChatOptions"/> to pass along to the inner client.</summary> 53private 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"/>) 29this ChatClientBuilder builder, Action<ChatOptions> configure)

ChatCompletion\FunctionInvokingChatClient.cs (9)

20/// A delegating chat client that invokes functions defined on <see cref="ChatOptions"/>. 26/// by calling the corresponding <see cref="AIFunction"/> defined in <see cref="ChatOptions"/>, 31/// <see cref="AIFunction"/> instances employed as part of the supplied <see cref="ChatOptions"/> are also safe. 36/// ASP.NET web request should only be used as part of a single <see cref="ChatOptions"/> at a time, and only with 212public override async Task<ChatCompletion> CompleteAsync(IList<ChatMessage> chatMessages, ChatOptions? options = null, CancellationToken cancellationToken = default) 326IList<ChatMessage> chatMessages, ChatOptions? options = null, [EnumeratorCancellation] CancellationToken cancellationToken = default) 437private static bool UpdateOptionsForMode(ContinueMode mode, ref ChatOptions options, string? chatThreadId) 494IList<ChatMessage> chatMessages, ChatOptions options, IReadOnlyList<FunctionCallContent> functionCallContents, int iteration, CancellationToken cancellationToken) 554IList<ChatMessage> chatMessages, ChatOptions options, FunctionCallContent functionCallContent,

ChatCompletion\LoggingChatClient.cs (2)

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

ChatCompletion\OpenTelemetryChatClient.cs (3)

124public override async Task<ChatCompletion> CompleteAsync(IList<ChatMessage> chatMessages, ChatOptions? options = null, CancellationToken cancellationToken = default) 155IList<ChatMessage> chatMessages, ChatOptions? options = null, [EnumeratorCancellation] CancellationToken cancellationToken = default) 214private Activity? CreateAndConfigureActivity(ChatOptions? options)

ChatCompletion\ChatClientExtensions.cs (4)

39ChatOptions? options = null, 57ChatOptions? options = null, 75ChatOptions? options = null, 93ChatOptions? options = null,

ChatCompletion\ChatClientMetadata.cs (1)

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

ChatCompletion\ChatCompletion.cs (1)

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

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\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)

41public virtual Task<ChatCompletion> CompleteAsync(IList<ChatMessage> chatMessages, ChatOptions? options = null, CancellationToken cancellationToken = default) 47public virtual IAsyncEnumerable<StreamingChatCompletionUpdate> CompleteStreamingAsync(IList<ChatMessage> chatMessages, ChatOptions? options = null, CancellationToken cancellationToken = default)

ChatCompletion\IChatClient.cs (2)

39ChatOptions? options = null, 53ChatOptions? options = null,

ChatCompletion\StreamingChatCompletionUpdate.cs (1)

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

Utilities\AIJsonUtilities.Defaults.cs (1)

81[JsonSerializable(typeof(ChatOptions))]

ChatCompletion\ChatClientExtensionsTests.cs (2)

52var expectedOptions = new ChatOptions(); 79var 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<IList<ChatMessage>, ChatOptions?, CancellationToken, Task<ChatCompletion>>? CompleteAsyncCallback { get; set; } 22public Func<IList<ChatMessage>, ChatOptions?, CancellationToken, IAsyncEnumerable<StreamingChatCompletionUpdate>>? CompleteStreamingAsyncCallback { get; set; } 29public Task<ChatCompletion> CompleteAsync(IList<ChatMessage> chatMessages, ChatOptions? options = null, CancellationToken cancellationToken = default) 32public IAsyncEnumerable<StreamingChatCompletionUpdate> CompleteStreamingAsync(IList<ChatMessage> chatMessages, ChatOptions? options = null, CancellationToken cancellationToken = default)

TestJsonSerializerContext.cs (1)

19[JsonSerializable(typeof(ChatOptions))]

AzureAIInferenceChatClient.cs (4)

38/// <param name="modelId">The ID of the model to use. If null, it can be provided per request via <see cref="ChatOptions.ModelId"/>.</param> 81IList<ChatMessage> chatMessages, ChatOptions? options = null, CancellationToken cancellationToken = default) 146IList<ChatMessage> chatMessages, ChatOptions? options = null, [EnumeratorCancellation] CancellationToken cancellationToken = default) 288private ChatCompletionsOptions ToAzureAIOptions(IList<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>

CallCountingChatClient.cs (2)

20IList<ChatMessage> chatMessages, ChatOptions? options = null, CancellationToken cancellationToken = default) 27IList<ChatMessage> chatMessages, ChatOptions? options = null, CancellationToken cancellationToken = default)

PromptBasedFunctionCallingChatClient.cs (1)

40public override async Task<ChatCompletion> CompleteAsync(IList<ChatMessage> chatMessages, ChatOptions? options = null, CancellationToken cancellationToken = default)

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

20public Func<IList<ChatMessage>, ChatOptions?, CancellationToken, Task<ChatCompletion>>? CompleteAsyncCallback { get; set; } 22public Func<IList<ChatMessage>, ChatOptions?, CancellationToken, IAsyncEnumerable<StreamingChatCompletionUpdate>>? CompleteStreamingAsyncCallback { get; set; } 29public Task<ChatCompletion> CompleteAsync(IList<ChatMessage> chatMessages, ChatOptions? options = null, CancellationToken cancellationToken = default) 32public IAsyncEnumerable<StreamingChatCompletionUpdate> CompleteStreamingAsync(IList<ChatMessage> chatMessages, 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. 81public async Task<ChatCompletion> CompleteAsync(IList<ChatMessage> chatMessages, ChatOptions? options = null, CancellationToken cancellationToken = default) 117IList<ChatMessage> chatMessages, ChatOptions? options = null, [EnumeratorCancellation] CancellationToken cancellationToken = default) 293private OllamaChatRequest ToOllamaChatRequest(IList<ChatMessage> chatMessages, 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)

111IList<ChatMessage> chatMessages, 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"/>. 73IList<ChatMessage> chatMessages, ChatOptions? options = null, CancellationToken cancellationToken = default) => 78IList<ChatMessage> chatMessages, ChatOptions? options = null, [EnumeratorCancellation] CancellationToken cancellationToken = default) 179private static (RunCreationOptions RunOptions, List<FunctionResultContent>? ToolResults) CreateRunOptions(IList<ChatMessage> chatMessages, ChatOptions? options)

OpenAIChatClient.cs (2)

103IList<ChatMessage> chatMessages, ChatOptions? options = null, CancellationToken cancellationToken = default) 118IList<ChatMessage> chatMessages, 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 ChatCompletion FromOpenAIChatCompletion(OpenAI.Chat.ChatCompletion openAICompletion, ChatOptions? options, ChatCompletionOptions chatCompletionOptions) 180public static ChatOptions FromOpenAIOptions(ChatCompletionOptions? options) 182ChatOptions result = new(); 277public 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\FunctionInvokingChatClientTests.cs (16)

ChatCompletion\LoggingChatClientTests.cs (1)

70new ChatOptions { FrequencyPenalty = 3.0f });

ChatCompletion\OpenTelemetryChatClientTests.cs (2)

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

ChatCompletion\UseDelegateChatClientTests.cs (6)

37ChatOptions expectedOptions = new(); 87ChatOptions expectedOptions = new(); 129ChatOptions expectedOptions = new(); 155IList<ChatMessage> chatMessages, ChatOptions? options, IChatClient innerClient, [EnumeratorCancellation] CancellationToken cancellationToken) 180ChatOptions expectedOptions = new(); 226IList<ChatMessage> chatMessages, ChatOptions? options, IChatClient innerClient, [EnumeratorCancellation] CancellationToken cancellationToken)

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

20public Func<IList<ChatMessage>, ChatOptions?, CancellationToken, Task<ChatCompletion>>? CompleteAsyncCallback { get; set; } 22public Func<IList<ChatMessage>, ChatOptions?, CancellationToken, IAsyncEnumerable<StreamingChatCompletionUpdate>>? CompleteStreamingAsyncCallback { get; set; } 29public Task<ChatCompletion> CompleteAsync(IList<ChatMessage> chatMessages, ChatOptions? options = null, CancellationToken cancellationToken = default) 32public IAsyncEnumerable<StreamingChatCompletionUpdate> CompleteStreamingAsync(IList<ChatMessage> chatMessages, ChatOptions? options = null, CancellationToken cancellationToken = default)

TestJsonSerializerContext.cs (1)

28[JsonSerializable(typeof(ChatOptions))]

CausalLMPipelineChatClient.cs (2)

37public virtual Task<ChatCompletion> CompleteAsync(IList<ChatMessage> chatMessages, ChatOptions? options = null, CancellationToken cancellationToken = default) 60ChatOptions? options = null,

Utility\IChatTemplateBuilder.cs (1)

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

Llama3_1ChatTemplateBuilder.cs (1)

91public string BuildPrompt(IList<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(IList<ChatMessage> messages, ChatOptions? options = null, bool appendAssistantTag = true)