any-llm-go/anyllm.go at main · quriobot/any-llm-go · GitHub

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
// Package anyllm provides a unified interface for interacting with LLM providers.
//
// This package re-exports common types and configuration options from subpackages,
// allowing most use cases to work with just two imports:
//
//	import (
//	    anyllm "github.com/mozilla-ai/any-llm-go"
//	    "github.com/mozilla-ai/any-llm-go/providers/openai"
//	)
//
//	provider, err := openai.New(anyllm.WithAPIKey("sk-..."))
//	response, err := provider.Completion(ctx, anyllm.CompletionParams{
//	    Model: "gpt-4o-mini",
//	    Messages: []anyllm.Message{
//	        {Role: anyllm.RoleUser, Content: "Hello!"},
//	    },
//	})
package anyllm

import (
	"github.com/mozilla-ai/any-llm-go/config"
	"github.com/mozilla-ai/any-llm-go/errors"
	"github.com/mozilla-ai/any-llm-go/providers"
)

// Message roles.
const (
	RoleAssistant = providers.RoleAssistant
	RoleSystem    = providers.RoleSystem
	RoleTool      = providers.RoleTool
	RoleUser      = providers.RoleUser
)

// Finish reasons.
const (
	FinishReasonContentFilter = providers.FinishReasonContentFilter
	FinishReasonLength        = providers.FinishReasonLength
	FinishReasonStop          = providers.FinishReasonStop
	FinishReasonToolCalls     = providers.FinishReasonToolCalls
)

// Batch status constants.
const (
	BatchStatusCancelled  = providers.BatchStatusCancelled
	BatchStatusCancelling = providers.BatchStatusCancelling
	BatchStatusCompleted  = providers.BatchStatusCompleted
	BatchStatusExpired    = providers.BatchStatusExpired
	BatchStatusFailed     = providers.BatchStatusFailed
	BatchStatusFinalizing = providers.BatchStatusFinalizing
	BatchStatusInProgress = providers.BatchStatusInProgress
	BatchStatusValidating = providers.BatchStatusValidating
)

// ReasoningEffort levels.
const (
	ReasoningEffortAuto   = providers.ReasoningEffortAuto
	ReasoningEffortHigh   = providers.ReasoningEffortHigh
	ReasoningEffortLow    = providers.ReasoningEffortLow
	ReasoningEffortMedium = providers.ReasoningEffortMedium
	ReasoningEffortNone   = providers.ReasoningEffortNone
)

// Provider types.
type (
	BatchProvider      = providers.BatchProvider
	Capabilities       = providers.Capabilities
	CapabilityProvider = providers.CapabilityProvider
	EmbeddingProvider  = providers.EmbeddingProvider
	ModelLister        = providers.ModelLister
	ModerationProvider = providers.ModerationProvider
	Provider           = providers.Provider
	RerankProvider     = providers.RerankProvider
)

// Batch types.
type (
	Batch              = providers.Batch
	BatchRequestCounts = providers.BatchRequestCounts
	BatchRequestItem   = providers.BatchRequestItem
	BatchResult        = providers.BatchResult
	BatchResultError   = providers.BatchResultError
	BatchResultItem    = providers.BatchResultItem
	CreateBatchParams  = providers.CreateBatchParams
	ListBatchesOptions = providers.ListBatchesOptions
)

// Request/Response types.
type (
	ChatCompletion      = providers.ChatCompletion
	ChatCompletionChunk = providers.ChatCompletionChunk
	Choice              = providers.Choice
	ChunkChoice         = providers.ChunkChoice
	ChunkDelta          = providers.ChunkDelta
	CompletionParams    = providers.CompletionParams
	EmbeddingParams     = providers.EmbeddingParams
	EmbeddingResponse   = providers.EmbeddingResponse
	ModelsResponse      = providers.ModelsResponse
	ModerationParams    = providers.ModerationParams
	ModerationResponse  = providers.ModerationResponse
	ModerationResult    = providers.ModerationResult
)

// Message types.
type (
	ContentPart = providers.ContentPart
	ImageURL    = providers.ImageURL
	Message     = providers.Message
	Reasoning   = providers.Reasoning
)

// Tool types.
type (
	Function           = providers.Function
	FunctionCall       = providers.FunctionCall
	Tool               = providers.Tool
	ToolCall           = providers.ToolCall
	ToolChoice         = providers.ToolChoice
	ToolChoiceFunction = providers.ToolChoiceFunction
)

// Response format types.
type (
	JSONSchema     = providers.JSONSchema
	ResponseFormat = providers.ResponseFormat
	StreamOptions  = providers.StreamOptions
)

// Rerank types.
type (
	RerankMeta     = providers.RerankMeta
	RerankParams   = providers.RerankParams
	RerankResponse = providers.RerankResponse
	RerankResult   = providers.RerankResult
	RerankUsage    = providers.RerankUsage
)

// Usage and model types.
type (
	BatchStatus     = providers.BatchStatus
	EmbeddingData   = providers.EmbeddingData
	EmbeddingUsage  = providers.EmbeddingUsage
	Model           = providers.Model
	ReasoningEffort = providers.ReasoningEffort
	Usage           = providers.Usage
)

// Config types.
type (
	Config = config.Config
	Option = config.Option
)

// Configuration options.
var (
	NewConfig      = config.New
	WithAPIKey     = config.WithAPIKey
	WithBaseURL    = config.WithBaseURL
	WithExtra      = config.WithExtra
	WithHTTPClient = config.WithHTTPClient
	WithTimeout    = config.WithTimeout
)

// Sentinel errors for type checking with errors.Is().
var (
	ErrAuthentication      = errors.ErrAuthentication
	ErrContentFilter       = errors.ErrContentFilter
	ErrContextLength       = errors.ErrContextLength
	ErrInsufficientFunds   = errors.ErrInsufficientFunds
	ErrInvalidRequest      = errors.ErrInvalidRequest
	ErrMissingAPIKey       = errors.ErrMissingAPIKey
	ErrModelNotFound       = errors.ErrModelNotFound
	ErrProvider            = errors.ErrProvider
	ErrRateLimit           = errors.ErrRateLimit
	ErrUnsupported         = errors.ErrUnsupported
	ErrUnsupportedParam    = errors.ErrUnsupportedParam
	ErrUnsupportedProvider = errors.ErrUnsupportedProvider
)

// Error types.
type (
	AuthenticationError           = errors.AuthenticationError
	BaseError                     = errors.BaseError
	ContentFilterError            = errors.ContentFilterError
	ContextLengthError            = errors.ContextLengthError
	InsufficientFundsError        = errors.InsufficientFundsError
	InvalidRequestError           = errors.InvalidRequestError
	MissingAPIKeyError            = errors.MissingAPIKeyError
	ModelNotFoundError            = errors.ModelNotFoundError
	ProviderError                 = errors.ProviderError
	RateLimitError                = errors.RateLimitError
	UnsupportedOperationError     = errors.UnsupportedOperationError
	UnsupportedParamError         = errors.UnsupportedParamError
	UnsupportedProviderError      = errors.UnsupportedProviderError
)