riffer 0.55.0 → 0.56.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (57) hide show
  1. checksums.yaml +4 -4
  2. data/.release-please-manifest.json +1 -1
  3. data/CHANGELOG.md +18 -0
  4. data/README.md +2 -1
  5. data/UPGRADING.md +3 -0
  6. data/docs/AGENT_LIFECYCLE.md +1 -1
  7. data/docs/CONFIGURATION.md +48 -1
  8. data/docs/GUARDRAILS.md +2 -0
  9. data/docs/MESSAGES.md +112 -15
  10. data/docs/STABILITY.md +32 -0
  11. data/docs/STREAM_EVENTS.md +16 -0
  12. data/docs/TESTING.md +22 -1
  13. data/docs/providers/AMAZON_BEDROCK.md +1 -1
  14. data/docs/providers/ANTHROPIC.md +18 -14
  15. data/docs/providers/CUSTOM_PROVIDERS.md +24 -0
  16. data/docs/providers/GEMINI.md +1 -1
  17. data/docs/providers/GOOGLE_CLOUD.md +1 -1
  18. data/docs/providers/MOCK_PROVIDER.md +2 -0
  19. data/docs/providers/OPENAI.md +3 -1
  20. data/docs-site/manifest.yml +3 -0
  21. data/lib/riffer/agent/run.rb +28 -13
  22. data/lib/riffer/agent/session.rb +33 -10
  23. data/lib/riffer/config/future.rb +53 -0
  24. data/lib/riffer/config/pricing.rb +5 -15
  25. data/lib/riffer/config.rb +16 -0
  26. data/lib/riffer/deprecation/event.rb +25 -0
  27. data/lib/riffer/deprecation.rb +60 -0
  28. data/lib/riffer/messages/assistant/server_tool_part.rb +73 -0
  29. data/lib/riffer/messages/assistant/text_part.rb +52 -0
  30. data/lib/riffer/messages/assistant.rb +64 -17
  31. data/lib/riffer/providers/anthropic_compatible/messages_api/stream.rb +25 -1
  32. data/lib/riffer/providers/anthropic_compatible/messages_api.rb +51 -29
  33. data/lib/riffer/providers/base.rb +15 -6
  34. data/lib/riffer/providers/open_ai.rb +21 -16
  35. data/lib/riffer/stream_events/server_tool_done.rb +21 -0
  36. data/lib/riffer/testing.rb +6 -0
  37. data/lib/riffer/version.rb +1 -1
  38. data/lib/riffer.rb +2 -0
  39. data/sig/generated/riffer/agent/run.rbs +5 -0
  40. data/sig/generated/riffer/agent/session.rbs +6 -0
  41. data/sig/generated/riffer/config/future.rbs +29 -0
  42. data/sig/generated/riffer/config/pricing.rbs +0 -9
  43. data/sig/generated/riffer/config.rbs +8 -0
  44. data/sig/generated/riffer/deprecation/event.rbs +17 -0
  45. data/sig/generated/riffer/deprecation.rbs +27 -0
  46. data/sig/generated/riffer/messages/assistant/server_tool_part.rbs +44 -0
  47. data/sig/generated/riffer/messages/assistant/text_part.rbs +35 -0
  48. data/sig/generated/riffer/messages/assistant.rbs +24 -11
  49. data/sig/generated/riffer/providers/anthropic_compatible/messages_api/stream.rbs +10 -0
  50. data/sig/generated/riffer/providers/anthropic_compatible/messages_api.rbs +18 -9
  51. data/sig/generated/riffer/providers/base.rbs +5 -0
  52. data/sig/generated/riffer/providers/open_ai.rbs +7 -2
  53. data/sig/generated/riffer/stream_events/server_tool_done.rbs +15 -0
  54. data/sig/generated/riffer/testing.rbs +4 -0
  55. data/sig/generated/riffer.rbs +3 -0
  56. data/sig/manual/riffer/deprecation.rbs +5 -0
  57. metadata +16 -1
@@ -7,7 +7,7 @@ class Riffer::Providers::AnthropicCompatible::MessagesAPI < Riffer::Providers::B
7
7
 
8
8
  # Only parts carrying this tag are replayed, so reasoning captured by another
9
9
  # adapter, whose signatures the Messages API may not accept, never reaches the
10
- # request.
10
+ # request. Server tool parts and text parts that keep their block carry it too.
11
11
  REASONING_FORMAT: String
12
12
 
13
13
  # --
@@ -37,17 +37,17 @@ class Riffer::Providers::AnthropicCompatible::MessagesAPI < Riffer::Providers::B
37
37
  # : (Hash[Symbol, untyped], Riffer::Providers::_EventSink) -> void
