RealtimeEvent.rateLimitsUpdated constructor

  1. @FreezedUnionValue('rate_limits.updated')
const RealtimeEvent.rateLimitsUpdated({
  1. @JsonKey(name: 'event_id') required String eventId,
  2. @Default(RealtimeEventType.rateLimitsUpdated) RealtimeEventType type,
  3. @JsonKey(name: 'rate_limits') required List<RateLimit> rateLimits,
})

Emitted at the beginning of a Response to indicate the updated rate limits. When a Response is created some tokens will be "reserved" for the output tokens, the rate limits shown here reflect that reservation, which is then adjusted accordingly once the Response is completed.

Implementation

@FreezedUnionValue('rate_limits.updated')
const factory RealtimeEvent.rateLimitsUpdated({
  /// The unique ID of the server event.
  @JsonKey(name: 'event_id') required String eventId,

  /// The type of the event.
  @Default(RealtimeEventType.rateLimitsUpdated) RealtimeEventType type,

  /// List of rate limit information.
  @JsonKey(name: 'rate_limits') required List<RateLimit> rateLimits,
}) = RealtimeEventRateLimitsUpdated;