types.go 21.7 KB
Newer Older
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1
2
package api

3
import (
Michael Yang's avatar
Michael Yang committed
4
	"encoding/json"
5
	"fmt"
6
	"log/slog"
Michael Yang's avatar
Michael Yang committed
7
	"math"
8
	"os"
9
	"reflect"
10
	"strconv"
11
	"strings"
12
13
	"time"
)
Michael Yang's avatar
Michael Yang committed
14

15
// StatusError is an error with an HTTP status code and message.
Patrick Devine's avatar
Patrick Devine committed
16
type StatusError struct {
17
18
19
	StatusCode   int
	Status       string
	ErrorMessage string `json:"error"`
Patrick Devine's avatar
Patrick Devine committed
20
21
22
}

func (e StatusError) Error() string {
23
24
25
26
27
28
29
30
31
32
	switch {
	case e.Status != "" && e.ErrorMessage != "":
		return fmt.Sprintf("%s: %s", e.Status, e.ErrorMessage)
	case e.Status != "":
		return e.Status
	case e.ErrorMessage != "":
		return e.ErrorMessage
	default:
		// this should not happen
		return "something went wrong, please see the ollama server logs for details"
Patrick Devine's avatar
Patrick Devine committed
33
34
35
	}
}

36
// ImageData represents the raw binary data of an image file.
Patrick Devine's avatar
Patrick Devine committed
37
38
type ImageData []byte

39
40
41
// GenerateRequest describes a request sent by [Client.Generate]. While you
// have to specify the Model and Prompt fields, all the other fields have
// reasonable defaults for basic uses.
42
type GenerateRequest struct {
43
44
45
	// Model is the model name; it should be a name familiar to Ollama from
	// the library at https://ollama.com/library
	Model string `json:"model"`
46

47
48
49
	// Prompt is the textual prompt to send to the model.
	Prompt string `json:"prompt"`

50
51
52
	// Suffix is the text that comes after the inserted text.
	Suffix string `json:"suffix"`

53
54
55
56
57
58
59
	// System overrides the model's default system message/prompt.
	System string `json:"system"`

	// Template overrides the model's default prompt template.
	Template string `json:"template"`

	// Context is the context parameter returned from a previous call to
60
	// [Client.Generate]. It can be used to keep a short conversational memory.
61
62
63
64
65
66
67
68
69
	Context []int `json:"context,omitempty"`

	// Stream specifies whether the response is streaming; it is true by default.
	Stream *bool `json:"stream,omitempty"`

	// Raw set to true means that no formatting will be applied to the prompt.
	Raw bool `json:"raw,omitempty"`

	// Format specifies the format to return a response in.
70
	Format json.RawMessage `json:"format,omitempty"`
71
72
73
74
75
76
77
78
79
80
81

	// KeepAlive controls how long the model will stay loaded in memory following
	// this request.
	KeepAlive *Duration `json:"keep_alive,omitempty"`

	// Images is an optional list of base64-encoded images accompanying this
	// request, for multimodal models.
	Images []ImageData `json:"images,omitempty"`

	// Options lists model-specific options. For example, temperature can be
	// set through this field, if the model supports it.
82
	Options map[string]interface{} `json:"options"`
83
84
}

85
// ChatRequest describes a request sent by [Client.Chat].
Bruce MacDonald's avatar
Bruce MacDonald committed
86
type ChatRequest struct {
87
88
89
90
91
92
	// Model is the model name, as in [GenerateRequest].
	Model string `json:"model"`

	// Messages is the messages of the chat - can be used to keep a chat memory.
	Messages []Message `json:"messages"`

93
	// Stream enables streaming of returned responses; true by default.
94
95
96
	Stream *bool `json:"stream,omitempty"`

	// Format is the format to return the response in (e.g. "json").
97
	Format json.RawMessage `json:"format,omitempty"`
98
99

	// KeepAlive controls how long the model will stay loaded into memory
100
	// following the request.
101
	KeepAlive *Duration `json:"keep_alive,omitempty"`
Bruce MacDonald's avatar
Bruce MacDonald committed
102

Michael Yang's avatar
tools  
Michael Yang committed
103
	// Tools is an optional list of tools the model has access to.
104
	Tools `json:"tools,omitempty"`
Michael Yang's avatar
tools  
Michael Yang committed
105

106
	// Options lists model-specific options.
Bruce MacDonald's avatar
Bruce MacDonald committed
107
108
109
	Options map[string]interface{} `json:"options"`
}

