riffer 0.47.1 → 0.48.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 (128) hide show
  1. checksums.yaml +4 -4
  2. data/.claude/rules/rbs-inline.md +5 -1
  3. data/.release-please-manifest.json +1 -1
  4. data/CHANGELOG.md +31 -0
  5. data/Rakefile +1 -1
  6. data/Steepfile +1 -15
  7. data/docs/AGENTS.md +37 -3
  8. data/docs/AGENT_LIFECYCLE.md +1 -0
  9. data/docs/CONFIGURATION.md +1 -1
  10. data/docs/EVALS.md +2 -1
  11. data/docs/MCP.md +0 -4
  12. data/docs/MESSAGES.md +85 -17
  13. data/docs/STREAM_EVENTS.md +31 -4
  14. data/docs/TRACING.md +1 -1
  15. data/docs/providers/AMAZON_BEDROCK.md +1 -1
  16. data/docs/providers/CUSTOM_PROVIDERS.md +58 -4
  17. data/docs/providers/GEMINI.md +1 -1
  18. data/docs/providers/MOCK_PROVIDER.md +17 -0
  19. data/lib/riffer/agent/config.rb +40 -16
  20. data/lib/riffer/agent/outcome.rb +2 -2
  21. data/lib/riffer/agent/response.rb +16 -9
  22. data/lib/riffer/agent/run.rb +24 -9
  23. data/lib/riffer/agent/session.rb +2 -1
  24. data/lib/riffer/agent/structured_output/result.rb +2 -2
  25. data/lib/riffer/agent/structured_output.rb +1 -1
  26. data/lib/riffer/agent.rb +40 -16
  27. data/lib/riffer/config.rb +31 -31
  28. data/lib/riffer/evals/evaluator.rb +29 -2
  29. data/lib/riffer/evals/judge.rb +13 -8
  30. data/lib/riffer/evals/result.rb +6 -6
  31. data/lib/riffer/evals/run_result.rb +1 -1
  32. data/lib/riffer/evals/scenario_result.rb +6 -6
  33. data/lib/riffer/files/resolver.rb +3 -3
  34. data/lib/riffer/guardrails/modification.rb +3 -3
  35. data/lib/riffer/guardrails/result.rb +3 -3
  36. data/lib/riffer/guardrails/runner.rb +4 -4
  37. data/lib/riffer/guardrails/tripwire.rb +4 -4
  38. data/lib/riffer/helpers/deep_dup.rb +42 -0
  39. data/lib/riffer/mcp/manifest.rb +5 -5
  40. data/lib/riffer/mcp/registration.rb +1 -1
  41. data/lib/riffer/mcp/search_tool.rb +1 -1
  42. data/lib/riffer/messages/assistant/reasoning_part.rb +90 -0
  43. data/lib/riffer/messages/assistant/tool_call.rb +63 -0
  44. data/lib/riffer/messages/assistant.rb +55 -7
  45. data/lib/riffer/messages/base.rb +7 -25
  46. data/lib/riffer/messages/system.rb +10 -0
  47. data/lib/riffer/messages/tool.rb +21 -4
  48. data/lib/riffer/messages/{file_part.rb → user/file_part.rb} +18 -17
  49. data/lib/riffer/messages/user.rb +13 -2
  50. data/lib/riffer/params/param.rb +20 -8
  51. data/lib/riffer/params.rb +10 -1
  52. data/lib/riffer/providers/amazon_bedrock.rb +34 -6
  53. data/lib/riffer/providers/anthropic.rb +9 -2
  54. data/lib/riffer/providers/base.rb +28 -10
  55. data/lib/riffer/providers/finish_reason.rb +2 -2
  56. data/lib/riffer/providers/gemini.rb +2 -2
  57. data/lib/riffer/providers/mock.rb +19 -3
  58. data/lib/riffer/providers/open_ai.rb +14 -5
  59. data/lib/riffer/providers/open_router.rb +6 -5
  60. data/lib/riffer/providers/repository.rb +0 -4
  61. data/lib/riffer/providers/token_usage.rb +21 -5
  62. data/lib/riffer/skills/adapter.rb +1 -1
  63. data/lib/riffer/skills/config.rb +12 -0
  64. data/lib/riffer/skills/context.rb +4 -7
  65. data/lib/riffer/skills/filesystem_backend.rb +1 -2
  66. data/lib/riffer/skills/frontmatter.rb +4 -4
  67. data/lib/riffer/skills/xml_adapter.rb +1 -1
  68. data/lib/riffer/stream_events/base.rb +1 -1
  69. data/lib/riffer/stream_events/finish_reason_done.rb +2 -2
  70. data/lib/riffer/stream_events/guardrail_modification.rb +1 -1
  71. data/lib/riffer/stream_events/guardrail_tripwire.rb +1 -1
  72. data/lib/riffer/stream_events/interrupt.rb +2 -2
  73. data/lib/riffer/stream_events/reasoning_delta.rb +1 -1
  74. data/lib/riffer/stream_events/reasoning_done.rb +10 -8
  75. data/lib/riffer/stream_events/skill_activation.rb +1 -1
  76. data/lib/riffer/stream_events/text_delta.rb +1 -1
  77. data/lib/riffer/stream_events/text_done.rb +1 -1
  78. data/lib/riffer/stream_events/token_usage_done.rb +1 -1
  79. data/lib/riffer/stream_events/tool_call_delta.rb +3 -3
  80. data/lib/riffer/stream_events/tool_call_done.rb +4 -4
  81. data/lib/riffer/stream_events/web_search_done.rb +2 -2
  82. data/lib/riffer/stream_events/web_search_status.rb +3 -3
  83. data/lib/riffer/tools/response.rb +4 -4
  84. data/lib/riffer/tools/runtime.rb +3 -4
  85. data/lib/riffer/tracing/capture.rb +2 -4
  86. data/lib/riffer/tracing/stream_recorder.rb +6 -6
  87. data/lib/riffer/version.rb +1 -1
  88. data/lib/riffer.rb +7 -0
  89. data/rbs_collection.lock.yaml +320 -0
  90. data/rbs_collection.yaml +12 -0
  91. data/sig/_private/anthropic.rbs +5 -4
  92. data/sig/_private/aws-sdk-core/event_error.rbs +15 -0
  93. data/sig/generated/riffer/agent/config.rbs +19 -5
  94. data/sig/generated/riffer/agent/response.rbs +6 -1
  95. data/sig/generated/riffer/agent/run.rbs +15 -8
  96. data/sig/generated/riffer/agent.rbs +25 -9
  97. data/sig/generated/riffer/config.rbs +1 -1
  98. data/sig/generated/riffer/evals/evaluator.rbs +20 -1
  99. data/sig/generated/riffer/evals/judge.rbs +5 -2
  100. data/sig/generated/riffer/files/resolver.rbs +6 -6
  101. data/sig/generated/riffer/helpers/deep_dup.rbs +21 -0
  102. data/sig/generated/riffer/messages/assistant/reasoning_part.rbs +58 -0
  103. data/sig/generated/riffer/messages/assistant/tool_call.rbs +42 -0
  104. data/sig/generated/riffer/messages/assistant.rbs +24 -10
  105. data/sig/generated/riffer/messages/system.rbs +6 -0
  106. data/sig/generated/riffer/messages/tool.rbs +6 -0
  107. data/sig/generated/riffer/messages/{file_part.rbs → user/file_part.rbs} +11 -6
  108. data/sig/generated/riffer/messages/user.rbs +9 -3
  109. data/sig/generated/riffer/params/param.rbs +7 -0
  110. data/sig/generated/riffer/params.rbs +6 -0
  111. data/sig/generated/riffer/providers/amazon_bedrock.rbs +14 -5
  112. data/sig/generated/riffer/providers/anthropic.rbs +2 -2
  113. data/sig/generated/riffer/providers/base.rbs +22 -10
  114. data/sig/generated/riffer/providers/gemini.rbs +4 -4
  115. data/sig/generated/riffer/providers/mock.rbs +7 -2
  116. data/sig/generated/riffer/providers/open_ai.rbs +4 -4
  117. data/sig/generated/riffer/providers/open_router.rbs +4 -4
  118. data/sig/generated/riffer/providers/repository.rbs +0 -2
  119. data/sig/generated/riffer/providers/token_usage.rbs +6 -0
  120. data/sig/generated/riffer/skills/config.rbs +9 -0
  121. data/sig/generated/riffer/stream_events/reasoning_done.rbs +8 -6
  122. data/sig/generated/riffer/tools/runtime.rbs +2 -2
  123. data/sig/generated/riffer/tracing/capture.rbs +4 -4
  124. data/sig/generated/riffer.rbs +8 -0
  125. data/sig/manual/riffer/helpers/deep_dup.rbs +5 -0
  126. metadata +13 -5
  127. data/sig/_private/async.rbs +0 -28
  128. data/sig/_private/minitest.rbs +0 -9
