Skip to content

Exceptions

Defines the exceptions raised by gllm-generation.

BaseGenerationError(message=None, *, debug_info=None, recovery=None, original_error=None)

Bases: BaseError

Base class for all errors raised by gllm-generation.

This class is never raised directly. Every concrete subclass must define code using the format GLLM-GEN-<NAME> and default_message.

Attributes:

Name Type Description
code str | None

Stable error code. Defined by each concrete subclass.

default_message str | None

Message used when no message is given. Defined by each concrete subclass.

message str

The message of this error.

debug_info DebugInfo

Structured internal detail about this error.

EventTimeoutError(message=None, *, debug_info=None, recovery=None, original_error=None)

Bases: BaseGenerationError

Raised when no new event is received from a stream within the allowed idle timeout.

Attributes:

Name Type Description
code str

The error code, GLLM-GEN-EVENT-TIMEOUT.

default_message str

Message used when no message is given.

message str

The message of this error.

debug_info DebugInfo

Structured internal detail about this error.

recovery RecoveryInfo

Guidance on how to react to this error. Retryable, as an idle timeout can be transient.

GenerationNotImplementedError(message=None, *, debug_info=None, recovery=None, original_error=None)

Bases: BaseGenerationError, NotImplementedError

Raised when a required method is not implemented by a subclass.

Attributes:

Name Type Description
code str

The error code, GLLM-GEN-NOT-IMPLEMENTED.

default_message str

Message used when no message is given.

message str

The message of this error.

debug_info DebugInfo

Structured internal detail about this error.

GenerationRuntimeError(message=None, *, debug_info=None, recovery=None, original_error=None)

Bases: BaseGenerationError, RuntimeError

Raised when an operation fails while it is being executed.

Attributes:

Name Type Description
code str

The error code, GLLM-GEN-RUNTIME.

default_message str

Message used when no message is given.

message str

The message of this error.

debug_info DebugInfo

Structured internal detail about this error.

GenerationTypeError(message=None, *, debug_info=None, recovery=None, original_error=None)

Bases: BaseGenerationError, TypeError

Raised when a value has an unexpected type.

Attributes:

Name Type Description
code str

The error code, GLLM-GEN-TYPE.

default_message str

Message used when no message is given.

message str

The message of this error.

debug_info DebugInfo

Structured internal detail about this error.

GenerationValueError(message=None, *, debug_info=None, recovery=None, original_error=None)

Bases: BaseGenerationError, ValueError

Raised when an input, argument, or intermediate result is invalid.

Attributes:

Name Type Description
code str

The error code, GLLM-GEN-VALIDATION.

default_message str

Message used when no message is given.

message str

The message of this error.

debug_info DebugInfo

Structured internal detail about this error.