110
111
112
113
114
115
116
type Tools []Tool

func (t Tools) String() string {
	bts, _ := json.Marshal(t)
	return string(bts)
}

117
118
119
120
121
func (t Tool) String() string {
	bts, _ := json.Marshal(t)
	return string(bts)
}

122
123
124
// Message is a single message in a chat sequence. The message contains the
// role ("system", "user", or "assistant"), the content and an optional list
// of images.
Bruce MacDonald's avatar
Bruce MacDonald committed
125
type Message struct {
Michael Yang's avatar
tools  
Michael Yang committed
126
	Role      string      `json:"role"`
127
	Content   string      `json:"content"`
Michael Yang's avatar
tools  
Michael Yang committed
128
129
130
131
	Images    []ImageData `json:"images,omitempty"`
	ToolCalls []ToolCall  `json:"tool_calls,omitempty"`
}

132
133
134
135
136
137
138
139
140
141
142
143
func (m *Message) UnmarshalJSON(b []byte) error {
	type Alias Message
	var a Alias
	if err := json.Unmarshal(b, &a); err != nil {
		return err
	}

	*m = Message(a)
	m.Role = strings.ToLower(m.Role)
	return nil
}

144
145
146
147
148
type ToolCall struct {
	Function ToolCallFunction `json:"function"`
}

type ToolCallFunction struct {
149
	Index     int                       `json:"index,omitempty"`
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
	Name      string                    `json:"name"`
	Arguments ToolCallFunctionArguments `json:"arguments"`
}

type ToolCallFunctionArguments map[string]any

func (t *ToolCallFunctionArguments) String() string {
	bts, _ := json.Marshal(t)
	return string(bts)
}

type Tool struct {
	Type     string       `json:"type"`
	Function ToolFunction `json:"function"`
}

type ToolFunction struct {
	Name        string `json:"name"`
	Description string `json:"description"`
	Parameters  struct {
		Type       string   `json:"type"`
		Required   []string `json:"required"`
		Properties map[string]struct {
			Type        string   `json:"type"`
			Description string   `json:"description"`
			Enum        []string `json:"enum,omitempty"`
		} `json:"properties"`
	} `json:"parameters"`
}

func (t *ToolFunction) String() string {
	bts, _ := json.Marshal(t)
	return string(bts)
}

185
186
// ChatResponse is the response returned by [Client.Chat]. Its fields are
// similar to [GenerateResponse].
Bruce MacDonald's avatar
Bruce MacDonald committed
187
type ChatResponse struct {
188
189
190
	Model      string    `json:"model"`
	CreatedAt  time.Time `json:"created_at"`
	Message    Message   `json:"message"`
Bruce MacDonald's avatar
Bruce MacDonald committed
191
	DoneReason string    `json:"done_reason,omitempty"`
Bruce MacDonald's avatar
Bruce MacDonald committed
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206

	Done bool `json:"done"`

	Metrics
}

type Metrics struct {
	TotalDuration      time.Duration `json:"total_duration,omitempty"`
	LoadDuration       time.Duration `json:"load_duration,omitempty"`
	PromptEvalCount    int           `json:"prompt_eval_count,omitempty"`
	PromptEvalDuration time.Duration `json:"prompt_eval_duration,omitempty"`
	EvalCount          int           `json:"eval_count,omitempty"`
	EvalDuration       time.Duration `json:"eval_duration,omitempty"`
}