@@ -20,17 +20,17 @@ class Riffer::Files::Resolver
20
20
  # : (Riffer::Messages::User) -> void
21
21
  def check_file_count!: (Riffer::Messages::User) -> void
22
22
 
23
- # : (Riffer::Messages::FilePart) -> void
24
- def resolve_file!: (Riffer::Messages::FilePart) -> void
23
+ # : (Riffer::Messages::User::FilePart) -> void
24
+ def resolve_file!: (Riffer::Messages::User::FilePart) -> void
25
25
 
26
- # : (Riffer::Messages::FilePart) -> void
27
- def verify_inline!: (Riffer::Messages::FilePart) -> void
26
+ # : (Riffer::Messages::User::FilePart) -> void
27
+ def verify_inline!: (Riffer::Messages::User::FilePart) -> void
28
28
 
29
29
  # +cache:+ is false for a :url-delivery provider verifying a sha256 — the
30
30
  # request still sends the URL, never the downloaded bytes, so caching them
31
31
  # would hold memory nothing reads and let later turns skip re-verifying.
32
- # : (Riffer::Messages::FilePart, cache: (false | Symbol)) -> void
33
- def download!: (Riffer::Messages::FilePart, cache: false | Symbol) -> void
32
+ # : (Riffer::Messages::User::FilePart, cache: (false | Symbol)) -> void
33
+ def download!: (Riffer::Messages::User::FilePart, cache: false | Symbol) -> void
34
34
 
35
35
  def verify_bytes!: (untyped bytes, untyped sha256) -> untyped
36
36
  end
