FunctionInvokingChatClient Class

Definition

public ref class FunctionInvokingChatClient : Microsoft::Extensions::AI::DelegatingChatClient

public class FunctionInvokingChatClient : Microsoft.Extensions.AI.DelegatingChatClient

type FunctionInvokingChatClient = class
    inherit DelegatingChatClient

Public Class FunctionInvokingChatClient
Inherits DelegatingChatClient

Inheritance

Object

DelegatingChatClient

FunctionInvokingChatClient

Remarks

When this client receives a FunctionCallContent in a chat response from its inner IChatClient, it responds by invoking the corresponding AIFunction defined in Tools (or in AdditionalTools), producing a FunctionResultContent that it sends back to the inner client. This loop is repeated until there are no more function calls to make, or until another stop condition is met, such as hitting MaximumIterationsPerRequest.

If a requested function is an AIFunctionDeclaration but not an AIFunction, the FunctionInvokingChatClient will not attempt to invoke it, and instead allow that FunctionCallContent to pass back out to the caller. It is then that caller's responsibility to create the appropriate FunctionResultContent for that call and send it back as part of a subsequent request.

Further, if a requested function is an ApprovalRequiredAIFunction, the FunctionInvokingChatClient will not attempt to invoke it directly. Instead, it will replace that FunctionCallContent with a FunctionApprovalRequestContent that wraps the FunctionCallContent and indicates that the function requires approval before it can be invoked. The caller is then responsible for responding to that approval request by sending a corresponding FunctionApprovalResponseContent in a subsequent request. The FunctionInvokingChatClient will then process that approval response and invoke the function as appropriate.

Due to the nature of interactions with an underlying IChatClient, if any FunctionCallContent is received for a function that requires approval, all received FunctionCallContent in that same response will also require approval, even if they were not ApprovalRequiredAIFunction instances. If this is a concern, consider requesting that multiple tool call requests not be made in a single response, by setting AllowMultipleToolCalls to false.

A FunctionInvokingChatClient instance is thread-safe for concurrent use so long as the AIFunction instances employed as part of the supplied ChatOptions are also safe. The AllowConcurrentInvocation property can be used to control whether multiple function invocation requests as part of the same request are invocable concurrently, but even with that set to false (the default), multiple concurrent requests to this same instance and using the same tools could result in those tools being used concurrently (one per request). For example, a function that accesses the HttpContext of a specific ASP.NET web request should only be used as part of a single ChatOptions at a time, and only with AllowConcurrentInvocation set to false, in case the inner client decided to issue multiple invocation requests to that same function.