FailoverChatClient 类

定义

命名空间:

Microsoft.Extensions.AI

程序集:

Microsoft.Extensions.AI.dll

包:

Microsoft.Extensions.AI v10.9.0

Source:

FailoverChatClient.cs

为一个模板提供一个 RoutingChatClient 模板，该模板可在调用失败后选择另一个客户端。

public ref class FailoverChatClient abstract : Microsoft::Extensions::AI::RoutingChatClient

[System.Diagnostics.CodeAnalysis.Experimental("MEAI001", UrlFormat="https://aka.ms/dotnet-extensions-warnings/{0}")]
public abstract class FailoverChatClient : Microsoft.Extensions.AI.RoutingChatClient

[<System.Diagnostics.CodeAnalysis.Experimental("MEAI001", UrlFormat="https://aka.ms/dotnet-extensions-warnings/{0}")>]
type FailoverChatClient = class
    inherit RoutingChatClient

Public MustInherit Class FailoverChatClient
Inherits RoutingChatClient

继承

Object

RoutingChatClient

FailoverChatClient

派生

Microsoft.Extensions.AI.OrderedFailoverChatClient

属性

ExperimentalAttribute

注解

每个尝试的客户端都由 SelectClientAsync(RoutingContext, CancellationToken). 调用后， OnRoutingUpdateAsync(RoutingContext, FailoverChatClientAttempt, Boolean, CancellationToken) 报告具体尝试以及是否将遵循另一个选择。 未建立的失败只会在公开任何流输出之前进行另一个选择，并且尝试限制允许它。

基类拥有调用、流式处理承诺、尝试限制和尝试报告。 派生类拥有客户端选择、策略状态、选择失败清理以及它们保留的客户端的生存期。

流式枚举开始后，调用方必须释放枚举器。 放弃活动枚举器而不释放它可防止内部枚举器处置和终端路由更新。

构造函数

名称	说明
FailoverChatClient()	为一个模板提供一个 RoutingChatClient 模板，该模板可在调用失败后选择另一个客户端。

属性

名称	说明
MaximumAttemptsPerRequest	获取或设置一个请求允许的最大客户端调用数。

方法

名称	说明
Dispose()	执行与释放、释放或重置非托管资源关联的应用程序定义任务。 (继承自 RoutingChatClient)
Dispose(Boolean)	提供一种机制，用于释放派生实例拥有的资源。 (继承自 RoutingChatClient)
GetResponseAsync(IEnumerable<ChatMessage>, ChatOptions, CancellationToken)	为一个模板提供一个 RoutingChatClient 模板，该模板可在调用失败后选择另一个客户端。
GetService(Type, Object)	IChatClient请求指定类型的serviceType对象。 (继承自 RoutingChatClient)
GetStreamingResponseAsync(IEnumerable<ChatMessage>, ChatOptions, CancellationToken)	为一个模板提供一个 RoutingChatClient 模板，该模板可在调用失败后选择另一个客户端。
OnRoutingUpdateAsync(RoutingContext, FailoverChatClientAttempt, Boolean, CancellationToken)	在客户端调用完成后调用、失败或被放弃后调用。
SelectClientAsync(RoutingContext, CancellationToken)	选择要为请求调用的客户端。 (继承自 RoutingChatClient)

扩展方法

名称	说明
AsBuilder(IChatClient)	创建一个新的 ChatClientBuilder 使用 innerClient 作为其内部客户端。
GetRequiredService(IChatClient, Type, Object)	IChatClient请求指定类型的serviceType对象，如果一个对象不可用，则会引发异常。
GetRequiredService<TService>(IChatClient, Object)	IChatClient询问类型的TService对象，如果对象不可用，则会引发异常。
GetResponseAsync(IChatClient, ChatMessage, ChatOptions, CancellationToken)	发送聊天消息并返回响应消息。
GetResponseAsync(IChatClient, String, ChatOptions, CancellationToken)	发送用户聊天短信并返回响应消息。
GetResponseAsync<T>(IChatClient, ChatMessage, ChatOptions, Nullable<Boolean>, CancellationToken)	发送聊天消息，请求与类型 T匹配的响应。
GetResponseAsync<T>(IChatClient, ChatMessage, JsonSerializerOptions, ChatOptions, Nullable<Boolean>, CancellationToken)	发送聊天消息，请求与类型 T匹配的响应。
GetResponseAsync<T>(IChatClient, IEnumerable<ChatMessage>, ChatOptions, Nullable<Boolean>, CancellationToken)	发送聊天消息，请求与类型 T匹配的响应。
GetResponseAsync<T>(IChatClient, IEnumerable<ChatMessage>, JsonSerializerOptions, ChatOptions, Nullable<Boolean>, CancellationToken)	发送聊天消息，请求与类型 T匹配的响应。
GetResponseAsync<T>(IChatClient, String, ChatOptions, Nullable<Boolean>, CancellationToken)	发送用户聊天短信，请求与类型 T匹配的响应。
GetResponseAsync<T>(IChatClient, String, JsonSerializerOptions, ChatOptions, Nullable<Boolean>, CancellationToken)	发送用户聊天短信，请求与类型 T匹配的响应。
GetService<TService>(IChatClient, Object)	IChatClient请求类型的对象TService。
GetStreamingResponseAsync(IChatClient, ChatMessage, ChatOptions, CancellationToken)	发送聊天消息并流式传输响应消息。
GetStreamingResponseAsync(IChatClient, String, ChatOptions, CancellationToken)	发送用户聊天短信并流式传输响应消息。