@@ -0,0 +1,21 @@
1
+ # Generated from lib/riffer/helpers/deep_dup.rb with RBS::Inline
2
+
3
+ # Copying for the nested Hashes and Arrays a configuration object holds.
4
+ module Riffer::Helpers::DeepDup
5
+ # Returns +value+ with every Hash and Array rebuilt, so a copy shares no
6
+ # collection with its source.
7
+ #
8
+ # Anything else is returned as-is, which a Class or a Proc needs: +Class#dup+
9
+ # answers a new anonymous class. One source collection maps to one copy, so
10
+ # references shared within +value+ stay shared in the result — an +:around+
11
+ # guardrail registered under two phases is still one registration afterwards.
12
+ # --
13
+ # : (untyped) -> untyped
14
+ def call: (untyped) -> untyped
15
+
16
+ private
17
+
18
+ # --
19
+ # : (untyped, Hash[untyped, untyped]) -> untyped
20
+ def rebuild: (untyped, Hash[untyped, untyped]) -> untyped
21
+ end
@@ -0,0 +1,58 @@
1
+ # Generated from lib/riffer/messages/assistant/reasoning_part.rb with RBS::Inline
2
+
3
+ # Represents one block of model reasoning attached to an assistant message.
4
+ # riffer stores and replays a part verbatim rather than interpreting it, so a
5
+ # provider that requires its own thinking blocks back gets them unchanged.
6
+ class Riffer::Messages::Assistant::ReasoningPart
7
+ TYPES: Array[Symbol]
8
+
9
+ # What the part carries: readable reasoning (+:text+), a provider-condensed
10
+ # digest (+:summary+), or an opaque payload (+:encrypted+).
11
+ attr_reader type: Symbol
12
+
13
+ # The reasoning prose, for +:text+ and +:summary+ parts.
14
+ attr_reader text: String?
15
+
16
+ # The opaque payload, for +:encrypted+ parts.
17
+ attr_reader data: String?
18
+
19
+ # The provider's signature over the part, when it issues one.
20
+ attr_reader signature: String?
21
+
22
+ # The provider's identifier for the part, when it issues one.
23
+ attr_reader id: String?
24
+
25
+ # The wire format of the part, owned by the provider adapter that produced it
26
+ # (e.g. <tt>"anthropic-claude-v1"</tt>). Adapters replay only the formats they
27
+ # recognize, so it is never validated here.
28
+ attr_reader format: String?
29
+
30
+ # Builds a ReasoningPart from a hash, or returns +part+ unchanged when it is
31
+ # already a ReasoningPart.
32
+ # --
33
+ # : ((Hash[Symbol, untyped] | Riffer::Messages::Assistant::ReasoningPart)) -> Riffer::Messages::Assistant::ReasoningPart
34
+ def self.from_hash: (Hash[Symbol, untyped] | Riffer::Messages::Assistant::ReasoningPart) -> Riffer::Messages::Assistant::ReasoningPart
35
+
36
+ # Raises Riffer::ArgumentError on a +type+ outside TYPES.
37
+ # --
38
+ # : (type: Symbol, ?text: String?, ?data: String?, ?signature: String?, ?id: String?, ?format: String?) -> void
39
+ def initialize: (type: Symbol, ?text: String?, ?data: String?, ?signature: String?, ?id: String?, ?format: String?) -> void
40
+
41
+ # Serializes the part to a hash, omitting the fields it doesn't carry.
42
+ #
43
+ # --
44
+ # : () -> Hash[Symbol, untyped]
45
+ def to_h: () -> Hash[Symbol, untyped]
46
+
47
+ # --
48
+ # : (untyped) -> bool
49
+ def ==: (untyped) -> bool
50
+
51
+ # --
52
+ # : (untyped) -> bool
53
+ def eql?: (untyped) -> bool
54
+
55
+ # --
56
+ # : () -> Integer
57
+ def hash: () -> Integer
58
+ end
@@ -0,0 +1,42 @@
1
+ # Generated from lib/riffer/messages/assistant/tool_call.rb with RBS::Inline
2
+
3
+ # Represents one tool invocation the model requested on an assistant message.
4
+ class Riffer::Messages::Assistant::ToolCall
5
+ # The provider's identifier for the call, echoed back on the tool result.
6
+ attr_reader call_id: String
7
+
8
+ # The name of the tool to invoke.
9
+ attr_reader name: String
10
+
11
+ # The JSON-encoded arguments, exactly as the provider emitted them.
12
+ attr_reader arguments: String
13
+
14
+ # Builds a ToolCall from a hash, or returns +call+ unchanged when it is
15
+ # already a ToolCall. Raises Riffer::ArgumentError when the hash is missing
16
+ # a field.
17
+ # --
18
+ # : ((Hash[Symbol, untyped] | Riffer::Messages::Assistant::ToolCall)) -> Riffer::Messages::Assistant::ToolCall
19
+ def self.from_hash: (Hash[Symbol, untyped] | Riffer::Messages::Assistant::ToolCall) -> Riffer::Messages::Assistant::ToolCall
20
+
21
+ # --
22
+ # : (call_id: String, name: String, arguments: String) -> void
23
+ def initialize: (call_id: String, name: String, arguments: String) -> void
24
+
25
+ # Serializes the call to a hash.
26
+ #
27
+ # --
28
+ # : () -> Hash[Symbol, untyped]
29
+ def to_h: () -> Hash[Symbol, untyped]
30
+
31
+ # --
32
+ # : (untyped) -> bool
33
+ def ==: (untyped) -> bool
34
+
35
+ # --
36
+ # : (untyped) -> bool
37
+ def eql?: (untyped) -> bool
38
+
39
+ # --
40
+ # : () -> Integer
41
+ def hash: () -> Integer
42
+ end
@@ -3,20 +3,23 @@
3
3
  # Represents an assistant (LLM) message in a conversation; may include tool
4
4
  # calls when the LLM requests tool execution.
5
5
  class Riffer::Messages::Assistant < Riffer::Messages::Base
6
- class ToolCall < Struct[untyped]
7
- attr_accessor call_id(): untyped
6
+ # The reasoning part types +reasoning_text+ reads; the rest carry no prose.
7
+ REASONING_TEXT_TYPES: Array[Symbol]
8
8
 
9
- attr_accessor name(): untyped
10
-
11
- attr_accessor arguments(): untyped
12
-
13
- def self.new: (?untyped call_id, ?untyped name, ?untyped arguments) -> instance
14
- | (?call_id: untyped, ?name: untyped, ?arguments: untyped) -> instance
15
- end
9
+ # Builds an Assistant message from a hash, or returns +msg+ unchanged when it
10
+ # is already an Assistant message. Raises Riffer::ArgumentError on an invalid
11
+ # tool call, reasoning part, or +finish_reason+.
12
+ # --
13
+ # : ((Hash[Symbol, untyped] | Riffer::Messages::Assistant)) -> Riffer::Messages::Assistant
14
+ def self.from_hash: (Hash[Symbol, untyped] | Riffer::Messages::Assistant) -> Riffer::Messages::Assistant
16
15
 
17
16
  # Array of tool calls requested by the assistant.
18
17
  attr_reader tool_calls: Array[Riffer::Messages::Assistant::ToolCall]
19
18
 
19
+ # The model's reasoning blocks for this response, in the order the provider
20
+ # emitted them.
21
+ attr_reader reasoning: Array[Riffer::Messages::Assistant::ReasoningPart]
22
+
20
23
  # Token usage data for this response.
21
24
  attr_reader token_usage: Riffer::Providers::TokenUsage?
22
25
 
@@ -38,12 +41,13 @@ class Riffer::Messages::Assistant < Riffer::Messages::Base
38
41
  # String,
39
42
  # ?id: String?,
40
43
  # ?tool_calls: Array[Riffer::Messages::Assistant::ToolCall],
