Share via


AgentErrorDefinition interface

Represents an error definition for the Agents SDK. Each error definition includes an error code, description, and an optional help link. If helplink is not provided, a default help link will be used.

Properties

code

Error code for the exception

description

Displayed error message

helplink

Optional help URL link for the error. If not provided, the default help link will be used.

Property Details

code

Error code for the exception

code: number

Property Value

number

description

Displayed error message

description: string

Property Value

string

Optional help URL link for the error. If not provided, the default help link will be used.

helplink?: string

Property Value

string