OpenAIChatClient Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
An IChatClient for an OpenAI OpenAIClient or ChatClient.
public ref class OpenAIChatClient sealed : IDisposable, Microsoft::Extensions::AI::IChatClientpublic sealed class OpenAIChatClient : IDisposable, Microsoft.Extensions.AI.IChatClienttype OpenAIChatClient = class
interface IChatClient
interface IDisposablePublic NotInheritable Class OpenAIChatClient
Implements IChatClient, IDisposable- Inheritance
-
OpenAIChatClient
- Implements
Constructors
| OpenAIChatClient(ChatClient) |
Initializes a new instance of the OpenAIChatClient class for the specified ChatClient. |
| OpenAIChatClient(OpenAIClient, String) |
Initializes a new instance of the OpenAIChatClient class for the specified OpenAIClient. |
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. |
| 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 |
| 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) |
Explicit Interface Implementations
| IDisposable.Dispose() |
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. |