44
+ # ?reasoning: Array[Riffer::Messages::Assistant::ReasoningPart],
41
45
  # ?token_usage: Riffer::Providers::TokenUsage?,
42
46
  # ?structured_output: Hash[Symbol, untyped]?,
43
47
  # ?finish_reason: Symbol?,
44
48
  # ?finish_reason_raw: String?
45
49
  # ) -> void
46
- def initialize: (String, ?id: String?, ?tool_calls: Array[Riffer::Messages::Assistant::ToolCall], ?token_usage: Riffer::Providers::TokenUsage?, ?structured_output: Hash[Symbol, untyped]?, ?finish_reason: Symbol?, ?finish_reason_raw: String?) -> void
50
+ def initialize: (String, ?id: String?, ?tool_calls: Array[Riffer::Messages::Assistant::ToolCall], ?reasoning: Array[Riffer::Messages::Assistant::ReasoningPart], ?token_usage: Riffer::Providers::TokenUsage?, ?structured_output: Hash[Symbol, untyped]?, ?finish_reason: Symbol?, ?finish_reason_raw: String?) -> void
47
51
 
48
52
  # --
49
53
  # : () -> Symbol
@@ -57,6 +61,16 @@ class Riffer::Messages::Assistant < Riffer::Messages::Base
57
61
  # : () -> bool
58
62
  def has_tool_calls?: () -> bool
59
63
 
64
+ # --
65
+ # : () -> bool
66
+ def reasoning?: () -> bool
67
+
68
+ # The readable reasoning across this message's +:text+ and +:summary+ parts,
69
+ # joined by blank lines, or nil when it carries none.
70
+ # --
71
+ # : () -> String?
72
+ def reasoning_text: () -> String?
73
+
60
74
  # --
61
75
  # : (Riffer::Messages::Assistant) -> Riffer::Messages::Assistant
62
76
  def +: (Riffer::Messages::Assistant) -> Riffer::Messages::Assistant
@@ -2,6 +2,12 @@
2
2
 
3
3
  # Represents a system message (instructions) in a conversation.
4
4
  class Riffer::Messages::System < Riffer::Messages::Base
5
+ # Builds a System message from a hash, or returns +msg+ unchanged when it is
6
+ # already a System message.
7
+ # --
8
+ # : ((Hash[Symbol, untyped] | Riffer::Messages::System)) -> Riffer::Messages::System
9
+ def self.from_hash: (Hash[Symbol, untyped] | Riffer::Messages::System) -> Riffer::Messages::System
10
+
5
11
  # --
6
12
  # : () -> Symbol
7
13
  def role: () -> Symbol
@@ -2,6 +2,12 @@
2
2
 
3
3
  # Represents a tool execution result in a conversation.
4
4
  class Riffer::Messages::Tool < Riffer::Messages::Base
5
+ # Builds a Tool message from a hash, or returns +msg+ unchanged when it is
6
+ # already a Tool message.
7
+ # --
8
+ # : ((Hash[Symbol, untyped] | Riffer::Messages::Tool)) -> Riffer::Messages::Tool
9
+ def self.from_hash: (Hash[Symbol, untyped] | Riffer::Messages::Tool) -> Riffer::Messages::Tool
10
+
5
11
  # The ID of the tool call this result responds to.
6
12
  attr_reader tool_call_id: String
7
13
 
@@ -1,8 +1,8 @@
1
- # Generated from lib/riffer/messages/file_part.rb with RBS::Inline
1
+ # Generated from lib/riffer/messages/user/file_part.rb with RBS::Inline
2
2
 
3
3
  # Represents a file attachment (image or document) — from a URL (+from_url+) or
4
4
  # raw base64 data (+new+).
5
- class Riffer::Messages::FilePart
5
+ class Riffer::Messages::User::FilePart
6
6
  @data_bytes: String?
7
7
 
8
8
  @downloaded_data: String?
@@ -35,15 +35,20 @@ class Riffer::Messages::FilePart
35
35
  # Creates a FilePart from a URL, detecting +media_type+ from the path
36
36
  # extension when omitted. Raises Riffer::ArgumentError if it can't be detected.
37
37
  # --
38
- # : (String, ?media_type: String?, ?filename: String?, ?sha256: String?) -> Riffer::Messages::FilePart
39
- def self.from_url: (String, ?media_type: String?, ?filename: String?, ?sha256: String?) -> Riffer::Messages::FilePart
38
+ # : (String, ?media_type: String?, ?filename: String?, ?sha256: String?) -> Riffer::Messages::User::FilePart
39
+ def self.from_url: (String, ?media_type: String?, ?filename: String?, ?sha256: String?) -> Riffer::Messages::User::FilePart
40
40
 
41
41
  # Builds a FilePart from a +{url:, media_type:}+ or +{data:, media_type:}+ hash,
42
42
  # or returns +file+ unchanged when it is already a FilePart. Raises
43
43
  # Riffer::ArgumentError on an invalid hash.
44
44
  # --
45
- # : ((Hash[Symbol, untyped] | Riffer::Messages::FilePart)) -> Riffer::Messages::FilePart
46
- def self.from_hash: (Hash[Symbol, untyped] | Riffer::Messages::FilePart) -> Riffer::Messages::FilePart
45
+ # : ((Hash[Symbol, untyped] | Riffer::Messages::User::FilePart)) -> Riffer::Messages::User::FilePart
46
+ def self.from_hash: (Hash[Symbol, untyped] | Riffer::Messages::User::FilePart) -> Riffer::Messages::User::FilePart
47
+
48
+ # Raises Riffer::ArgumentError when the URL's extension isn't a known media type.
49
+ # --
50
+ # : (String) -> String
51
+ def self.detect_media_type: (String) -> String
47
52
 
48
53
  # The base64-encoded contents - caller-supplied, or filled in by the file
49
54
  # resolver after a download. Nil for a URL source riffer hasn't fetched.
@@ -2,12 +2,18 @@
2
2
 
3
3
  # Represents a user message in a conversation.
4
4
  class Riffer::Messages::User < Riffer::Messages::Base