38
38
  def execute_stream: (Hash[Symbol, untyped], Riffer::Providers::_EventSink) -> void
39
39
 
40
+ # Claude signs each thinking block over every block before it in the turn, so
41
+ # the blocks go back in the order they came.
40
42
  # --
41
- # : (Hash[Symbol, untyped]) -> String
42
- def extract_content: (Hash[Symbol, untyped]) -> String
43
+ # : (Hash[Symbol, untyped]) -> Array[Riffer::Messages::Assistant::TextPart | Riffer::Messages::Assistant::ReasoningPart | Riffer::Messages::Assistant::ToolCall | Riffer::Messages::Assistant::ServerToolPart]
44
+ def extract_parts: (Hash[Symbol, untyped]) -> Array[Riffer::Messages::Assistant::TextPart | Riffer::Messages::Assistant::ReasoningPart | Riffer::Messages::Assistant::ToolCall | Riffer::Messages::Assistant::ServerToolPart]
43
45
 
46
+ # The block is kept only when it carries citations, which point into the
47
+ # search results and go back with the text.
44
48
  # --
45
- # : (Hash[Symbol, untyped]) -> Array[Riffer::Messages::Assistant::ToolCall]
46
- def extract_tool_calls: (Hash[Symbol, untyped]) -> Array[Riffer::Messages::Assistant::ToolCall]
47
-
48
- # --
49
- # : (Hash[Symbol, untyped]) -> Array[Riffer::Messages::Assistant::ReasoningPart]
50
- def extract_reasoning: (Hash[Symbol, untyped]) -> Array[Riffer::Messages::Assistant::ReasoningPart]
49
+ # : (Hash[Symbol, untyped]) -> Riffer::Messages::Assistant::TextPart
50
+ def text_part: (Hash[Symbol, untyped]) -> Riffer::Messages::Assistant::TextPart
51
51
 
52
52
  # --
53
53
  # : (Hash[Symbol, untyped]) -> Riffer::Providers::TokenUsage?
@@ -85,6 +85,15 @@ class Riffer::Providers::AnthropicCompatible::MessagesAPI < Riffer::Providers::B
85
85
  # : (Riffer::Messages::Assistant) -> Hash[Symbol, untyped]
86
86
  def convert_assistant: (Riffer::Messages::Assistant) -> Hash[Symbol, untyped]
87
87
 
88
+ # --
89
+ # : (Riffer::Messages::Assistant::TextPart | Riffer::Messages::Assistant::ReasoningPart | Riffer::Messages::Assistant::ToolCall | Riffer::Messages::Assistant::ServerToolPart) -> Hash[Symbol, untyped]?
90
+ def convert_part: (Riffer::Messages::Assistant::TextPart | Riffer::Messages::Assistant::ReasoningPart | Riffer::Messages::Assistant::ToolCall | Riffer::Messages::Assistant::ServerToolPart) -> Hash[Symbol, untyped]?
91
+
92
+ # The API rejects text blocks that are empty or only whitespace.
93
+ # --
94
+ # : (Riffer::Messages::Assistant::TextPart) -> Hash[Symbol, untyped]?
95
+ def convert_text_part: (Riffer::Messages::Assistant::TextPart) -> Hash[Symbol, untyped]?
96
+
88
97
  # --
89
98
  # : (Riffer::Messages::Assistant::ReasoningPart) -> Hash[Symbol, untyped]
90
99
  def convert_reasoning_part: (Riffer::Messages::Assistant::ReasoningPart) -> Hash[Symbol, untyped]
@@ -103,6 +103,11 @@ class Riffer::Providers::Base
103
103
  # : (untyped) -> Riffer::Providers::FinishReason?
104
104
  def extract_finish_reason: (untyped) -> Riffer::Providers::FinishReason?
105
105
 
106
+ # Override when the provider interleaves blocks in one turn and needs them back in that order.
107
+ # --
108
+ # : (untyped) -> Array[Riffer::Messages::Assistant::TextPart | Riffer::Messages::Assistant::ReasoningPart | Riffer::Messages::Assistant::ToolCall | Riffer::Messages::Assistant::ServerToolPart]
109
+ def extract_parts: (untyped) -> Array[Riffer::Messages::Assistant::TextPart | Riffer::Messages::Assistant::ReasoningPart | Riffer::Messages::Assistant::ToolCall | Riffer::Messages::Assistant::ServerToolPart]
110
+
106
111
  # --
107
112
  # : (untyped) -> Array[Riffer::Messages::Assistant::ReasoningPart]
108
113
  def extract_reasoning: (untyped) -> Array[Riffer::Messages::Assistant::ReasoningPart]
@@ -3,6 +3,9 @@
3
3
  class Riffer::Providers::OpenAI < Riffer::Providers::Base
