This repository was archived by the owner on Aug 3, 2026. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathmultimodal.go
More file actions
746 lines (616 loc) · 19.5 KB
/
Copy pathmultimodal.go
File metadata and controls
746 lines (616 loc) · 19.5 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
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
package sdk
import (
"context"
"encoding/base64"
goerrors "errors"
"fmt"
"io"
"mime"
"net/http"
"os"
"path/filepath"
"strings"
"time"
"github.com/xraph/ai-sdk/llm"
errors "github.com/xraph/go-utils/errs"
logger "github.com/xraph/go-utils/log"
"github.com/xraph/go-utils/metrics"
)
// MultiModalContentType represents the type of multi-modal content.
type MultiModalContentType string
const (
ContentTypeText MultiModalContentType = "text"
ContentTypeImage MultiModalContentType = "image"
ContentTypeAudio MultiModalContentType = "audio"
ContentTypeVideo MultiModalContentType = "video"
)
// MultiModalContent represents a piece of content in a multi-modal request.
type MultiModalContent struct {
Type MultiModalContentType
Text string // For text content
Data []byte // For binary content (images, audio, video)
MimeType string // MIME type of the content
URL string // URL to the content (alternative to Data)
Metadata map[string]any
}
// MultiModalGenerator provides a fluent API for multi-modal generation.
// Renamed from MultiModalBuilder for clarity.
type MultiModalGenerator struct {
ctx context.Context
llmManager LLMManager
logger logger.Logger
metrics metrics.Metrics
model string
contents []MultiModalContent
systemMsg string
temperature *float64
maxTokens *int
topP *float64
// Callbacks
onStart func()
onComplete func(*MultiModalResult)
onError func(error)
// Error accumulation for builder methods
errs []error
}
// MultiModalBuilder is an alias for MultiModalGenerator for backward compatibility.
// Deprecated: Use MultiModalGenerator instead.
type MultiModalBuilder = MultiModalGenerator
// MultiModalResult contains the result of a multi-modal generation.
type MultiModalResult struct {
Text string
Reasoning []string
ToolCalls []ToolCallResult
Usage Usage
Model string
FinishReason string
Metadata map[string]any
}
// NewMultiModalGenerator creates a new multi-modal generator.
func NewMultiModalGenerator(ctx context.Context, llmManager LLMManager, logger logger.Logger, metrics metrics.Metrics) *MultiModalGenerator {
temp := 0.7
tokens := 1000
topP := 1.0
return &MultiModalGenerator{
ctx: ctx,
llmManager: llmManager,
logger: logger,
metrics: metrics,
model: "gpt-4-vision",
contents: make([]MultiModalContent, 0),
temperature: &temp,
maxTokens: &tokens,
topP: &topP,
}
}
// NewMultiModalBuilder is an alias for NewMultiModalGenerator for backward compatibility.
// Deprecated: Use NewMultiModalGenerator instead.
var NewMultiModalBuilder = NewMultiModalGenerator
// WithModel sets the model to use.
func (b *MultiModalGenerator) WithModel(model string) *MultiModalGenerator {
b.model = model
return b
}
// WithText adds text content.
func (b *MultiModalGenerator) WithText(text string) *MultiModalGenerator {
b.contents = append(b.contents, MultiModalContent{
Type: ContentTypeText,
Text: text,
})
return b
}
// WithImage adds image content from bytes.
func (b *MultiModalGenerator) WithImage(data []byte, mimeType string) *MultiModalGenerator {
b.contents = append(b.contents, MultiModalContent{
Type: ContentTypeImage,
Data: data,
MimeType: mimeType,
})
return b
}
// WithImageURL adds image content from URL.
func (b *MultiModalGenerator) WithImageURL(url string) *MultiModalGenerator {
b.contents = append(b.contents, MultiModalContent{
Type: ContentTypeImage,
URL: url,
})
return b
}
// WithImageFile adds image content from file.
func (b *MultiModalGenerator) WithImageFile(path string) *MultiModalGenerator {
// Clean path to prevent directory traversal
cleanPath := filepath.Clean(path)
data, err := os.ReadFile(cleanPath)
if err != nil {
b.errs = append(b.errs, fmt.Errorf("failed to read image file %s: %w", path, err))
return b
}
mimeType := mime.TypeByExtension(filepath.Ext(cleanPath))
if mimeType == "" {
mimeType = "application/octet-stream"
}
return b.WithImage(data, mimeType)
}
// WithAudio adds audio content.
func (b *MultiModalGenerator) WithAudio(data []byte, mimeType string) *MultiModalGenerator {
b.contents = append(b.contents, MultiModalContent{
Type: ContentTypeAudio,
Data: data,
MimeType: mimeType,
})
return b
}
// WithAudioFile adds audio content from file.
func (b *MultiModalGenerator) WithAudioFile(path string) *MultiModalGenerator {
// Clean path to prevent directory traversal
cleanPath := filepath.Clean(path)
data, err := os.ReadFile(cleanPath)
if err != nil {
b.errs = append(b.errs, fmt.Errorf("failed to read audio file %s: %w", path, err))
return b
}
mimeType := mime.TypeByExtension(filepath.Ext(cleanPath))
if mimeType == "" {
mimeType = "audio/mpeg"
}
return b.WithAudio(data, mimeType)
}
// WithVideo adds video content.
func (b *MultiModalGenerator) WithVideo(data []byte, mimeType string) *MultiModalGenerator {
b.contents = append(b.contents, MultiModalContent{
Type: ContentTypeVideo,
Data: data,
MimeType: mimeType,
})
return b
}
// WithVideoFile adds video content from file.
func (b *MultiModalGenerator) WithVideoFile(path string) *MultiModalGenerator {
// Clean path to prevent directory traversal
cleanPath := filepath.Clean(path)
data, err := os.ReadFile(cleanPath)
if err != nil {
b.errs = append(b.errs, fmt.Errorf("failed to read video file %s: %w", path, err))
return b
}
mimeType := mime.TypeByExtension(filepath.Ext(cleanPath))
if mimeType == "" {
mimeType = "video/mp4"
}
return b.WithVideo(data, mimeType)
}
// WithSystemMessage sets the system message.
func (b *MultiModalGenerator) WithSystemMessage(msg string) *MultiModalGenerator {
b.systemMsg = msg
return b
}
// WithTemperature sets the temperature.
func (b *MultiModalGenerator) WithTemperature(temp float64) *MultiModalGenerator {
b.temperature = &temp
return b
}
// WithMaxTokens sets the max tokens.
func (b *MultiModalGenerator) WithMaxTokens(tokens int) *MultiModalGenerator {
b.maxTokens = &tokens
return b
}
// WithTopP sets the top-p value.
func (b *MultiModalGenerator) WithTopP(topP float64) *MultiModalGenerator {
b.topP = &topP
return b
}
// OnStart sets the start callback.
func (b *MultiModalGenerator) OnStart(fn func()) *MultiModalGenerator {
b.onStart = fn
return b
}
// OnComplete sets the complete callback.
func (b *MultiModalGenerator) OnComplete(fn func(*MultiModalResult)) *MultiModalGenerator {
b.onComplete = fn
return b
}
// OnError sets the error callback.
func (b *MultiModalGenerator) OnError(fn func(error)) *MultiModalGenerator {
b.onError = fn
return b
}
// Execute runs the multi-modal generation.
func (b *MultiModalGenerator) Execute() (*MultiModalResult, error) {
if b.onStart != nil {
b.onStart()
}
// Check for accumulated errors from builder methods
if len(b.errs) > 0 {
combinedErr := goerrors.Join(b.errs...)
if b.onError != nil {
b.onError(combinedErr)
}
return nil, combinedErr
}
if len(b.contents) == 0 {
err := errors.New("no content provided")
if b.onError != nil {
b.onError(err)
}
return nil, err
}
// Build the message with proper multi-modal content format
userMessage, err := b.buildMultiModalMessage()
if err != nil {
err = fmt.Errorf("failed to build multi-modal message: %w", err)
if b.onError != nil {
b.onError(err)
}
return nil, err
}
// Build messages
messages := []llm.ChatMessage{}
if b.systemMsg != "" {
messages = append(messages, llm.ChatMessage{
Role: "system",
Content: b.systemMsg,
})
}
messages = append(messages, userMessage)
// Make request
req := llm.ChatRequest{
Model: b.model,
Messages: messages,
Temperature: b.temperature,
MaxTokens: b.maxTokens,
TopP: b.topP,
}
resp, err := b.llmManager.Chat(b.ctx, req)
if err != nil {
err = fmt.Errorf("chat completion failed: %w", err)
if b.onError != nil {
b.onError(err)
}
return nil, err
}
// Extract result
result := &MultiModalResult{
Model: resp.Model,
Metadata: make(map[string]any),
}
if len(resp.Choices) > 0 {
choice := resp.Choices[0]
result.Text = choice.Message.Content
result.FinishReason = choice.FinishReason
// Extract tool calls if any
if len(choice.Message.ToolCalls) > 0 {
result.ToolCalls = make([]ToolCallResult, len(choice.Message.ToolCalls))
for i, tc := range choice.Message.ToolCalls {
result.ToolCalls[i] = ToolCallResult{
Name: tc.Function.Name,
Arguments: tc.Function.Parsed,
}
}
}
}
// Extract usage
if resp.Usage != nil {
result.Usage = Usage{
Provider: "",
Model: resp.Model,
InputTokens: int(resp.Usage.InputTokens),
OutputTokens: int(resp.Usage.OutputTokens),
TotalTokens: int(resp.Usage.TotalTokens),
Timestamp: time.Now(),
}
}
// Log metrics
if b.metrics != nil {
b.metrics.Counter("forge.ai.sdk.multimodal.requests", metrics.WithLabel("model", b.model)).Inc()
b.metrics.Gauge("forge.ai.sdk.multimodal.tokens", metrics.WithLabel("model", b.model), metrics.WithLabel("type", "total")).Set(float64(result.Usage.TotalTokens))
}
if b.logger != nil {
b.logger.Info("multi-modal generation complete",
logger.String("model", b.model),
logger.Int("input_tokens", result.Usage.InputTokens),
logger.Int("output_tokens", result.Usage.OutputTokens),
logger.Int("content_count", len(b.contents)),
)
}
if b.onComplete != nil {
b.onComplete(result)
}
return result, nil
}
// MultiModalContentPart represents a single part of multi-modal content.
// This follows the OpenAI API format for multi-modal messages.
type MultiModalContentPart struct {
Type string `json:"type"` // "text", "image_url", "audio"
Text string `json:"text,omitempty"`
ImageURL *ImageURLPart `json:"image_url,omitempty"`
Audio *AudioPart `json:"audio,omitempty"`
Video *VideoPart `json:"video,omitempty"`
}
// ImageURLPart represents an image URL in multi-modal content.
type ImageURLPart struct {
URL string `json:"url"` // Can be a URL or data:... base64 string
Detail string `json:"detail,omitempty"` // "low", "high", "auto"
}
// AudioPart represents audio content.
type AudioPart struct {
Data string `json:"data,omitempty"` // base64-encoded audio data
URL string `json:"url,omitempty"`
Format string `json:"format,omitempty"` // e.g., "mp3", "wav"
}
// VideoPart represents video content.
type VideoPart struct {
Data string `json:"data,omitempty"` // base64-encoded video data
URL string `json:"url,omitempty"`
Format string `json:"format,omitempty"` // e.g., "mp4", "webm"
}
// buildMultiModalMessage builds a chat message with proper multi-modal content.
func (b *MultiModalGenerator) buildMultiModalMessage() (llm.ChatMessage, error) {
contentParts := make([]MultiModalContentPart, 0, len(b.contents))
for _, content := range b.contents {
part, err := b.buildContentPart(content)
if err != nil {
return llm.ChatMessage{}, err
}
contentParts = append(contentParts, part)
}
// For most LLMs, the multi-modal content is stored in metadata
// The actual format depends on the provider
message := llm.ChatMessage{
Role: "user",
Content: b.buildTextContent(contentParts), // Fallback text for non-multimodal models
Metadata: map[string]any{
"multimodal_content": contentParts,
"content_type": "multimodal",
},
}
return message, nil
}
// buildContentPart builds a single content part.
func (b *MultiModalGenerator) buildContentPart(content MultiModalContent) (MultiModalContentPart, error) {
switch content.Type {
case ContentTypeText:
return MultiModalContentPart{
Type: "text",
Text: content.Text,
}, nil
case ContentTypeImage:
part := MultiModalContentPart{
Type: "image_url",
ImageURL: &ImageURLPart{Detail: "auto"},
}
if content.URL != "" {
part.ImageURL.URL = content.URL
} else if len(content.Data) > 0 {
// Create data URL
encoded := base64.StdEncoding.EncodeToString(content.Data)
mimeType := content.MimeType
if mimeType == "" {
mimeType = "image/png"
}
part.ImageURL.URL = fmt.Sprintf("data:%s;base64,%s", mimeType, encoded)
} else {
return MultiModalContentPart{}, errors.New("image content has no data or URL")
}
return part, nil
case ContentTypeAudio:
part := MultiModalContentPart{
Type: "audio",
Audio: &AudioPart{},
}
if content.URL != "" {
part.Audio.URL = content.URL
} else if len(content.Data) > 0 {
part.Audio.Data = base64.StdEncoding.EncodeToString(content.Data)
part.Audio.Format = mimeToFormat(content.MimeType)
} else {
return MultiModalContentPart{}, errors.New("audio content has no data or URL")
}
return part, nil
case ContentTypeVideo:
part := MultiModalContentPart{
Type: "video",
Video: &VideoPart{},
}
if content.URL != "" {
part.Video.URL = content.URL
} else if len(content.Data) > 0 {
part.Video.Data = base64.StdEncoding.EncodeToString(content.Data)
part.Video.Format = mimeToFormat(content.MimeType)
} else {
return MultiModalContentPart{}, errors.New("video content has no data or URL")
}
return part, nil
default:
return MultiModalContentPart{}, fmt.Errorf("unsupported content type: %s", content.Type)
}
}
// buildTextContent creates a text representation for fallback.
func (b *MultiModalGenerator) buildTextContent(parts []MultiModalContentPart) string {
var texts []string
for _, part := range parts {
switch part.Type {
case "text":
texts = append(texts, part.Text)
case "image_url":
texts = append(texts, "[Image content attached]")
case "audio":
texts = append(texts, "[Audio content attached]")
case "video":
texts = append(texts, "[Video content attached]")
}
}
return strings.Join(texts, "\n")
}
// mimeToFormat extracts format from MIME type.
func mimeToFormat(mimeType string) string {
parts := strings.Split(mimeType, "/")
if len(parts) == 2 {
return parts[1]
}
return ""
}
// DownloadFromURL downloads content from a URL.
func DownloadFromURL(ctx context.Context, url string) ([]byte, string, error) {
req, err := http.NewRequestWithContext(ctx, http.MethodGet, url, nil)
if err != nil {
return nil, "", fmt.Errorf("failed to create request: %w", err)
}
resp, err := http.DefaultClient.Do(req)
if err != nil {
return nil, "", fmt.Errorf("failed to download: %w", err)
}
defer func() { _ = resp.Body.Close() }()
if resp.StatusCode != http.StatusOK {
return nil, "", fmt.Errorf("unexpected status code: %d", resp.StatusCode)
}
data, err := io.ReadAll(resp.Body)
if err != nil {
return nil, "", fmt.Errorf("failed to read response: %w", err)
}
mimeType := resp.Header.Get("Content-Type")
if mimeType == "" {
mimeType = "application/octet-stream"
}
return data, mimeType, nil
}
// VisionAnalyzer provides specialized vision analysis capabilities.
type VisionAnalyzer struct {
llmManager LLMManager
logger logger.Logger
metrics metrics.Metrics
}
// NewVisionAnalyzer creates a new vision analyzer.
func NewVisionAnalyzer(llmManager LLMManager, logger logger.Logger, metrics metrics.Metrics) *VisionAnalyzer {
return &VisionAnalyzer{
llmManager: llmManager,
logger: logger,
metrics: metrics,
}
}
// DescribeImage analyzes and describes an image.
func (va *VisionAnalyzer) DescribeImage(ctx context.Context, imageData []byte, mimeType string) (string, error) {
builder := NewMultiModalBuilder(ctx, va.llmManager, va.logger, va.metrics)
result, err := builder.
WithImage(imageData, mimeType).
WithText("Please provide a detailed description of this image.").
Execute()
if err != nil {
return "", err
}
return result.Text, nil
}
// DetectObjects detects objects in an image.
func (va *VisionAnalyzer) DetectObjects(ctx context.Context, imageData []byte, mimeType string) ([]string, error) {
builder := NewMultiModalBuilder(ctx, va.llmManager, va.logger, va.metrics)
result, err := builder.
WithImage(imageData, mimeType).
WithText("List all the objects you can see in this image. Provide a comma-separated list.").
Execute()
if err != nil {
return nil, err
}
// Parse comma-separated list
objects := strings.Split(result.Text, ",")
for i := range objects {
objects[i] = strings.TrimSpace(objects[i])
}
return objects, nil
}
// ReadText extracts text from an image (OCR).
func (va *VisionAnalyzer) ReadText(ctx context.Context, imageData []byte, mimeType string) (string, error) {
builder := NewMultiModalBuilder(ctx, va.llmManager, va.logger, va.metrics)
result, err := builder.
WithImage(imageData, mimeType).
WithText("Extract all text visible in this image. Provide only the extracted text.").
Execute()
if err != nil {
return "", err
}
return result.Text, nil
}
// CompareImages compares two images and describes differences.
func (va *VisionAnalyzer) CompareImages(ctx context.Context, img1, img2 []byte, mimeType string) (string, error) {
builder := NewMultiModalBuilder(ctx, va.llmManager, va.logger, va.metrics)
result, err := builder.
WithImage(img1, mimeType).
WithImage(img2, mimeType).
WithText("Compare these two images and describe the key differences.").
Execute()
if err != nil {
return "", err
}
return result.Text, nil
}
// AudioTranscriber provides audio transcription capabilities.
type AudioTranscriber struct {
llmManager LLMManager
logger logger.Logger
metrics metrics.Metrics
}
// NewAudioTranscriber creates a new audio transcriber.
func NewAudioTranscriber(llmManager LLMManager, logger logger.Logger, metrics metrics.Metrics) *AudioTranscriber {
return &AudioTranscriber{
llmManager: llmManager,
logger: logger,
metrics: metrics,
}
}
// Transcribe transcribes audio to text.
func (at *AudioTranscriber) Transcribe(ctx context.Context, audioData []byte, language string) (string, error) {
// This would integrate with Whisper or similar audio transcription models
builder := NewMultiModalBuilder(ctx, at.llmManager, at.logger, at.metrics)
result, err := builder.
WithAudio(audioData, "audio/mpeg").
WithText("Transcribe this audio to text. Language: " + language).
Execute()
if err != nil {
return "", err
}
return result.Text, nil
}
// TranscribeWithTimestamps transcribes audio with timestamps.
func (at *AudioTranscriber) TranscribeWithTimestamps(ctx context.Context, audioData []byte, language string) ([]TranscriptSegment, error) {
builder := NewMultiModalBuilder(ctx, at.llmManager, at.logger, at.metrics)
result, err := builder.
WithAudio(audioData, "audio/mpeg").
WithText(fmt.Sprintf("Transcribe this audio to text with timestamps. Language: %s. Format: [00:00] text", language)).
Execute()
if err != nil {
return nil, err
}
// Parse timestamped segments
segments := parseTimestampedTranscript(result.Text)
return segments, nil
}
// TranscriptSegment represents a segment of transcribed audio with timestamp.
type TranscriptSegment struct {
Start time.Duration
End time.Duration
Text string
}
// parseTimestampedTranscript parses timestamped transcript text.
func parseTimestampedTranscript(text string) []TranscriptSegment {
// Simple parser for [MM:SS] format
segments := []TranscriptSegment{}
lines := strings.SplitSeq(text, "\n")
for line := range lines {
line = strings.TrimSpace(line)
if line == "" {
continue
}
// Look for [MM:SS] pattern
if strings.HasPrefix(line, "[") && strings.Contains(line, "]") {
endIdx := strings.Index(line, "]")
timestamp := line[1:endIdx]
text := strings.TrimSpace(line[endIdx+1:])
// Parse timestamp (simple MM:SS format)
parts := strings.Split(timestamp, ":")
if len(parts) == 2 {
segments = append(segments, TranscriptSegment{
Text: text,
})
}
}
}
return segments
}