5
+ # Builds a User message from a hash, or returns +msg+ unchanged when it is
6
+ # already a User message. Raises Riffer::ArgumentError on an invalid file.
7
+ # --
8
+ # : ((Hash[Symbol, untyped] | Riffer::Messages::User)) -> Riffer::Messages::User
9
+ def self.from_hash: (Hash[Symbol, untyped] | Riffer::Messages::User) -> Riffer::Messages::User
10
+
5
11
  # File attachments for this message.
6
- attr_reader files: Array[Riffer::Messages::FilePart]
12
+ attr_reader files: Array[Riffer::Messages::User::FilePart]
7
13
 
8
14
  # --
9
- # : (String, ?id: String?, ?files: Array[Riffer::Messages::FilePart]) -> void
10
- def initialize: (String, ?id: String?, ?files: Array[Riffer::Messages::FilePart]) -> void
15
+ # : (String, ?id: String?, ?files: Array[Riffer::Messages::User::FilePart]) -> void
16
+ def initialize: (String, ?id: String?, ?files: Array[Riffer::Messages::User::FilePart]) -> void
11
17
 
12
18
  # --
13
19
  # : () -> Symbol
@@ -84,6 +84,13 @@ class Riffer::Params::Param
84
84
 
85
85
  private
86
86
 
87
+ # +dup+ would leave the copy sharing this one's nested Params, enum list and
88
+ # default, so defining a parameter or editing either value on one would reach
89
+ # the other.
90
+ # --
91
+ # : (Riffer::Params::Param) -> void
92
+ def initialize_copy: (Riffer::Params::Param) -> void
93
+
87
94
  # --
88
95
  # : () -> void
89
96
  def validate_strict_shape!: () -> void
@@ -62,6 +62,12 @@ class Riffer::Params
62
62
 
63
63
  private
64
64
 
65
+ # +dup+ would leave the copy sharing this one's parameters, so a caller
66
+ # defining a parameter on either would reach the other.
67
+ # --
68
+ # : (Riffer::Params) -> void
69
+ def initialize_copy: (Riffer::Params) -> void
70
+
65
71
  # --
66
72
  # : (Module, Module?) ?{ (Riffer::Params) [self: Riffer::Params] -> void } -> Riffer::Params?
67
73
  def build_nested: (Module, Module?) ?{ (Riffer::Params) [self: Riffer::Params] -> void } -> Riffer::Params?
@@ -25,8 +25,8 @@ class Riffer::Providers::AmazonBedrock < Riffer::Providers::Base
25
25
  def initialize: () -> void
26
26
 
27
27
  # --
28
- # : (Riffer::Messages::FilePart) -> Symbol
29
- def file_delivery: (Riffer::Messages::FilePart) -> Symbol
28
+ # : (Riffer::Messages::User::FilePart) -> Symbol
29
+ def file_delivery: (Riffer::Messages::User::FilePart) -> Symbol
30
30
 
31
31
  private
32
32
 
@@ -91,10 +91,19 @@ class Riffer::Providers::AmazonBedrock < Riffer::Providers::Base
91
91
  # : (Hash[Symbol, untyped], Riffer::Providers::_EventSink) -> void
92
92
  def execute_stream: (Hash[Symbol, untyped], Riffer::Providers::_EventSink) -> void
93
93
 
94
+ # Re-raises an +Aws::Errors::EventError+ event with a message built from its
95
+ # error code and message. The SDK's own +#message+ is just the class name,
96
+ # so without this the failure would be unreadable.
97
+ # --
98
+ # : (untyped) -> void
99
+ def raise_stream_event_error!: (untyped) -> void
100
+
94
101
  # Re-raises a Bedrock stream-exception event as the matching
95
102
  # +Aws::BedrockRuntime::Errors+ class. ConverseStream delivers API errors on
96
103
  # the same channel as content, so without this a mid-stream failure would
97
- # silently end the stream with no content.
104
+ # silently end the stream with no content. Non-exception events that we do
105
+ # not consume (including the SDK's +:unknown_event+ struct) are ignored for
106
+ # forward compatibility.
98
107
  # --
99
108
  # : (untyped) -> void
100
109
  def raise_if_stream_exception!: (untyped) -> void
@@ -136,8 +145,8 @@ class Riffer::Providers::AmazonBedrock < Riffer::Providers::Base
136
145
  def append_tool_result: (Array[Hash[Symbol, untyped]], Riffer::Messages::Tool) -> void
137
146
 
138
147
  # --
139
- # : (Riffer::Messages::FilePart) -> Hash[Symbol, untyped]
140
- def convert_file_part_to_bedrock_format: (Riffer::Messages::FilePart) -> Hash[Symbol, untyped]
148
+ # : (Riffer::Messages::User::FilePart) -> Hash[Symbol, untyped]
149
+ def convert_file_part_to_bedrock_format: (Riffer::Messages::User::FilePart) -> Hash[Symbol, untyped]
141
150
 
142
151
  BEDROCK_FORMAT_MAP: Hash[String, String]
143
152
 
@@ -126,8 +126,8 @@ class Riffer::Providers::Anthropic < Riffer::Providers::Base
126
126
  def convert_assistant_to_anthropic_format: (Riffer::Messages::Assistant) -> Hash[Symbol, untyped]
127
127
 
128
128
  # --
129
- # : (Riffer::Messages::FilePart) -> Hash[Symbol, untyped]
130
- def convert_file_part_to_anthropic_format: (Riffer::Messages::FilePart) -> Hash[Symbol, untyped]
129
+ # : (Riffer::Messages::User::FilePart) -> Hash[Symbol, untyped]
130
+ def convert_file_part_to_anthropic_format: (Riffer::Messages::User::FilePart) -> Hash[Symbol, untyped]
131
131
 
132
132
  # --
133
133
  # : (singleton(Riffer::Tool)) -> Hash[Symbol, untyped]
@@ -32,18 +32,18 @@ class Riffer::Providers::Base
32
32
  # Generates text using the provider.
33
33
  #
34
34
  # --