207
208
// Options specified in [GenerateRequest].  If you add a new option here, also
// add it to the API docs.
209
210
211
212
213
214
215
216
217
type Options struct {
	Runner

	// Predict options used at runtime
	NumKeep          int      `json:"num_keep,omitempty"`
	Seed             int      `json:"seed,omitempty"`
	NumPredict       int      `json:"num_predict,omitempty"`
	TopK             int      `json:"top_k,omitempty"`
	TopP             float32  `json:"top_p,omitempty"`
218
	MinP             float32  `json:"min_p,omitempty"`
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
	TypicalP         float32  `json:"typical_p,omitempty"`
	RepeatLastN      int      `json:"repeat_last_n,omitempty"`
	Temperature      float32  `json:"temperature,omitempty"`
	RepeatPenalty    float32  `json:"repeat_penalty,omitempty"`
	PresencePenalty  float32  `json:"presence_penalty,omitempty"`
	FrequencyPenalty float32  `json:"frequency_penalty,omitempty"`
	Mirostat         int      `json:"mirostat,omitempty"`
	MirostatTau      float32  `json:"mirostat_tau,omitempty"`
	MirostatEta      float32  `json:"mirostat_eta,omitempty"`
	PenalizeNewline  bool     `json:"penalize_newline,omitempty"`
	Stop             []string `json:"stop,omitempty"`
}

// Runner options which must be set when the model is loaded into memory
type Runner struct {
234
235
236
237
238
	NumCtx    int   `json:"num_ctx,omitempty"`
	NumBatch  int   `json:"num_batch,omitempty"`
	NumGPU    int   `json:"num_gpu,omitempty"`
	MainGPU   int   `json:"main_gpu,omitempty"`
	LowVRAM   bool  `json:"low_vram,omitempty"`
239
	F16KV     bool  `json:"f16_kv,omitempty"` // Deprecated: This option is ignored
240
241
242
243
244
	LogitsAll bool  `json:"logits_all,omitempty"`
	VocabOnly bool  `json:"vocab_only,omitempty"`
	UseMMap   *bool `json:"use_mmap,omitempty"`
	UseMLock  bool  `json:"use_mlock,omitempty"`
	NumThread int   `json:"num_thread,omitempty"`
245
246
}

247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
// EmbedRequest is the request passed to [Client.Embed].
type EmbedRequest struct {
	// Model is the model name.
	Model string `json:"model"`

	// Input is the input to embed.
	Input any `json:"input"`

	// KeepAlive controls how long the model will stay loaded in memory following
	// this request.
	KeepAlive *Duration `json:"keep_alive,omitempty"`

	Truncate *bool `json:"truncate,omitempty"`

	// Options lists model-specific options.
	Options map[string]interface{} `json:"options"`
}

// EmbedResponse is the response from [Client.Embed].
type EmbedResponse struct {
	Model      string      `json:"model"`
268
	Embeddings [][]float32 `json:"embeddings"`
269
270
271
272

	TotalDuration   time.Duration `json:"total_duration,omitempty"`
	LoadDuration    time.Duration `json:"load_duration,omitempty"`
	PromptEvalCount int           `json:"prompt_eval_count,omitempty"`
273
274
}

275
// EmbeddingRequest is the request passed to [Client.Embeddings].
Bruce MacDonald's avatar
Bruce MacDonald committed
276
type EmbeddingRequest struct {
277
278
279
280
281
282
283
284
	// Model is the model name.
	Model string `json:"model"`

	// Prompt is the textual prompt to embed.
	Prompt string `json:"prompt"`

	// KeepAlive controls how long the model will stay loaded in memory following
	// this request.
285
	KeepAlive *Duration `json:"keep_alive,omitempty"`
Bruce MacDonald's avatar
Bruce MacDonald committed
286

287
	// Options lists model-specific options.
Bruce MacDonald's avatar
Bruce MacDonald committed
288
289
290
	Options map[string]interface{} `json:"options"`
}

