API Reference
Class
ToolDefinition
Defines a tool that can be invoked by the model.
Inheritance
- Object
- ToolDefinition
Usage
Explore 29 API references to this type
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by 10
- Property ChatOptions.Tools
- Property EasyChatOptions.Tools
- Property ITool.Definition
- Method ToolCapabilityParityRuntime.GetDefinitionsByPackId
- Property ToolCapabilityParitySliceDescriptor.Evaluate
- Method ToolDefinition.CreateAliasDefinition
- Method ToolExplicitSelectionMetadata.Apply
- Method ToolRegistry.GetDefinitions
- Method ToolSelectionHintTags.ApplyExplicitRoutingHints
- Method ToolSelectionMetadata.Enrich
Accepted by parameters 19
- Method ToolCapabilityParityRuntime.DiscoverSurfacedAdMonitoringProbeKinds
- Method ToolCapabilityParityRuntime.EvaluateAvailableExpectations
- Method ToolCapabilityParityRuntime.EvaluateAvailableExpectations
- Method ToolCapabilityParityRuntime.EvaluateExpectationSlice
- Method ToolCapabilityParityRuntime.EvaluateExpectationSlice
- Method ToolCapabilityParityRuntime.GetDefinitionsByPackId
- Method ToolExecutionTraitProjection.Project
- Method ToolExplicitSelectionMetadata.Apply
- Method ToolRegistry.TryGetDefinition
- Method ToolSelectionHintTags.ApplyExplicitRoutingHints
- Method ToolSelectionMetadata.Enrich
- Method ToolSelectionMetadata.GetDomainSignalTokens
- Method ToolSelectionMetadata.GetFallbackHintKeys
- Method ToolSelectionMetadata.GetFallbackSelectionKeys
- Method ToolSelectionMetadata.RequiresSelectionForFallback
- Method ToolSelectionMetadata.ResolveRouting
- Method ToolSelectionMetadata.TryResolveDomainIntentActionId
- Method ToolSelectionMetadata.TryResolveDomainIntentFamily
- Method ToolSelectionMetadata.TryResolvePackId
Constructors
public ToolDefinition(String name, String? description = null, JsonObject? parameters = null, String? displayName = null, String? category = null, IReadOnlyList<String>? tags = null, ToolWriteGovernanceContract? writeGovernance = null, IReadOnlyList<ToolAliasDefinition>? aliases = null, String? aliasOf = null, ToolAuthenticationContract? authentication = null, ToolRoutingContract? routing = null, ToolSetupContract? setup = null, ToolHandoffContract? handoff = null, ToolRecoveryContract? recovery = null, ToolExecutionContract? execution = null) #Initializes a new tool definition.
Parameters
- name System.String
- Tool name.
- description System.String? = null
- Tool description.
- parameters IntelligenceX.Json.JsonObject? = null
- JSON schema for tool parameters.
- displayName System.String? = null
- Optional human-friendly tool display name.
- category System.String? = null
- Optional tool category label.
- tags System.Collections.Generic.IReadOnlyList<System.String>? = null
- Optional tags used for model/tooling guidance.
- writeGovernance IntelligenceX.Tools.ToolWriteGovernanceContract? = null
- Optional write-governance contract for mutating tools.
- aliases System.Collections.Generic.IReadOnlyList<IntelligenceX.Tools.ToolAliasDefinition>? = null
- Optional aliases that should invoke the same tool implementation.
- aliasOf System.String? = null
- Optional canonical tool name when this definition is an alias.
- authentication IntelligenceX.Tools.ToolAuthenticationContract? = null
- Optional authentication contract for tools that require/declare auth behavior.
- routing IntelligenceX.Tools.ToolRoutingContract? = null
- Optional routing contract for host-side orchestration.
- setup IntelligenceX.Tools.ToolSetupContract? = null
- Optional setup contract for prerequisites and setup hints.
- handoff IntelligenceX.Tools.ToolHandoffContract? = null
- Optional handoff contract for cross-pack argument mappings.
- recovery IntelligenceX.Tools.ToolRecoveryContract? = null
- Optional recovery contract for tool-owned resilience behavior.
- execution IntelligenceX.Tools.ToolExecutionContract? = null
- Optional execution contract for local/remote capability and scope metadata.
Methods
public ToolDefinition CreateAliasDefinition(String aliasName, String? description = null, IReadOnlyList<String>? tags = null) #Returns:
ToolDefinitionCreates an alias definition derived from the current canonical definition.
Parameters
- aliasName System.String
- Alias tool name.
- description System.String? = null
- Optional alias-specific description override.
- tags System.Collections.Generic.IReadOnlyList<System.String>? = null
- Optional alias tags merged with canonical tags.
public String? GetDescriptionWithTags() #Returns:
String?Returns description text augmented with tag hints.
Inherited Methods
public virtual Boolean Equals(Object? obj) #Returns:
BooleanInherited from Object
Parameters
- obj Object?
Properties
public JsonObject? Parameters { get; } #Gets the JSON schema for tool parameters.
public IReadOnlyList<String> Tags { get; } #Gets optional tags associated with this tool definition. Tags are normalized to distinct deterministic ordering (ordinal-ignore-case).
public IReadOnlyList<ToolAliasDefinition> Aliases { get; } #Gets optional aliases exposed for this tool definition.
public ToolWriteGovernanceContract? WriteGovernance { get; } #Gets optional write-governance contract for mutating tools.
public ToolAuthenticationContract? Authentication { get; } #Gets optional authentication contract for tools that require/declare auth behavior.
public ToolExecutionContract? Execution { get; } #Gets optional execution contract for explicit local/remote capability metadata.
public ToolRoutingContract? Routing { get; } #Gets optional routing contract for host-side orchestration.
public ToolSetupContract? Setup { get; } #Gets optional setup contract for prerequisites and setup hints.
public ToolHandoffContract? Handoff { get; } #Gets optional handoff contract for cross-pack argument mappings.
public ToolRecoveryContract? Recovery { get; } #Gets optional recovery contract for tool-owned resilience behavior.
public String? AliasOf { get; } #Gets the canonical tool name when this definition represents an alias.
public String CanonicalName { get; } #Gets the canonical tool name for this definition.