OpenAIClientExtensions.AsIChatClient Method
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.
Overloads
| Name | Description |
|---|---|
| AsIChatClient(ChatClient) |
Gets an IChatClient for use with this ChatClient. |
| AsIChatClient(ResponsesClient, String) |
Gets an IChatClient for use with this ResponsesClient. |
| AsIChatClient(AssistantClient, Assistant, String) |
Gets an IChatClient for use with this AssistantClient. |
| AsIChatClient(AssistantClient, String, String) |
Gets an IChatClient for use with this AssistantClient. |
AsIChatClient(ChatClient)
- Source:
- OpenAIClientExtensions.cs
Gets an IChatClient for use with this ChatClient.
public:
[System::Runtime::CompilerServices::Extension]
static Microsoft::Extensions::AI::IChatClient ^ AsIChatClient(OpenAI::Chat::ChatClient ^ chatClient);public static Microsoft.Extensions.AI.IChatClient AsIChatClient(this OpenAI.Chat.ChatClient chatClient);static member AsIChatClient : OpenAI.Chat.ChatClient -> Microsoft.Extensions.AI.IChatClient<Extension()>
Public Function AsIChatClient (chatClient As ChatClient) As IChatClientParameters
- chatClient
- ChatClient
The client.
Returns
An IChatClient that can be used to converse via the ChatClient.
Exceptions
chatClient is null.
Applies to
AsIChatClient(ResponsesClient, String)
- Source:
- OpenAIClientExtensions.cs
Gets an IChatClient for use with this ResponsesClient.
[System.Diagnostics.CodeAnalysis.Experimental("OPENAI001")]
public static Microsoft.Extensions.AI.IChatClient AsIChatClient(this OpenAI.Responses.ResponsesClient responseClient, string? defaultModelId = default);public static Microsoft.Extensions.AI.IChatClient AsIChatClient(this OpenAI.Responses.ResponsesClient responseClient, string? defaultModelId = default);[<System.Diagnostics.CodeAnalysis.Experimental("OPENAI001")>]
static member AsIChatClient : OpenAI.Responses.ResponsesClient * string -> Microsoft.Extensions.AI.IChatClientstatic member AsIChatClient : OpenAI.Responses.ResponsesClient * string -> Microsoft.Extensions.AI.IChatClient<Extension()>
Public Function AsIChatClient (responseClient As ResponsesClient, Optional defaultModelId As String = Nothing) As IChatClientParameters
- responseClient
- ResponsesClient
The client.
- defaultModelId
- String
The default model ID to use for the chat client.
Returns
An IChatClient that can be used to converse via the ResponsesClient.
- Attributes
Exceptions
responseClient is null.
Applies to
AsIChatClient(AssistantClient, Assistant, String)
- Source:
- OpenAIClientExtensions.cs
Gets an IChatClient for use with this AssistantClient.
[System.Diagnostics.CodeAnalysis.Experimental("OPENAI001")]
public static Microsoft.Extensions.AI.IChatClient AsIChatClient(this OpenAI.Assistants.AssistantClient assistantClient, OpenAI.Assistants.Assistant assistant, string? threadId = default);public static Microsoft.Extensions.AI.IChatClient AsIChatClient(this OpenAI.Assistants.AssistantClient assistantClient, OpenAI.Assistants.Assistant assistant, string? threadId = default);[<System.Diagnostics.CodeAnalysis.Experimental("OPENAI001")>]
static member AsIChatClient : OpenAI.Assistants.AssistantClient * OpenAI.Assistants.Assistant * string -> Microsoft.Extensions.AI.IChatClientstatic member AsIChatClient : OpenAI.Assistants.AssistantClient * OpenAI.Assistants.Assistant * string -> Microsoft.Extensions.AI.IChatClient<Extension()>
Public Function AsIChatClient (assistantClient As AssistantClient, assistant As Assistant, Optional threadId As String = Nothing) As IChatClientParameters
- assistantClient
- AssistantClient
The AssistantClient instance to be accessed as an IChatClient.
- threadId
- String
An optional existing thread identifier for the chat session. This serves as a default, and may be overridden per call to GetResponseAsync(IEnumerable<ChatMessage>, ChatOptions, CancellationToken) or GetStreamingResponseAsync(IEnumerable<ChatMessage>, ChatOptions, CancellationToken) via the ConversationId property. If no thread ID is provided via either mechanism, a new thread will be created for the request.
Returns
An IChatClient instance configured to interact with the specified agent and thread.
- Attributes
Exceptions
assistant is null.
Applies to
AsIChatClient(AssistantClient, String, String)
- Source:
- OpenAIClientExtensions.cs
Gets an IChatClient for use with this AssistantClient.
[System.Diagnostics.CodeAnalysis.Experimental("OPENAI001")]
public static Microsoft.Extensions.AI.IChatClient AsIChatClient(this OpenAI.Assistants.AssistantClient assistantClient, string assistantId, string? threadId = default);public static Microsoft.Extensions.AI.IChatClient AsIChatClient(this OpenAI.Assistants.AssistantClient assistantClient, string assistantId, string? threadId = default);[<System.Diagnostics.CodeAnalysis.Experimental("OPENAI001")>]
static member AsIChatClient : OpenAI.Assistants.AssistantClient * string * string -> Microsoft.Extensions.AI.IChatClientstatic member AsIChatClient : OpenAI.Assistants.AssistantClient * string * string -> Microsoft.Extensions.AI.IChatClient<Extension()>
Public Function AsIChatClient (assistantClient As AssistantClient, assistantId As String, Optional threadId As String = Nothing) As IChatClientParameters
- assistantClient
- AssistantClient
The AssistantClient instance to be accessed as an IChatClient.
- assistantId
- String
The unique identifier of the assistant with which to interact.
- threadId
- String
An optional existing thread identifier for the chat session. This serves as a default, and may be overridden per call to GetResponseAsync(IEnumerable<ChatMessage>, ChatOptions, CancellationToken) or GetStreamingResponseAsync(IEnumerable<ChatMessage>, ChatOptions, CancellationToken) via the ConversationId property. If no thread ID is provided via either mechanism, a new thread will be created for the request.
Returns
An IChatClient instance configured to interact with the specified agent and thread.
- Attributes
Exceptions
assistantId is null.
assistantId is empty or composed entirely of whitespace.