291
// EmbeddingResponse is the response from [Client.Embeddings].
Bruce MacDonald's avatar
Bruce MacDonald committed
292
293
294
295
type EmbeddingResponse struct {
	Embedding []float64 `json:"embedding"`
}

296
// CreateRequest is the request passed to [Client.Create].
297
type CreateRequest struct {
298
299
300
301
302
303
304
305
306
307
308
309
310
	Model    string `json:"model"`
	Stream   *bool  `json:"stream,omitempty"`
	Quantize string `json:"quantize,omitempty"`

	From       string            `json:"from,omitempty"`
	Files      map[string]string `json:"files,omitempty"`
	Adapters   map[string]string `json:"adapters,omitempty"`
	Template   string            `json:"template,omitempty"`
	License    any               `json:"license,omitempty"`
	System     string            `json:"system,omitempty"`
	Parameters map[string]any    `json:"parameters,omitempty"`
	Messages   []Message         `json:"messages,omitempty"`

Michael Yang's avatar
Michael Yang committed
311
	// Deprecated: set the model name with Model instead
Michael Yang's avatar
Michael Yang committed
312
	Name string `json:"name"`
Michael Yang's avatar
Michael Yang committed
313
	// Deprecated: use Quantize instead
314
	Quantization string `json:"quantization,omitempty"`
315
316
}

317
// DeleteRequest is the request passed to [Client.Delete].
318
type DeleteRequest struct {
Michael Yang's avatar
Michael Yang committed
319
320
	Model string `json:"model"`

Michael Yang's avatar
Michael Yang committed
321
	// Deprecated: set the model name with Model instead
322
323
324
	Name string `json:"name"`
}

325
// ShowRequest is the request passed to [Client.Show].
Patrick Devine's avatar
Patrick Devine committed
326
type ShowRequest struct {
327
328
	Model  string `json:"model"`
	System string `json:"system"`
Patrick Devine's avatar
Patrick Devine committed
329
330

	// Template is deprecated
331
	Template string `json:"template"`
332
	Verbose  bool   `json:"verbose"`
333
334

	Options map[string]interface{} `json:"options"`
Michael Yang's avatar
Michael Yang committed
335

Michael Yang's avatar
Michael Yang committed
336
	// Deprecated: set the model name with Model instead
Michael Yang's avatar
Michael Yang committed
337
	Name string `json:"name"`
Patrick Devine's avatar
Patrick Devine committed
338
339
}

340
// ShowResponse is the response returned from [Client.Show].
Patrick Devine's avatar
Patrick Devine committed
341
type ShowResponse struct {
342
343
344
345
346
347
348
349
350
351
	License       string         `json:"license,omitempty"`
	Modelfile     string         `json:"modelfile,omitempty"`
	Parameters    string         `json:"parameters,omitempty"`
	Template      string         `json:"template,omitempty"`
	System        string         `json:"system,omitempty"`
	Details       ModelDetails   `json:"details,omitempty"`
	Messages      []Message      `json:"messages,omitempty"`
	ModelInfo     map[string]any `json:"model_info,omitempty"`
	ProjectorInfo map[string]any `json:"projector_info,omitempty"`
	ModifiedAt    time.Time      `json:"modified_at,omitempty"`
Patrick Devine's avatar
Patrick Devine committed
352
353
}

354
// CopyRequest is the request passed to [Client.Copy].
Patrick Devine's avatar
Patrick Devine committed
355
356
357
358
359
type CopyRequest struct {
	Source      string `json:"source"`
	Destination string `json:"destination"`
}