35
- # : (?prompt: String?, ?system: String?, ?messages: Array[Hash[Symbol, untyped] | Riffer::Messages::Base]?, ?model: String?, ?files: Array[Hash[Symbol, untyped] | Riffer::Messages::FilePart]?, **untyped) -> Riffer::Messages::Assistant
36
- def generate_text: (?prompt: String?, ?system: String?, ?messages: Array[Hash[Symbol, untyped] | Riffer::Messages::Base]?, ?model: String?, ?files: Array[Hash[Symbol, untyped] | Riffer::Messages::FilePart]?, **untyped) -> Riffer::Messages::Assistant
35
+ # : (?prompt: String?, ?system: String?, ?messages: Array[Hash[Symbol, untyped] | Riffer::Messages::Base]?, ?model: String?, ?files: Array[Hash[Symbol, untyped] | Riffer::Messages::User::FilePart]?, **untyped) -> Riffer::Messages::Assistant
36
+ def generate_text: (?prompt: String?, ?system: String?, ?messages: Array[Hash[Symbol, untyped] | Riffer::Messages::Base]?, ?model: String?, ?files: Array[Hash[Symbol, untyped] | Riffer::Messages::User::FilePart]?, **untyped) -> Riffer::Messages::Assistant
37
37
 
38
38
  # Streams text from the provider.
39
39
  #
40
40
  # --
41
- # : (?prompt: String?, ?system: String?, ?messages: Array[Hash[Symbol, untyped] | Riffer::Messages::Base]?, ?model: String?, ?files: Array[Hash[Symbol, untyped] | Riffer::Messages::FilePart]?, **untyped) -> Enumerator[Riffer::StreamEvents::Base, void]
42
- def stream_text: (?prompt: String?, ?system: String?, ?messages: Array[Hash[Symbol, untyped] | Riffer::Messages::Base]?, ?model: String?, ?files: Array[Hash[Symbol, untyped] | Riffer::Messages::FilePart]?, **untyped) -> Enumerator[Riffer::StreamEvents::Base, void]
41
+ # : (?prompt: String?, ?system: String?, ?messages: Array[Hash[Symbol, untyped] | Riffer::Messages::Base]?, ?model: String?, ?files: Array[Hash[Symbol, untyped] | Riffer::Messages::User::FilePart]?, **untyped) -> Enumerator[Riffer::StreamEvents::Base, void]
42
+ def stream_text: (?prompt: String?, ?system: String?, ?messages: Array[Hash[Symbol, untyped] | Riffer::Messages::Base]?, ?model: String?, ?files: Array[Hash[Symbol, untyped] | Riffer::Messages::User::FilePart]?, **untyped) -> Enumerator[Riffer::StreamEvents::Base, void]
43
43
 
44
44
  # --
45
- # : (Riffer::Messages::FilePart) -> Symbol
46
- def file_delivery: (Riffer::Messages::FilePart) -> Symbol
45
+ # : (Riffer::Messages::User::FilePart) -> Symbol
46
+ def file_delivery: (Riffer::Messages::User::FilePart) -> Symbol
47
47
 
48
48
  private
49
49
 
@@ -105,6 +105,12 @@ class Riffer::Providers::Base
105
105
  # : (untyped) -> Riffer::Providers::FinishReason?
106
106
  def extract_finish_reason: (untyped) -> Riffer::Providers::FinishReason?
107
107
 
108
+ # Defaults to no parts rather than raising — reasoning parts are optional, so
109
+ # providers that don't expose replayable reasoning stay valid.
110
+ # --
111
+ # : (untyped) -> Array[Riffer::Messages::Assistant::ReasoningPart]
112
+ def extract_reasoning: (untyped) -> Array[Riffer::Messages::Assistant::ReasoningPart]
113
+
108
114
  # --
109
115
  # : (untyped) -> String
110
116
  def extract_content: (untyped) -> String
@@ -150,6 +156,12 @@ class Riffer::Providers::Base
150
156
  # : ((Riffer::Tracing::Otel::Span | Riffer::Tracing::NoOp::Span)) -> bool
151
157
  def capture_messages?: (Riffer::Tracing::Otel::Span | Riffer::Tracing::NoOp::Span) -> bool
152
158
 
159
+ # Wraps reasoning text that an adapter cannot yet replay in a +:text+ part
160
+ # with no +format+, so it persists for display but is never sent back.
161
+ # --
162
+ # : (Riffer::Providers::_EventSink, String) -> void
163
+ def yield_reasoning_done: (Riffer::Providers::_EventSink, String) -> void
164
+
153
165
  # --
154
166
  # : (Riffer::Providers::_EventSink, Riffer::Providers::FinishReason?) -> void
155
167
  def yield_finish_reason: (Riffer::Providers::_EventSink, Riffer::Providers::FinishReason?) -> void
@@ -159,8 +171,8 @@ class Riffer::Providers::Base
159
171
  def parse_structured_output: (String) -> Hash[Symbol, untyped]?
160
172
 
161
173
  # --
162
- # : ((String | Hash[String, untyped])?) -> Hash[String, untyped]
163
- def parse_tool_arguments: ((String | Hash[String, untyped])?) -> Hash[String, untyped]
174
+ # : (String) -> Hash[String, untyped]
175
+ def parse_tool_arguments: (String) -> Hash[String, untyped]
164
176
 
165
177
  # --
166
178
  # : (Array[Riffer::Messages::Base]) -> Array[Riffer::Messages::Base]
@@ -171,8 +183,8 @@ class Riffer::Providers::Base
171
183
  def validate_input!: (prompt: String?, system: String?, messages: Array[Hash[Symbol | String, untyped] | Riffer::Messages::Base]?) -> void
172
184
 
173
185
  # --
