forked from charmbracelet/fantasy
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathobject.go
More file actions
236 lines (198 loc) · 6.28 KB
/
object.go
File metadata and controls
236 lines (198 loc) · 6.28 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
package fantasy
import (
"context"
"encoding/json"
"fmt"
"iter"
"reflect"
"charm.land/fantasy/schema"
)
// ObjectMode specifies how structured output should be generated.
type ObjectMode string
const (
// ObjectModeAuto lets the provider choose the best approach.
ObjectModeAuto ObjectMode = "auto"
// ObjectModeJSON forces the use of native JSON mode (if supported).
ObjectModeJSON ObjectMode = "json"
// ObjectModeTool forces the use of tool-based approach.
ObjectModeTool ObjectMode = "tool"
// ObjectModeText uses text generation with schema in prompt (fallback for models without tool/JSON support).
ObjectModeText ObjectMode = "text"
)
// ObjectCall represents a request to generate a structured object.
type ObjectCall struct {
Prompt Prompt
Schema Schema
SchemaName string
SchemaDescription string
MaxOutputTokens *int64
Temperature *float64
TopP *float64
TopK *int64
PresencePenalty *float64
FrequencyPenalty *float64
// UserAgent overrides the provider-level User-Agent header for this call.
UserAgent string `json:"-"`
ProviderOptions ProviderOptions
RepairText schema.ObjectRepairFunc
}
// ObjectResponse represents the response from a structured object generation.
type ObjectResponse struct {
Object any
RawText string
Usage Usage
FinishReason FinishReason
Warnings []CallWarning
ProviderMetadata ProviderMetadata
}
// ObjectStreamPartType indicates the type of stream part.
type ObjectStreamPartType string
const (
// ObjectStreamPartTypeObject is emitted when a new partial object is available.
ObjectStreamPartTypeObject ObjectStreamPartType = "object"
// ObjectStreamPartTypeTextDelta is emitted for text deltas (if model generates text).
ObjectStreamPartTypeTextDelta ObjectStreamPartType = "text-delta"
// ObjectStreamPartTypeError is emitted when an error occurs.
ObjectStreamPartTypeError ObjectStreamPartType = "error"
// ObjectStreamPartTypeFinish is emitted when streaming completes.
ObjectStreamPartTypeFinish ObjectStreamPartType = "finish"
)
// ObjectStreamPart represents a single chunk in the object stream.
type ObjectStreamPart struct {
Type ObjectStreamPartType
Object any
Delta string
Error error
Usage Usage
FinishReason FinishReason
Warnings []CallWarning
ProviderMetadata ProviderMetadata
}
// ObjectStreamResponse is an iterator over ObjectStreamPart.
type ObjectStreamResponse = iter.Seq[ObjectStreamPart]
// ObjectResult is a typed result wrapper returned by GenerateObject[T].
type ObjectResult[T any] struct {
Object T
RawText string
Usage Usage
FinishReason FinishReason
Warnings []CallWarning
ProviderMetadata ProviderMetadata
}
// StreamObjectResult provides typed access to a streaming object generation result.
type StreamObjectResult[T any] struct {
stream ObjectStreamResponse
ctx context.Context
}
// NewStreamObjectResult creates a typed stream result from an untyped stream.
func NewStreamObjectResult[T any](ctx context.Context, stream ObjectStreamResponse) *StreamObjectResult[T] {
return &StreamObjectResult[T]{
stream: stream,
ctx: ctx,
}
}
// PartialObjectStream returns an iterator that yields progressively more complete objects.
// Only emits when the object actually changes (deduplication).
func (s *StreamObjectResult[T]) PartialObjectStream() iter.Seq[T] {
return func(yield func(T) bool) {
var lastObject T
var hasEmitted bool
for part := range s.stream {
if part.Type == ObjectStreamPartTypeObject && part.Object != nil {
var current T
if err := unmarshalObject(part.Object, ¤t); err != nil {
continue
}
if !hasEmitted || !reflect.DeepEqual(current, lastObject) {
if !yield(current) {
return
}
lastObject = current
hasEmitted = true
}
}
}
}
}
// TextStream returns an iterator that yields text deltas.
// Useful if the model generates explanatory text alongside the object.
func (s *StreamObjectResult[T]) TextStream() iter.Seq[string] {
return func(yield func(string) bool) {
for part := range s.stream {
if part.Type == ObjectStreamPartTypeTextDelta && part.Delta != "" {
if !yield(part.Delta) {
return
}
}
}
}
}
// FullStream returns an iterator that yields all stream parts including errors and metadata.
func (s *StreamObjectResult[T]) FullStream() iter.Seq[ObjectStreamPart] {
return s.stream
}
// Object waits for the stream to complete and returns the final object.
// Returns an error if streaming fails or no valid object was generated.
func (s *StreamObjectResult[T]) Object() (*ObjectResult[T], error) {
var finalObject T
var usage Usage
var finishReason FinishReason
var warnings []CallWarning
var providerMetadata ProviderMetadata
var rawText string
var lastError error
hasObject := false
for part := range s.stream {
switch part.Type {
case ObjectStreamPartTypeObject:
if part.Object != nil {
if err := unmarshalObject(part.Object, &finalObject); err == nil {
hasObject = true
if jsonBytes, err := json.Marshal(part.Object); err == nil {
rawText = string(jsonBytes)
}
}
}
case ObjectStreamPartTypeError:
lastError = part.Error
case ObjectStreamPartTypeFinish:
usage = part.Usage
finishReason = part.FinishReason
if len(part.Warnings) > 0 {
warnings = part.Warnings
}
if len(part.ProviderMetadata) > 0 {
providerMetadata = part.ProviderMetadata
}
}
}
if lastError != nil {
return nil, lastError
}
if !hasObject {
return nil, &NoObjectGeneratedError{
RawText: rawText,
ParseError: fmt.Errorf("no valid object generated in stream"),
Usage: usage,
FinishReason: finishReason,
}
}
return &ObjectResult[T]{
Object: finalObject,
RawText: rawText,
Usage: usage,
FinishReason: finishReason,
Warnings: warnings,
ProviderMetadata: providerMetadata,
}, nil
}
func unmarshalObject(obj any, target any) error {
jsonBytes, err := json.Marshal(obj)
if err != nil {
return fmt.Errorf("failed to marshal object: %w", err)
}
if err := json.Unmarshal(jsonBytes, target); err != nil {
return fmt.Errorf("failed to unmarshal into target type: %w", err)
}
return nil
}