360
// PullRequest is the request passed to [Client.Pull].
Bruce MacDonald's avatar
Bruce MacDonald committed
361
type PullRequest struct {
Michael Yang's avatar
Michael Yang committed
362
	Model    string `json:"model"`
363
	Insecure bool   `json:"insecure,omitempty"`
364
365
366
	Username string `json:"username"`
	Password string `json:"password"`
	Stream   *bool  `json:"stream,omitempty"`
Michael Yang's avatar
Michael Yang committed
367

Michael Yang's avatar
Michael Yang committed
368
	// Deprecated: set the model name with Model instead
Michael Yang's avatar
Michael Yang committed
369
	Name string `json:"name"`
Bruce MacDonald's avatar
Bruce MacDonald committed
370
371
}

372
373
// ProgressResponse is the response passed to progress functions like
// [PullProgressFunc] and [PushProgressFunc].
374
type ProgressResponse struct {
375
376
	Status    string `json:"status"`
	Digest    string `json:"digest,omitempty"`
Michael Yang's avatar
Michael Yang committed
377
378
	Total     int64  `json:"total,omitempty"`
	Completed int64  `json:"completed,omitempty"`
Bruce MacDonald's avatar
Bruce MacDonald committed
379
380
}

381
// PushRequest is the request passed to [Client.Push].
382
type PushRequest struct {
Michael Yang's avatar
Michael Yang committed
383
	Model    string `json:"model"`
384
	Insecure bool   `json:"insecure,omitempty"`
385
386
387
	Username string `json:"username"`
	Password string `json:"password"`
	Stream   *bool  `json:"stream,omitempty"`
Michael Yang's avatar
Michael Yang committed
388

Michael Yang's avatar
Michael Yang committed
389
	// Deprecated: set the model name with Model instead
Michael Yang's avatar
Michael Yang committed
390
	Name string `json:"name"`
391
}
392

393
// ListResponse is the response from [Client.List].
Patrick Devine's avatar
Patrick Devine committed
394
type ListResponse struct {
395
	Models []ListModelResponse `json:"models"`
Patrick Devine's avatar
Patrick Devine committed
396
397
}

398
399
400
401
402
403
404
// ProcessResponse is the response from [Client.Process].
type ProcessResponse struct {
	Models []ProcessModelResponse `json:"models"`
}

// ListModelResponse is a single model description in [ListResponse].
type ListModelResponse struct {
Patrick Devine's avatar
Patrick Devine committed
405
	Name       string       `json:"name"`
Michael Yang's avatar
Michael Yang committed
406
	Model      string       `json:"model"`
407
	ModifiedAt time.Time    `json:"modified_at"`
Patrick Devine's avatar
Patrick Devine committed
408
409
410
	Size       int64        `json:"size"`
	Digest     string       `json:"digest"`
	Details    ModelDetails `json:"details,omitempty"`
411
412
413
414
415
416
417
418
419
420
421
}

// ProcessModelResponse is a single model description in [ProcessResponse].
type ProcessModelResponse struct {
	Name      string       `json:"name"`
	Model     string       `json:"model"`
	Size      int64        `json:"size"`
	Digest    string       `json:"digest"`
	Details   ModelDetails `json:"details,omitempty"`
	ExpiresAt time.Time    `json:"expires_at"`
	SizeVRAM  int64        `json:"size_vram"`
Patrick Devine's avatar
Patrick Devine committed
422
423
}

424
425
426
427
428
429
430
type RetrieveModelResponse struct {
	Id      string `json:"id"`
	Object  string `json:"object"`
	Created int64  `json:"created"`
	OwnedBy string `json:"owned_by"`
}

Patrick Devine's avatar
Patrick Devine committed
431
432
433
434
type TokenResponse struct {
	Token string `json:"token"`
}