174
- # : (prompt: String?, system: String?, messages: Array[Hash[Symbol, untyped] | Riffer::Messages::Base]?, ?files: Array[Hash[Symbol, untyped] | Riffer::Messages::FilePart]?) -> Array[Riffer::Messages::Base]
175
- def normalize_messages: (prompt: String?, system: String?, messages: Array[Hash[Symbol, untyped] | Riffer::Messages::Base]?, ?files: Array[Hash[Symbol, untyped] | Riffer::Messages::FilePart]?) -> Array[Riffer::Messages::Base]
186
+ # : (prompt: String?, system: String?, messages: Array[Hash[Symbol, untyped] | Riffer::Messages::Base]?, ?files: Array[Hash[Symbol, untyped] | Riffer::Messages::User::FilePart]?) -> Array[Riffer::Messages::Base]
187
+ def normalize_messages: (prompt: String?, system: String?, messages: Array[Hash[Symbol, untyped] | Riffer::Messages::Base]?, ?files: Array[Hash[Symbol, untyped] | Riffer::Messages::User::FilePart]?) -> Array[Riffer::Messages::Base]
176
188
 
177
189
  # --
178
190
  # : (Array[Riffer::Messages::Base]) -> void
@@ -12,8 +12,8 @@ class Riffer::Providers::Gemini < Riffer::Providers::Base
12
12
  def self.semconv_provider_name: () -> String
13
13
 
14
14
  # --
15
- # : (Riffer::Messages::FilePart) -> Symbol
16
- def file_delivery: (Riffer::Messages::FilePart) -> Symbol
15
+ # : (Riffer::Messages::User::FilePart) -> Symbol
16
+ def file_delivery: (Riffer::Messages::User::FilePart) -> Symbol
17
17
 
18
18
  private
19
19
 
@@ -74,8 +74,8 @@ class Riffer::Providers::Gemini < Riffer::Providers::Base
74
74
  def convert_assistant_to_gemini_format: (Riffer::Messages::Assistant) -> Hash[Symbol, untyped]
75
75
 
76
76
  # --
77
- # : (Riffer::Messages::FilePart) -> Hash[Symbol, untyped]
78
- def convert_file_part_to_gemini_format: (Riffer::Messages::FilePart) -> Hash[Symbol, untyped]
77
+ # : (Riffer::Messages::User::FilePart) -> Hash[Symbol, untyped]
78
+ def convert_file_part_to_gemini_format: (Riffer::Messages::User::FilePart) -> Hash[Symbol, untyped]
79
79
 
80
80
  # --
81
81
  # : (singleton(Riffer::Tool)) -> Hash[Symbol, untyped]
@@ -43,10 +43,11 @@ class Riffer::Providers::Mock < Riffer::Providers::Base
43
43
  # provider.stub_response("Final response",
44
44
  # token_usage: Riffer::Providers::TokenUsage.new(input_tokens: 10, output_tokens: 5))
45
45
  # provider.stub_response("Truncated...", finish_reason: :length)
46
+ # provider.stub_response("Answer", reasoning: [{type: :text, text: "Thinking...", format: "mock-v1"}])
46
47
  #
47
48
  # --
48
- # : (String, ?tool_calls: Array[Hash[Symbol, untyped]], ?token_usage: Riffer::Providers::TokenUsage?, ?finish_reason: Symbol?) -> void
49
- def stub_response: (String, ?tool_calls: Array[Hash[Symbol, untyped]], ?token_usage: Riffer::Providers::TokenUsage?, ?finish_reason: Symbol?) -> void
49
+ # : (String, ?tool_calls: Array[Hash[Symbol, untyped]], ?token_usage: Riffer::Providers::TokenUsage?, ?finish_reason: Symbol?, ?reasoning: Array[Hash[Symbol, untyped] | Riffer::Messages::Assistant::ReasoningPart]) -> void
50
+ def stub_response: (String, ?tool_calls: Array[Hash[Symbol, untyped]], ?token_usage: Riffer::Providers::TokenUsage?, ?finish_reason: Symbol?, ?reasoning: Array[Hash[Symbol, untyped] | Riffer::Messages::Assistant::ReasoningPart]) -> void
50
51
 
51
52
  # Clears all stubbed responses.
52
53
  #
@@ -76,6 +77,10 @@ class Riffer::Providers::Mock < Riffer::Providers::Base
76
77
  # : (untyped) -> Riffer::Providers::FinishReason?
77
78
  def extract_finish_reason: (untyped) -> Riffer::Providers::FinishReason?
78
79
 
80
+ # --
81
+ # : (untyped) -> Array[Riffer::Messages::Assistant::ReasoningPart]
82
+ def extract_reasoning: (untyped) -> Array[Riffer::Messages::Assistant::ReasoningPart]
83
+
79
84
  # --
80
85
  # : (untyped) -> String
81
86
  def extract_content: (untyped) -> String
@@ -19,8 +19,8 @@ class Riffer::Providers::OpenAI < Riffer::Providers::Base
19
19
  def initialize: () -> void
20
20
 
21
21
  # --
22
- # : (Riffer::Messages::FilePart) -> Symbol
23
- def file_delivery: (Riffer::Messages::FilePart) -> Symbol
22
+ # : (Riffer::Messages::User::FilePart) -> Symbol
23
+ def file_delivery: (Riffer::Messages::User::FilePart) -> Symbol
24
24
 
25
25
  private
26
26
 
@@ -125,8 +125,8 @@ class Riffer::Providers::OpenAI < Riffer::Providers::Base
125
125
  def convert_assistant_to_openai_format: (Riffer::Messages::Assistant) -> (Hash[Symbol, untyped] | Array[Hash[Symbol, untyped]])
126
126
 
127
127
  # --
128
- # : (Riffer::Messages::FilePart) -> Hash[Symbol, untyped]
129
- def convert_file_part_to_openai_format: (Riffer::Messages::FilePart) -> Hash[Symbol, untyped]
128
+ # : (Riffer::Messages::User::FilePart) -> Hash[Symbol, untyped]
129
+ def convert_file_part_to_openai_format: (Riffer::Messages::User::FilePart) -> Hash[Symbol, untyped]
130
130
 
131
131
  # --
132
132
  # : (singleton(Riffer::Tool)) -> Hash[Symbol, untyped]
@@ -19,8 +19,8 @@ class Riffer::Providers::OpenRouter < Riffer::Providers::Base
19
19
  def initialize: () -> void
20
20
 
21
21
  # --
22
- # : (Riffer::Messages::FilePart) -> Symbol
23
- def file_delivery: (Riffer::Messages::FilePart) -> Symbol
22
+ # : (Riffer::Messages::User::FilePart) -> Symbol
23
+ def file_delivery: (Riffer::Messages::User::FilePart) -> Symbol
24
24
 
