Class ToolFailureOptions

Namespace

Emissary

Assembly

Emissary.dll

How tool failures and slow tools are handled.

public sealed class ToolFailureOptions

Inheritance

object

ToolFailureOptions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

IncludeExceptionMessage

Whether the exception's message is included in what the model is told. false by default, because exception messages carry connection strings, file paths, SQL, and record data — and everything the model sees is sent to the API and echoed into its reply. With it off, the model is told the tool failed and the exception type; the exception itself reaches your code through AgentToolFailedEvent and ToolFailures, and the activity for the call records it.

public bool IncludeExceptionMessage { get; set; }

Property Value

bool

Mode

What happens when a tool handler throws. Defaults to ReportToModel.

public ToolFailureMode Mode { get; set; }

Property Value

ToolFailureMode

Timeout

How long a single tool call may run before it is cancelled and reported as a failure. null (the default) means no limit, so a handler that never returns stalls the run.

public TimeSpan? Timeout { get; set; }

Property Value

TimeSpan?