435
// GenerateResponse is the response passed into [GenerateResponseFunc].
Michael Yang's avatar
Michael Yang committed
436
type GenerateResponse struct {
437
438
439
	// Model is the model name that generated the response.
	Model string `json:"model"`

Michael Yang's avatar
Michael Yang committed
440
	// CreatedAt is the timestamp of the response.
441
442
	CreatedAt time.Time `json:"created_at"`

443
444
445
446
447
448
	// Response is the textual response itself.
	Response string `json:"response"`

	// Done specifies if the response is complete.
	Done bool `json:"done"`

449
	// DoneReason is the reason the model stopped generating text.
Bruce MacDonald's avatar
Bruce MacDonald committed
450
	DoneReason string `json:"done_reason,omitempty"`
451

452
453
	// Context is an encoding of the conversation used in this response; this
	// can be sent in the next request to keep a conversational memory.
Michael Yang's avatar
Michael Yang committed
454
	Context []int `json:"context,omitempty"`
455

Bruce MacDonald's avatar
Bruce MacDonald committed
456
	Metrics
457
458
}

459
// ModelDetails provides details about a model.
Patrick Devine's avatar
Patrick Devine committed
460
type ModelDetails struct {
461
	ParentModel       string   `json:"parent_model"`
Patrick Devine's avatar
Patrick Devine committed
462
463
464
465
466
467
468
	Format            string   `json:"format"`
	Family            string   `json:"family"`
	Families          []string `json:"families"`
	ParameterSize     string   `json:"parameter_size"`
	QuantizationLevel string   `json:"quantization_level"`
}

Bruce MacDonald's avatar
Bruce MacDonald committed
469
470
471
func (m *Metrics) Summary() {
	if m.TotalDuration > 0 {
		fmt.Fprintf(os.Stderr, "total duration:       %v\n", m.TotalDuration)
472
473
	}

Bruce MacDonald's avatar
Bruce MacDonald committed
474
475
	if m.LoadDuration > 0 {
		fmt.Fprintf(os.Stderr, "load duration:        %v\n", m.LoadDuration)
Michael Yang's avatar
Michael Yang committed
476
477
	}

Bruce MacDonald's avatar
Bruce MacDonald committed
478
479
	if m.PromptEvalCount > 0 {
		fmt.Fprintf(os.Stderr, "prompt eval count:    %d token(s)\n", m.PromptEvalCount)
480
481
	}

Bruce MacDonald's avatar
Bruce MacDonald committed
482
483
484
	if m.PromptEvalDuration > 0 {
		fmt.Fprintf(os.Stderr, "prompt eval duration: %s\n", m.PromptEvalDuration)
		fmt.Fprintf(os.Stderr, "prompt eval rate:     %.2f tokens/s\n", float64(m.PromptEvalCount)/m.PromptEvalDuration.Seconds())
485
486
	}

Bruce MacDonald's avatar
Bruce MacDonald committed
487
488
	if m.EvalCount > 0 {
		fmt.Fprintf(os.Stderr, "eval count:           %d token(s)\n", m.EvalCount)
489
490
	}

Bruce MacDonald's avatar
Bruce MacDonald committed
491
492
493
	if m.EvalDuration > 0 {
		fmt.Fprintf(os.Stderr, "eval duration:        %s\n", m.EvalDuration)
		fmt.Fprintf(os.Stderr, "eval rate:            %.2f tokens/s\n", float64(m.EvalCount)/m.EvalDuration.Seconds())
494
	}
495
496
}

