OllamaChatClient Class

Definition

Namespace:

Microsoft.Extensions.AI

Assembly:

Microsoft.Extensions.AI.Ollama.dll

Package:

Microsoft.Extensions.AI.Ollama v9.7.0-preview.1.25356.2

Source:

OllamaChatClient.cs

Represents an IChatClient for Ollama.

public ref class OllamaChatClient sealed : IDisposable, Microsoft::Extensions::AI::IChatClient

public sealed class OllamaChatClient : IDisposable, Microsoft.Extensions.AI.IChatClient

type OllamaChatClient = class
    interface IChatClient
    interface IDisposable

Public NotInheritable Class OllamaChatClient
Implements IChatClient, IDisposable

Inheritance

Object

OllamaChatClient

Implements

IChatClient IDisposable

Constructors

Name	Description
OllamaChatClient(String, String, HttpClient)	Initializes a new instance of the OllamaChatClient class.
OllamaChatClient(Uri, String, HttpClient)	Initializes a new instance of the OllamaChatClient class.

Properties

Name	Description
ToolCallJsonSerializerOptions	Gets or sets JsonSerializerOptions to use for any serialization activities related to tool call arguments and results.

Methods

Name	Description
Dispose()	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
GetResponseAsync(IEnumerable<ChatMessage>, ChatOptions, CancellationToken)	Sends chat messages and returns the response.
GetStreamingResponseAsync(IEnumerable<ChatMessage>, ChatOptions, CancellationToken)	Sends chat messages and streams the response.

Explicit Interface Implementations

Name	Description
IChatClient.GetService(Type, Object)	Asks the IChatClient for an object of the specified type serviceType.

Extension Methods

Name	Description
AsBuilder(IChatClient)	Creates a new ChatClientBuilder using innerClient as its inner client.
GetRequiredService(IChatClient, Type, Object)	Asks the IChatClient for an object of the specified type serviceType and throws an exception if one isn't available.
GetRequiredService<TService>(IChatClient, Object)	Asks the IChatClient for an object of type TService and throws an exception if one isn't available.
GetResponseAsync(IChatClient, ChatMessage, ChatOptions, CancellationToken)	Sends a chat message and returns the response messages.
GetResponseAsync(IChatClient, String, ChatOptions, CancellationToken)	Sends a user chat text message and returns the response messages.
GetResponseAsync<T>(IChatClient, ChatMessage, ChatOptions, Nullable<Boolean>, CancellationToken)	Sends a chat message, requesting a response matching the type T.
GetResponseAsync<T>(IChatClient, ChatMessage, JsonSerializerOptions, ChatOptions, Nullable<Boolean>, CancellationToken)	Sends a chat message, requesting a response matching the type T.
GetResponseAsync<T>(IChatClient, IEnumerable<ChatMessage>, ChatOptions, Nullable<Boolean>, CancellationToken)	Sends chat messages, requesting a response matching the type T.
GetResponseAsync<T>(IChatClient, IEnumerable<ChatMessage>, JsonSerializerOptions, ChatOptions, Nullable<Boolean>, CancellationToken)	Sends chat messages, requesting a response matching the type T.
GetResponseAsync<T>(IChatClient, String, ChatOptions, Nullable<Boolean>, CancellationToken)	Sends a user chat text message, requesting a response matching the type T.
GetResponseAsync<T>(IChatClient, String, JsonSerializerOptions, ChatOptions, Nullable<Boolean>, CancellationToken)	Sends a user chat text message, requesting a response matching the type T.
GetService<TService>(IChatClient, Object)	Asks the IChatClient for an object of type TService.
GetStreamingResponseAsync(IChatClient, ChatMessage, ChatOptions, CancellationToken)	Sends a chat message and streams the response messages.
GetStreamingResponseAsync(IChatClient, String, ChatOptions, CancellationToken)	Sends a user chat text message and streams the response messages.