通过

FunctionInvokingRealtimeClient 类

定义

命名空间:
Microsoft.Extensions.AI
程序集:
Microsoft.Extensions.AI.dll
包:
Microsoft.Extensions.AI v10.4.1
Source:
FunctionInvokingRealtimeClient.cs

委托的实时客户端，用于调用定义的 CreateResponseRealtimeClientMessage函数。 在实时客户端管道中包含此功能，以自动解析函数调用。

public ref class FunctionInvokingRealtimeClient sealed : Microsoft::Extensions::AI::DelegatingRealtimeClient
[System.Diagnostics.CodeAnalysis.Experimental("MEAI001", UrlFormat="https://aka.ms/dotnet-extensions-warnings/{0}")]
public sealed class FunctionInvokingRealtimeClient : Microsoft.Extensions.AI.DelegatingRealtimeClient
public sealed class FunctionInvokingRealtimeClient : Microsoft.Extensions.AI.DelegatingRealtimeClient
[<System.Diagnostics.CodeAnalysis.Experimental("MEAI001", UrlFormat="https://aka.ms/dotnet-extensions-warnings/{0}")>]
type FunctionInvokingRealtimeClient = class
    inherit DelegatingRealtimeClient
type FunctionInvokingRealtimeClient = class
    inherit DelegatingRealtimeClient
Public NotInheritable Class FunctionInvokingRealtimeClient
Inherits DelegatingRealtimeClient
继承
Object
DelegatingRealtimeClient
FunctionInvokingRealtimeClient
属性
ExperimentalAttribute

注解

当此客户端创建的会话从内部IRealtimeClientSession接收FunctionCallContent实时服务器消息时，它们通过调用 （或 inAdditionalTools） 中Tools定义的相应AIFunction消息来响应，从而生成一个FunctionResultContent发送回内部会话的会话。 此循环重复，直到没有更多的函数调用进行，或直到满足另一个停止条件，如命中 MaximumIterationsPerRequest。

构造函数

名称 说明
FunctionInvokingRealtimeClient(IRealtimeClient, ILoggerFactory, IServiceProvider)

初始化 FunctionInvokingRealtimeClient 类的新实例。

属性

名称 说明
AdditionalTools

获取或设置会话能够调用的其他工具的集合。
AllowConcurrentInvocation

获取或设置一个值，该值指示是否允许并发调用函数。
CurrentContext

获取当前函数调用的函数 FunctionInvocationContext 。
FunctionInvoker

获取或设置用于调用 AIFunction 实例的委托。
IncludeDetailedErrors

获取或设置一个值，该值指示在调用基础 IRealtimeClientSession时响应中是否应包含详细的异常信息。
InnerClient

获取内部 IRealtimeClient。

(继承自 DelegatingRealtimeClient)
MaximumConsecutiveErrorsPerRequest

获取或设置允许失败且出现错误的连续迭代的最大次数。
MaximumIterationsPerRequest

获取或设置每个请求的最大迭代数。
TerminateOnUnknownCalls

获取或设置一个值，该值指示调用未知函数的请求是否应终止函数调用循环。

方法

名称 说明
CreateSessionAsync(RealtimeSessionOptions, CancellationToken)

使用指定的选项创建新的实时会话。
Dispose()

执行与释放、释放或重置非托管资源关联的应用程序定义任务。

(继承自 DelegatingRealtimeClient)
Dispose(Boolean)

提供用于释放非托管资源的机制。

(继承自 DelegatingRealtimeClient)
GetService(Type, Object)

IRealtimeClient请求指定类型的serviceType对象。

(继承自 DelegatingRealtimeClient)

扩展方法

名称 说明
AsBuilder(IRealtimeClient)

创建一个新的 RealtimeClientBuilder 使用 innerClient 作为其内部客户端。
GetRequiredService(IRealtimeClient, Type, Object)

IRealtimeClient请求指定类型的serviceType对象，如果一个对象不可用，则会引发异常。
GetRequiredService<TService>(IRealtimeClient, Object)

IRealtimeClient询问类型的TService对象，如果对象不可用，则会引发异常。
GetService<TService>(IRealtimeClient, Object)

IRealtimeClient请求类型的对象TService。

适用于