497
498
499
500
501
502
503
504
505
506
507
508
509
510
func (opts *Options) FromMap(m map[string]interface{}) error {
	valueOpts := reflect.ValueOf(opts).Elem() // names of the fields in the options struct
	typeOpts := reflect.TypeOf(opts).Elem()   // types of the fields in the options struct

	// build map of json struct tags to their types
	jsonOpts := make(map[string]reflect.StructField)
	for _, field := range reflect.VisibleFields(typeOpts) {
		jsonTag := strings.Split(field.Tag.Get("json"), ",")[0]
		if jsonTag != "" {
			jsonOpts[jsonTag] = field
		}
	}

	for key, val := range m {
511
512
		opt, ok := jsonOpts[key]
		if !ok {
513
			slog.Warn("invalid option provided", "option", key)
514
515
			continue
		}
Michael Yang's avatar
Michael Yang committed
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
		field := valueOpts.FieldByName(opt.Name)
		if field.IsValid() && field.CanSet() {
			if val == nil {
				continue
			}

			switch field.Kind() {
			case reflect.Int:
				switch t := val.(type) {
				case int64:
					field.SetInt(t)
				case float64:
					// when JSON unmarshals numbers, it uses float64, not int
					field.SetInt(int64(t))
				default:
					return fmt.Errorf("option %q must be of type integer", key)
				}
			case reflect.Bool:
				val, ok := val.(bool)
				if !ok {
					return fmt.Errorf("option %q must be of type boolean", key)
				}
				field.SetBool(val)
			case reflect.Float32:
				// JSON unmarshals to float64
				val, ok := val.(float64)
				if !ok {
					return fmt.Errorf("option %q must be of type float32", key)
				}
				field.SetFloat(val)
			case reflect.String:
				val, ok := val.(string)
				if !ok {
					return fmt.Errorf("option %q must be of type string", key)
				}
				field.SetString(val)
			case reflect.Slice:
				// JSON unmarshals to []interface{}, not []string
				val, ok := val.([]interface{})
				if !ok {
					return fmt.Errorf("option %q must be of type array", key)
				}
				// convert []interface{} to []string
				slice := make([]string, len(val))
				for i, item := range val {
					str, ok := item.(string)
563
					if !ok {
564
						return fmt.Errorf("option %q must be of an array of strings", key)
565
					}
566
					slice[i] = str
567
				}
568
				field.Set(reflect.ValueOf(slice))
569
570
571
572
573
574
575
576
577
578
579
			case reflect.Pointer:
				var b bool
				if field.Type() == reflect.TypeOf(&b) {
					val, ok := val.(bool)
					if !ok {
						return fmt.Errorf("option %q must be of type boolean", key)
					}
					field.Set(reflect.ValueOf(&val))
				} else {
					return fmt.Errorf("unknown type loading config params: %v %v", field.Kind(), field.Type())
				}
580
581
			default:
				return fmt.Errorf("unknown type loading config params: %v", field.Kind())
582
583
584
			}
		}
	}
585

586
587
588
	return nil
}

589
590
// DefaultOptions is the default set of options for [GenerateRequest]; these
// values are used unless the user specifies other values explicitly.
Michael Yang's avatar
Michael Yang committed
591
592
func DefaultOptions() Options {
	return Options{
593
		// options set on request to runner
594
595
596
597
		NumPredict: -1,

		// set a minimal num_keep to avoid issues on context shifts
		NumKeep:          4,
Michael Yang's avatar
Michael Yang committed
598
599
600
601
		Temperature:      0.8,
		TopK:             40,
		TopP:             0.9,
		TypicalP:         1.0,
602
603
604
605
		RepeatLastN:      64,
		RepeatPenalty:    1.1,
		PresencePenalty:  0.0,
		FrequencyPenalty: 0.0,
Michael Yang's avatar
Michael Yang committed
606
607
608
		Mirostat:         0,
		MirostatTau:      5.0,
		MirostatEta:      0.1,
Michael Yang's avatar
Michael Yang committed
609
		PenalizeNewline:  true,
610
		Seed:             -1,
Michael Yang's avatar
Michael Yang committed
611

612
613
		Runner: Runner{
			// options set when the model is loaded
Michael Yang's avatar
Michael Yang committed
614
615
616
			NumCtx:    2048,
			NumBatch:  512,
			NumGPU:    -1, // -1 here indicates that NumGPU should be set dynamically
617
			NumThread: 0,  // let the runtime decide
Michael Yang's avatar
Michael Yang committed
618
619
			LowVRAM:   false,
			UseMLock:  false,
620
			UseMMap:   nil,
621
		},
Michael Yang's avatar
Michael Yang committed
622
	}
Jeffrey Morgan's avatar
Jeffrey Morgan committed
623
}
Michael Yang's avatar
Michael Yang committed
624
625
626
627
628

