Compartir a través de

ChatToolMode Class

  • Reference

Definition

Namespace:
Microsoft.Extensions.AI
Assembly:
Microsoft.Extensions.AI.Abstractions.dll
Package:
Microsoft.Extensions.AI.Abstractions v9.3.0-preview.1.25114.11
Source:
ChatToolMode.cs

Describes how tools should be selected by a IChatClient.

public ref class ChatToolMode
[System.Text.Json.Serialization.JsonDerivedType(typeof(Microsoft.Extensions.AI.NoneChatToolMode), "none")]
[System.Text.Json.Serialization.JsonDerivedType(typeof(Microsoft.Extensions.AI.AutoChatToolMode), "auto")]
[System.Text.Json.Serialization.JsonDerivedType(typeof(Microsoft.Extensions.AI.RequiredChatToolMode), "required")]
[System.Text.Json.Serialization.JsonPolymorphic(TypeDiscriminatorPropertyName="$type")]
public class ChatToolMode
[<System.Text.Json.Serialization.JsonDerivedType(typeof(Microsoft.Extensions.AI.NoneChatToolMode), "none")>]
[<System.Text.Json.Serialization.JsonDerivedType(typeof(Microsoft.Extensions.AI.AutoChatToolMode), "auto")>]
[<System.Text.Json.Serialization.JsonDerivedType(typeof(Microsoft.Extensions.AI.RequiredChatToolMode), "required")>]
[<System.Text.Json.Serialization.JsonPolymorphic(TypeDiscriminatorPropertyName="$type")>]
type ChatToolMode = class
Public Class ChatToolMode
Inheritance
Object
ChatToolMode
Derived
Attributes
JsonDerivedTypeAttribute JsonPolymorphicAttribute

Remarks

The predefined values Auto, None, and RequireAny are provided. To nominate a specific function, use RequireSpecific(String).

Properties

Auto

Gets a predefined ChatToolMode indicating that tool usage is optional.
None

Gets a predefined ChatToolMode indicating that tool usage is unsupported.
RequireAny

Gets a predefined ChatToolMode indicating that tool usage is required, but that any tool can be selected. At least one tool must be provided in Tools.

Methods

RequireSpecific(String)

Instantiates a ChatToolMode indicating that tool usage is required, and that the specified AIFunction must be selected. The function name must match an entry in Tools.

Applies to