Package com.microsoft.semantickernel.exceptions

Class SKException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

com.microsoft.semantickernel.exceptions.SKException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

AIException, TemplateException

public class SKException
extends RuntimeException

Provides the base exception from which all Semantic Kernel exceptions derive.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
SKException(String message)	Initializes a new instance of the SKException class with its message set to message.
SKException(String message, Throwable cause)	Initializes a new instance of the SKException class with its message set to message.
SKException(Throwable cause)	Initializes a new instance of the SKException class with its message set to null and the cause set to e.

Method Summary

Modifier and Type	Method	Description
static SKException	build(String message, Exception cause)	Forms an unchecked exception, if the exception is already an SK exception, it will be unwrapped and the cause extracted.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SKException

public SKException(@Nullable
                   String message)

Initializes a new instance of the SKException class with its message set to message.

Parameters:

message - A string that describes the error.

SKException

public SKException(@Nullable
                   String message,
                   @Nullable
                   Throwable cause)

Initializes a new instance of the SKException class with its message set to message.

Parameters:

message - A string that describes the error.

cause - The exception that is the cause of the current exception.

SKException

public SKException(Throwable cause)

Initializes a new instance of the SKException class with its message set to null and the cause set to e.

Parameters:

cause - The exception that is the cause of the current exception.

Method Detail

build

public static SKException build(String message,
                                @Nullable
                                Exception cause)

Forms an unchecked exception, if the exception is already an SK exception, it will be unwrapped and the cause extracted.

Parameters:

message - The message to be displayed

cause - The exception that is the cause of the current exception.

Returns:

An unchecked exception