Share via


ChatOptions.AllowMultipleToolCalls Property

Definition

Gets or sets a flag to indicate whether a single response is allowed to include multiple tool calls. If false, the IChatClient is asked to return a maximum of one tool call per request. If true, there is no limit. If null, the provider may select its own default.

public:
 property Nullable<bool> AllowMultipleToolCalls { Nullable<bool> get(); void set(Nullable<bool> value); };
public bool? AllowMultipleToolCalls { get; set; }
member this.AllowMultipleToolCalls : Nullable<bool> with get, set
Public Property AllowMultipleToolCalls As Nullable(Of Boolean)

Property Value

Remarks

When used with function calling middleware, this does not affect the ability to perform multiple function calls in sequence. It only affects the number of function calls within a single iteration of the function calling loop.

The underlying provider is not guaranteed to support or honor this flag. For example it may choose to ignore it and return multiple tool calls regardless.

Applies to