4
4
  WEB_SEARCH_TOOL_TYPE: String
5
5
 
6
+ # Without this include, a web_search_call's search action carries no sources.
7
+ WEB_SEARCH_SOURCES_INCLUDE: String
8
+
6
9
  # The Responses API has no finish_reason field, and an +incomplete+ status is only meaningful
7
10
  # together with <tt>incomplete_details.reason</tt>.
8
11
  FINISH_REASONS: Hash[String, Symbol | Hash[String, Symbol]]
@@ -109,9 +112,11 @@ class Riffer::Providers::OpenAI < Riffer::Providers::Base
109
112
  # : (untyped, state: Hash[Symbol, untyped], yielder: Riffer::Providers::_EventSink) -> void
110
113
  def handle_function_call_arguments_delta: (untyped, state: Hash[Symbol, untyped], yielder: Riffer::Providers::_EventSink) -> void
111
114
 
115
+ # Emitted from the finished item rather than function_call_arguments.done, because only the
116
+ # item's status marks a call cut off by max_output_tokens, whose arguments can't be run.
112
117
  # --
113
- # : (untyped, state: Hash[Symbol, untyped], yielder: Riffer::Providers::_EventSink) -> void
114
- def handle_function_call_arguments_done: (untyped, state: Hash[Symbol, untyped], yielder: Riffer::Providers::_EventSink) -> void
118
+ # : (untyped, yielder: Riffer::Providers::_EventSink) -> void
119
+ def handle_output_item_done_function_call: (untyped, yielder: Riffer::Providers::_EventSink) -> void
115
120
 
116
121
  # --
117
122
  # : (untyped, state: Hash[Symbol, untyped], yielder: Riffer::Providers::_EventSink) -> void
@@ -0,0 +1,15 @@
1
+ # Generated from lib/riffer/stream_events/server_tool_done.rb with RBS::Inline
2
+
3
+ # Carries a server tool block for replay. WebSearchStatus and WebSearchDone are the events to
4
+ # display.
5
+ class Riffer::StreamEvents::ServerToolDone < Riffer::StreamEvents::Base
6
+ attr_reader part: Riffer::Messages::Assistant::ServerToolPart
7
+
8
+ # --
9
+ # : (Riffer::Messages::Assistant::ServerToolPart, ?role: Symbol) -> void
10
+ def initialize: (Riffer::Messages::Assistant::ServerToolPart, ?role: Symbol) -> void
11
+
12
+ # --
13
+ # : () -> Hash[Symbol, untyped]
14
+ def to_h: () -> Hash[Symbol, untyped]
15
+ end
@@ -13,6 +13,10 @@ module Riffer::Testing
13
13
  # : (?(String | Symbol)?, ?base: singleton(Riffer::Tool)) ?{ () [self: singleton(Riffer::Tool)] -> void } -> singleton(Riffer::Tool)
14
14
  def stub_tool: (?(String | Symbol)?, ?base: singleton(Riffer::Tool)) ?{ () [self: singleton(Riffer::Tool)] -> void } -> singleton(Riffer::Tool)
15
15
 
16
+ # --
17
+ # : [T] () { () -> T } -> T
18
+ def allow_deprecations: [T] () { () -> T } -> T
19
+
16
20
  # --
17
21
  # : () -> void
18
22
  def reset!: () -> void
@@ -63,6 +63,9 @@ module Riffer
63
63
  class DuplicateIdentifierError < Error
64
64
  end
65
65
 
66
+ class DeprecationError < Error
67
+ end
68
+
66
69
  # --
67
70
  # : () -> Riffer::Config
68
71
  def config: () -> Riffer::Config
@@ -0,0 +1,5 @@
1
+ # `Riffer::Deprecation` uses `extend self`; rbs-inline doesn't emit that, so
2
+ # re-extend here to expose its instance methods as singleton methods.
3
+ module Riffer::Deprecation
4
+ extend ::Riffer::Deprecation
5
+ end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: riffer
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.55.0
4
+ version: 0.56.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Jake Bottrall
@@ -98,6 +98,7 @@ files:
98
98
  - README.md
99
99
  - Rakefile
100
100
  - Steepfile
101
+ - UPGRADING.md
101
102
  - docs-site/404.html
102
103
  - docs-site/build.rb
103
104
  - docs-site/check.rb
@@ -121,6 +122,7 @@ files:
121
122
  - docs/OVERVIEW.md
122
123
  - docs/SERIALIZATION.md
123
124
  - docs/SKILLS.md
125
+ - docs/STABILITY.md
124
126
  - docs/STREAM_EVENTS.md
125
127
  - docs/TESTING.md
126
128
  - docs/TOOLS.md
@@ -157,6 +159,7 @@ files:
157
159
  - lib/riffer/config/azure_open_ai.rb
