errors.ts 6.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203
  1. import { Schema } from "effect"
  2. import { ModelID, ProviderID, ProviderMetadata, RouteID } from "./ids"
  3. export class HttpRequestDetails extends Schema.Class<HttpRequestDetails>("LLM.HttpRequestDetails")({
  4. method: Schema.String,
  5. url: Schema.String,
  6. headers: Schema.Record(Schema.String, Schema.String),
  7. }) {}
  8. export class HttpResponseDetails extends Schema.Class<HttpResponseDetails>("LLM.HttpResponseDetails")({
  9. status: Schema.Number,
  10. headers: Schema.Record(Schema.String, Schema.String),
  11. }) {}
  12. export class HttpRateLimitDetails extends Schema.Class<HttpRateLimitDetails>("LLM.HttpRateLimitDetails")({
  13. retryAfterMs: Schema.optional(Schema.Number),
  14. limit: Schema.optional(Schema.Record(Schema.String, Schema.String)),
  15. remaining: Schema.optional(Schema.Record(Schema.String, Schema.String)),
  16. reset: Schema.optional(Schema.Record(Schema.String, Schema.String)),
  17. }) {}
  18. export class HttpContext extends Schema.Class<HttpContext>("LLM.HttpContext")({
  19. request: HttpRequestDetails,
  20. response: Schema.optional(HttpResponseDetails),
  21. body: Schema.optional(Schema.String),
  22. bodyTruncated: Schema.optional(Schema.Boolean),
  23. requestId: Schema.optional(Schema.String),
  24. rateLimit: Schema.optional(HttpRateLimitDetails),
  25. }) {}
  26. export class InvalidRequestReason extends Schema.Class<InvalidRequestReason>("LLM.Error.InvalidRequest")({
  27. _tag: Schema.tag("InvalidRequest"),
  28. message: Schema.String,
  29. parameter: Schema.optional(Schema.String),
  30. providerMetadata: Schema.optional(ProviderMetadata),
  31. http: Schema.optional(HttpContext),
  32. }) {
  33. get retryable() {
  34. return false
  35. }
  36. }
  37. export class NoRouteReason extends Schema.Class<NoRouteReason>("LLM.Error.NoRoute")({
  38. _tag: Schema.tag("NoRoute"),
  39. route: RouteID,
  40. provider: ProviderID,
  41. model: ModelID,
  42. }) {
  43. get retryable() {
  44. return false
  45. }
  46. get message() {
  47. return `No LLM route for ${this.provider}/${this.model} using ${this.route}`
  48. }
  49. }
  50. export class AuthenticationReason extends Schema.Class<AuthenticationReason>("LLM.Error.Authentication")({
  51. _tag: Schema.tag("Authentication"),
  52. message: Schema.String,
  53. kind: Schema.Literals(["missing", "invalid", "expired", "insufficient-permissions", "unknown"]),
  54. providerMetadata: Schema.optional(ProviderMetadata),
  55. http: Schema.optional(HttpContext),
  56. }) {
  57. get retryable() {
  58. return false
  59. }
  60. }
  61. export class RateLimitReason extends Schema.Class<RateLimitReason>("LLM.Error.RateLimit")({
  62. _tag: Schema.tag("RateLimit"),
  63. message: Schema.String,
  64. retryAfterMs: Schema.optional(Schema.Number),
  65. rateLimit: Schema.optional(HttpRateLimitDetails),
  66. providerMetadata: Schema.optional(ProviderMetadata),
  67. http: Schema.optional(HttpContext),
  68. }) {
  69. get retryable() {
  70. return true
  71. }
  72. }
  73. export class QuotaExceededReason extends Schema.Class<QuotaExceededReason>("LLM.Error.QuotaExceeded")({
  74. _tag: Schema.tag("QuotaExceeded"),
  75. message: Schema.String,
  76. providerMetadata: Schema.optional(ProviderMetadata),
  77. http: Schema.optional(HttpContext),
  78. }) {
  79. get retryable() {
  80. return false
  81. }
  82. }
  83. export class ContentPolicyReason extends Schema.Class<ContentPolicyReason>("LLM.Error.ContentPolicy")({
  84. _tag: Schema.tag("ContentPolicy"),
  85. message: Schema.String,
  86. providerMetadata: Schema.optional(ProviderMetadata),
  87. http: Schema.optional(HttpContext),
  88. }) {
  89. get retryable() {
  90. return false
  91. }
  92. }
  93. export class ProviderInternalReason extends Schema.Class<ProviderInternalReason>("LLM.Error.ProviderInternal")({
  94. _tag: Schema.tag("ProviderInternal"),
  95. message: Schema.String,
  96. status: Schema.Number,
  97. retryAfterMs: Schema.optional(Schema.Number),
  98. providerMetadata: Schema.optional(ProviderMetadata),
  99. http: Schema.optional(HttpContext),
  100. }) {
  101. get retryable() {
  102. return true
  103. }
  104. }
  105. export class TransportReason extends Schema.Class<TransportReason>("LLM.Error.Transport")({
  106. _tag: Schema.tag("Transport"),
  107. message: Schema.String,
  108. kind: Schema.optional(Schema.String),
  109. url: Schema.optional(Schema.String),
  110. http: Schema.optional(HttpContext),
  111. }) {
  112. get retryable() {
  113. return false
  114. }
  115. }
  116. export class InvalidProviderOutputReason extends Schema.Class<InvalidProviderOutputReason>(
  117. "LLM.Error.InvalidProviderOutput",
  118. )({
  119. _tag: Schema.tag("InvalidProviderOutput"),
  120. message: Schema.String,
  121. route: Schema.optional(Schema.String),
  122. raw: Schema.optional(Schema.String),
  123. providerMetadata: Schema.optional(ProviderMetadata),
  124. }) {
  125. get retryable() {
  126. return false
  127. }
  128. }
  129. export class UnknownProviderReason extends Schema.Class<UnknownProviderReason>("LLM.Error.UnknownProvider")({
  130. _tag: Schema.tag("UnknownProvider"),
  131. message: Schema.String,
  132. status: Schema.optional(Schema.Number),
  133. providerMetadata: Schema.optional(ProviderMetadata),
  134. http: Schema.optional(HttpContext),
  135. }) {
  136. get retryable() {
  137. return false
  138. }
  139. }
  140. export const LLMErrorReason = Schema.Union([
  141. InvalidRequestReason,
  142. NoRouteReason,
  143. AuthenticationReason,
  144. RateLimitReason,
  145. QuotaExceededReason,
  146. ContentPolicyReason,
  147. ProviderInternalReason,
  148. TransportReason,
  149. InvalidProviderOutputReason,
  150. UnknownProviderReason,
  151. ]).pipe(Schema.toTaggedUnion("_tag"))
  152. export type LLMErrorReason = Schema.Schema.Type<typeof LLMErrorReason>
  153. export class LLMError extends Schema.TaggedErrorClass<LLMError>()("LLM.Error", {
  154. module: Schema.String,
  155. method: Schema.String,
  156. reason: LLMErrorReason,
  157. }) {
  158. override readonly cause = this.reason
  159. get retryable() {
  160. return this.reason.retryable
  161. }
  162. get retryAfterMs() {
  163. return "retryAfterMs" in this.reason ? this.reason.retryAfterMs : undefined
  164. }
  165. override get message() {
  166. return `${this.module}.${this.method}: ${this.reason.message}`
  167. }
  168. }
  169. /**
  170. * Failure type for tool execute handlers. Handlers must map their internal
  171. * errors to this shape; the runtime catches `ToolFailure`s and surfaces them
  172. * as `tool-error` events plus a `tool-result` of `type: "error"` so the model
  173. * can self-correct.
  174. *
  175. * Anything thrown or yielded by a handler that is not a `ToolFailure` is
  176. * treated as a defect and fails the stream.
  177. */
  178. export class ToolFailure extends Schema.TaggedErrorClass<ToolFailure>()("LLM.ToolFailure", {
  179. message: Schema.String,
  180. error: Schema.optional(Schema.Defect),
  181. metadata: Schema.optional(Schema.Record(Schema.String, Schema.Unknown)),
  182. }) {}