type Duration struct {
	time.Duration
}

629
630
631
632
633
634
635
func (d Duration) MarshalJSON() ([]byte, error) {
	if d.Duration < 0 {
		return []byte("-1"), nil
	}
	return []byte("\"" + d.Duration.String() + "\""), nil
}

Michael Yang's avatar
Michael Yang committed
636
637
638
639
640
641
642
643
644
645
646
func (d *Duration) UnmarshalJSON(b []byte) (err error) {
	var v any
	if err := json.Unmarshal(b, &v); err != nil {
		return err
	}

	d.Duration = 5 * time.Minute

	switch t := v.(type) {
	case float64:
		if t < 0 {
bnorick's avatar
bnorick committed
647
			d.Duration = time.Duration(math.MaxInt64)
648
		} else {
649
			d.Duration = time.Duration(int(t) * int(time.Second))
Michael Yang's avatar
Michael Yang committed
650
651
652
653
654
655
		}
	case string:
		d.Duration, err = time.ParseDuration(t)
		if err != nil {
			return err
		}
656
		if d.Duration < 0 {
bnorick's avatar
bnorick committed
657
			d.Duration = time.Duration(math.MaxInt64)
658
		}
659
660
	default:
		return fmt.Errorf("Unsupported type: '%s'", reflect.TypeOf(v))
Michael Yang's avatar
Michael Yang committed
661
662
663
664
	}

	return nil
}
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

// FormatParams converts specified parameter options to their correct types
func FormatParams(params map[string][]string) (map[string]interface{}, error) {
	opts := Options{}
	valueOpts := reflect.ValueOf(&opts).Elem() // names of the fields in the options struct
	typeOpts := reflect.TypeOf(opts)           // types of the fields in the options struct

	// build map of json struct tags to their types
	jsonOpts := make(map[string]reflect.StructField)
	for _, field := range reflect.VisibleFields(typeOpts) {
		jsonTag := strings.Split(field.Tag.Get("json"), ",")[0]
		if jsonTag != "" {
			jsonOpts[jsonTag] = field
		}
	}

	out := make(map[string]interface{})
	// iterate params and set values based on json struct tags
	for key, vals := range params {
		if opt, ok := jsonOpts[key]; !ok {
			return nil, fmt.Errorf("unknown parameter '%s'", key)
		} else {
			field := valueOpts.FieldByName(opt.Name)
			if field.IsValid() && field.CanSet() {
				switch field.Kind() {
				case reflect.Float32:
					floatVal, err := strconv.ParseFloat(vals[0], 32)
					if err != nil {
						return nil, fmt.Errorf("invalid float value %s", vals)
					}

					out[key] = float32(floatVal)
				case reflect.Int:
					intVal, err := strconv.ParseInt(vals[0], 10, 64)
					if err != nil {
						return nil, fmt.Errorf("invalid int value %s", vals)
					}

					out[key] = intVal
				case reflect.Bool:
					boolVal, err := strconv.ParseBool(vals[0])
					if err != nil {
						return nil, fmt.Errorf("invalid bool value %s", vals)
					}

					out[key] = boolVal
				case reflect.String:
					out[key] = vals[0]
				case reflect.Slice:
					// TODO: only string slices are supported right now
					out[key] = vals
716
717
718
719
720
721
722
723
724
725
726
				case reflect.Pointer:
					var b bool
					if field.Type() == reflect.TypeOf(&b) {
						boolVal, err := strconv.ParseBool(vals[0])
						if err != nil {
							return nil, fmt.Errorf("invalid bool value %s", vals)
						}
						out[key] = &boolVal
					} else {
						return nil, fmt.Errorf("unknown type %s for %s", field.Kind(), key)
					}
727
728
729
730
731
732
733
734
735
				default:
					return nil, fmt.Errorf("unknown type %s for %s", field.Kind(), key)
				}
			}
		}
	}

	return out, nil
}