158
160
  - lib/riffer/config/evals.rb
159
161
  - lib/riffer/config/files.rb
162
+ - lib/riffer/config/future.rb
160
163
  - lib/riffer/config/gemini.rb
161
164
  - lib/riffer/config/google_cloud.rb
162
165
  - lib/riffer/config/mcp.rb
@@ -165,6 +168,8 @@ files:
165
168
  - lib/riffer/config/pricing.rb
166
169
  - lib/riffer/config/skills.rb
167
170
  - lib/riffer/config/tracing.rb
171
+ - lib/riffer/deprecation.rb
172
+ - lib/riffer/deprecation/event.rb
168
173
  - lib/riffer/evals.rb
169
174
  - lib/riffer/evals/evaluator.rb
170
175
  - lib/riffer/evals/evaluator_runner.rb
@@ -202,6 +207,8 @@ files:
202
207
  - lib/riffer/messages.rb
203
208
  - lib/riffer/messages/assistant.rb
204
209
  - lib/riffer/messages/assistant/reasoning_part.rb
210
+ - lib/riffer/messages/assistant/server_tool_part.rb
211
+ - lib/riffer/messages/assistant/text_part.rb
205
212
  - lib/riffer/messages/assistant/tool_call.rb
206
213
  - lib/riffer/messages/base.rb
207
214
  - lib/riffer/messages/system.rb
@@ -256,6 +263,7 @@ files:
256
263
  - lib/riffer/stream_events/interrupt.rb
257
264
  - lib/riffer/stream_events/reasoning_delta.rb
258
265
  - lib/riffer/stream_events/reasoning_done.rb
266
+ - lib/riffer/stream_events/server_tool_done.rb
259
267
  - lib/riffer/stream_events/skill_activation.rb
260
268
  - lib/riffer/stream_events/text_delta.rb
261
269
  - lib/riffer/stream_events/text_done.rb
@@ -320,6 +328,7 @@ files:
320
328
  - sig/generated/riffer/config/azure_open_ai.rbs
321
329
  - sig/generated/riffer/config/evals.rbs
322
330
  - sig/generated/riffer/config/files.rbs
331
+ - sig/generated/riffer/config/future.rbs
323
332
  - sig/generated/riffer/config/gemini.rbs
324
333
  - sig/generated/riffer/config/google_cloud.rbs
325
334
  - sig/generated/riffer/config/mcp.rbs
@@ -328,6 +337,8 @@ files:
328
337
  - sig/generated/riffer/config/pricing.rbs
329
338
  - sig/generated/riffer/config/skills.rbs
330
339
  - sig/generated/riffer/config/tracing.rbs
340
+ - sig/generated/riffer/deprecation.rbs
341
+ - sig/generated/riffer/deprecation/event.rbs
331
342
  - sig/generated/riffer/evals.rbs
332
343
  - sig/generated/riffer/evals/evaluator.rbs
333
344
  - sig/generated/riffer/evals/evaluator_runner.rbs
@@ -365,6 +376,8 @@ files:
365
376
  - sig/generated/riffer/messages.rbs
366
377
  - sig/generated/riffer/messages/assistant.rbs
367
378
  - sig/generated/riffer/messages/assistant/reasoning_part.rbs
379
+ - sig/generated/riffer/messages/assistant/server_tool_part.rbs
380
+ - sig/generated/riffer/messages/assistant/text_part.rbs
368
381
  - sig/generated/riffer/messages/assistant/tool_call.rbs
369
382
  - sig/generated/riffer/messages/base.rbs
370
383
  - sig/generated/riffer/messages/system.rbs
@@ -419,6 +432,7 @@ files:
419
432
  - sig/generated/riffer/stream_events/interrupt.rbs
420
433
  - sig/generated/riffer/stream_events/reasoning_delta.rbs
421
434
  - sig/generated/riffer/stream_events/reasoning_done.rbs
435
+ - sig/generated/riffer/stream_events/server_tool_done.rbs
422
436
  - sig/generated/riffer/stream_events/skill_activation.rbs
423
437
  - sig/generated/riffer/stream_events/text_delta.rbs
424
438
  - sig/generated/riffer/stream_events/text_done.rbs
@@ -452,6 +466,7 @@ files:
452
466
  - sig/manual/riffer/agent/serializer.rbs
453
467
  - sig/manual/riffer/agent/session/repair.rbs
454
468
  - sig/manual/riffer/agent/structured_output/parser.rbs
469
+ - sig/manual/riffer/deprecation.rbs
455
470
  - sig/manual/riffer/evals/evaluator_runner.rbs
456
471
  - sig/manual/riffer/helpers/boolean.rbs
457
472
  - sig/manual/riffer/helpers/call_or_value.rbs