25
25
  private
26
26
 
@@ -114,8 +114,8 @@ class Riffer::Providers::OpenRouter < Riffer::Providers::Base
114
114
  def convert_assistant_to_chat_completions_format: (Riffer::Messages::Assistant) -> Hash[Symbol, untyped]
115
115
 
116
116
  # --
117
- # : (Riffer::Messages::FilePart) -> Hash[Symbol, untyped]
118
- def convert_file_part_to_chat_completions_format: (Riffer::Messages::FilePart) -> Hash[Symbol, untyped]
117
+ # : (Riffer::Messages::User::FilePart) -> Hash[Symbol, untyped]
118
+ def convert_file_part_to_chat_completions_format: (Riffer::Messages::User::FilePart) -> Hash[Symbol, untyped]
119
119
 
120
120
  # --
121
121
  # : (singleton(Riffer::Tool)) -> Hash[Symbol, untyped]
@@ -15,8 +15,6 @@ module Riffer::Providers::Repository
15
15
  #
16
16
  # Riffer::Providers::Repository.register(:jane) { MyApp::JaneProvider }
17
17
  #
18
- # Raises Riffer::ArgumentError when called without a block.
19
- #
20
18
  # --
21
19
  # : ((String | Symbol)) { () -> singleton(Riffer::Providers::Base) } -> void
22
20
  def register: (String | Symbol) { () -> singleton(Riffer::Providers::Base) } -> void
@@ -3,6 +3,12 @@
3
3
  # Normalized token usage for an LLM API call. Buckets carry the same
4
4
  # meaning for every provider.
5
5
  class Riffer::Providers::TokenUsage
6
+ # Builds a TokenUsage from a hash, or returns +usage+ unchanged when it is
7
+ # already a TokenUsage.
8
+ # --
9
+ # : ((Hash[Symbol, untyped] | Riffer::Providers::TokenUsage)) -> Riffer::Providers::TokenUsage
10
+ def self.from_hash: (Hash[Symbol, untyped] | Riffer::Providers::TokenUsage) -> Riffer::Providers::TokenUsage
11
+
6
12
  # Number of tokens entering the context window, including cache reads and writes.
7
13
  attr_reader input_tokens: Integer
8
14
 
@@ -45,4 +45,13 @@ class Riffer::Skills::Config
45
45
  # --
46
46
  # : (?singleton(Riffer::Tool)?) -> singleton(Riffer::Tool)?
47
47
  def activate_tool: (?singleton(Riffer::Tool)?) -> singleton(Riffer::Tool)?
48
+
49
+ private
50
+
51
+ # +dup+ would leave the copy sharing this one's activation list, so activating
52
+ # a skill on either would reach the other. DeepDup rebuilds the list and
53
+ # returns a Proc as-is, which has nothing to alias.
54
+ # --
55
+ # : (Riffer::Skills::Config) -> void
56
+ def initialize_copy: (Riffer::Skills::Config) -> void
48
57
  end
@@ -1,14 +1,16 @@
1
1
  # Generated from lib/riffer/stream_events/reasoning_done.rb with RBS::Inline
2
2
 
3
- # Represents completed reasoning during streaming; only emitted by providers
4
- # that support reasoning (e.g. OpenAI with the reasoning option).
3
+ # Represents one completed reasoning block during streaming; only emitted by
4
+ # providers that support reasoning (e.g. OpenAI with the reasoning option).
5
5
  class Riffer::StreamEvents::ReasoningDone < Riffer::StreamEvents::Base
6
- # The complete reasoning content.
7
- attr_reader content: String
6
+ # The reasoning block, which the agent loop accumulates onto the assistant
7
+ # message. Its +text+ is the content the preceding ReasoningDelta events
8
+ # added up to.
9
+ attr_reader part: Riffer::Messages::Assistant::ReasoningPart
8
10
 
9
11
  # --
10
- # : (String, ?role: Symbol) -> void
11
- def initialize: (String, ?role: Symbol) -> void
12
+ # : (Riffer::Messages::Assistant::ReasoningPart, ?role: Symbol) -> void
13
+ def initialize: (Riffer::Messages::Assistant::ReasoningPart, ?role: Symbol) -> void
12
14
 
13
15
  # --
14
16
  # : () -> Hash[Symbol, untyped]
@@ -44,8 +44,8 @@ class Riffer::Tools::Runtime
44
44
  def dispatch_tool_call: (Riffer::Messages::Assistant::ToolCall, tools: Array[singleton(Riffer::Tool)], context: Riffer::Agent::Context?, ?assistant_message: Riffer::Messages::Assistant?) -> Riffer::Tools::Response
45
45
 
46
46
  # --
47
- # : (String?) -> untyped
48
- def parse_arguments: (String?) -> untyped
47
+ # : (String) -> untyped
48
+ def parse_arguments: (String) -> untyped
49
49
 
50
50
  # Emitted outside +around_tool_call+ so host enrichment spans nest beneath it.
51
51
  # --
@@ -35,12 +35,12 @@ module Riffer::Tracing::Capture
35
35
  def tool_call_part: (Riffer::Messages::Assistant::ToolCall) -> Hash[Symbol, untyped]
36
36
 
37
37
  # --
38
- # : (Riffer::Messages::FilePart) -> Hash[Symbol, untyped]
39
- def file_part: (Riffer::Messages::FilePart) -> Hash[Symbol, untyped]
38
+ # : (Riffer::Messages::User::FilePart) -> Hash[Symbol, untyped]
39
+ def file_part: (Riffer::Messages::User::FilePart) -> Hash[Symbol, untyped]
40
40
 
41
41
  # Semconv's tool_call part carries arguments as a JSON object; riffer holds
42
42
  # them as a string — parse so the captured payload isn't double-encoded.
43
43
  # --
44
- # : (untyped) -> untyped
45
- def parse_arguments: (untyped) -> untyped
44
+ # : (String) -> untyped
45
+ def parse_arguments: (String) -> untyped
46
46
  end