OllamaChatClient Class

Definition

Namespace:

Microsoft.Extensions.AI

Assembly:

Microsoft.Extensions.AI.Ollama.dll

Package:

Microsoft.Extensions.AI.Ollama v9.0.0-preview.9.24556.5

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

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

Metadata	Gets metadata that describes the IChatClient.
ToolCallJsonSerializerOptions	Gets or sets JsonSerializerOptions to use for any serialization activities related to tool call arguments and results.

Methods

CompleteAsync(IList<ChatMessage>, ChatOptions, CancellationToken)	Sends chat messages to the model and returns the response messages.
CompleteStreamingAsync(IList<ChatMessage>, ChatOptions, CancellationToken)	Sends chat messages to the model and streams the response messages.
Dispose()	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetService<TService>(Object)	Asks the IChatClient for an object of type TService.
GetType()	Gets the Type of the current instance. (Inherited from Object)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
ToString()	Returns a string that represents the current object. (Inherited from Object)

Extension Methods

CompleteAsync(IChatClient, String, ChatOptions, CancellationToken)	Sends a user chat text message to the model and returns the response messages.
CompleteStreamingAsync(IChatClient, String, ChatOptions, CancellationToken)	Sends a user chat text message to the model and streams the response messages.
CompleteAsync<T>(IChatClient, IList<ChatMessage>, ChatOptions, Nullable<Boolean>, CancellationToken)	Sends chat messages to the model, requesting a response matching the type T.
CompleteAsync<T>(IChatClient, IList<ChatMessage>, JsonSerializerOptions, ChatOptions, Nullable<Boolean>, CancellationToken)	Sends chat messages to the model, requesting a response matching the type T.
CompleteAsync<T>(IChatClient, String, ChatOptions, Nullable<Boolean>, CancellationToken)	Sends a user chat text message to the model, requesting a response matching the type T.
CompleteAsync<T>(IChatClient, String, JsonSerializerOptions, ChatOptions, Nullable<Boolean>, CancellationToken)	Sends a user chat text message to the model, requesting a response matching the type T.