Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

llms

package

Go to main page

Versions in this module

v1

v1.5.3

Aug 8, 2026

Changes in this version

+ type AudioContent struct

+ MIMEType string

+ URL string

+ func AudioURLPart(url string) AudioContent

+ func (ac AudioContent) String() string

type ChatMessage

+ func FilterMessages(messages []ChatMessage, opts FilterMessagesOptions) []ChatMessage

+ func MergeMessageRuns(messages []ChatMessage) []ChatMessage

+ func TrimMessages(messages []ChatMessage, opts TrimMessagesOptions) ([]ChatMessage, error)

+ type FilterMessagesOptions struct

+ ExcludeIDs []string

+ ExcludeNames []string

+ ExcludeTypes []ChatMessageType

+ IncludeIDs []string

+ IncludeNames []string

+ IncludeTypes []ChatMessageType

+ type TrimMessagesOptions struct

+ EndOn ChatMessageType

+ KeepLast bool

+ MaxTokens int

+ StartOn ChatMessageType

+ SystemMessage *SystemChatMessage

+ TokenCounter func([]ChatMessage) int

+ type VideoContent struct

+ MIMEType string

+ URL string

+ func VideoURLPart(url string) VideoContent

+ func (vc VideoContent) String() string

v1.0.0

Aug 7, 2026

Changes in this version

+ const DefaultCandidateCount

+ const DefaultFrequencyPenalty

+ const DefaultMaxLength

+ const DefaultMaxTokens

+ const DefaultMinLength

+ const DefaultMinP

+ const DefaultN

+ const DefaultPresencePenalty

+ const DefaultRepetitionPenalty

+ const DefaultSeed

+ const DefaultSpeed

+ const DefaultTemperature

+ const DefaultTopK

+ const DefaultTopP

+ const MaxReasoningTokens

+ var ErrAuthentication = &Error

+ var ErrCanceled = &Error

+ var ErrContentFilter = &Error

+ var ErrInvalidRequest = &Error

+ var ErrNotImplemented = &Error

+ var ErrProviderUnavailable = &Error

+ var ErrQuotaExceeded = &Error

+ var ErrRateLimit = &Error

+ var ErrStructuredOutputConfig = errors.New("structured output: invalid configuration")

+ var ErrTimeout = &Error

+ var ErrTokenLimit = &Error

+ var ErrUnexpectedChatMessageType = errors.New("unexpected chat message type")

+ func CalculateMaxTokens(model, text string) int

+ func CountTokens(model, text string) int

+ func GenerateFromSinglePrompt(ctx context.Context, llm Model, prompt string, options ...CallOption) (string, error)

+ func GetBufferString(messages []ChatMessage, humanPrefix string, aiPrefix string) (string, error)

+ func GetModelContextSize(model string) int

+ func IsAuthenticationError(err error) bool

+ func IsCanceledError(err error) bool

+ func IsContentFilterError(err error) bool

+ func IsInvalidRequestError(err error) bool

+ func IsNotImplementedError(err error) bool

+ func IsProviderUnavailableError(err error) bool

+ func IsQuotaExceededError(err error) bool

+ func IsRateLimitError(err error) bool

+ func IsTimeoutError(err error) bool

+ func IsTokenLimitError(err error) bool

+ func RegisterReasoningSupport(pattern string, info ReasoningSupport)

+ func ShowMessageContents(w io.Writer, msgs []MessageContent)

+ type AIChatMessage struct

+ Content string

+ FunctionCall *FunctionCall

+ ReasoningContent string

+ ToolCalls []ToolCall

+ func (m AIChatMessage) GetContent() string

+ func (m AIChatMessage) GetFunctionCall() *FunctionCall

+ func (m AIChatMessage) GetType() ChatMessageType

+ type ApproximateLocation struct

+ City string

+ Country string

+ Region string

+ type BinaryContent struct

+ Data []byte

+ MIMEType string

+ func BinaryPart(mime string, data []byte) BinaryContent

+ func (bc *BinaryContent) UnmarshalJSON(data []byte) error

+ func (bc BinaryContent) MarshalJSON() ([]byte, error)

+ func (bc BinaryContent) String() string

+ type CacheControl struct

+ Duration time.Duration

+ Type string

+ func (cc CacheControl) String() string

+ type CallOption func(*CallOptions)

+ func WithAdaptiveReasoning(effort ReasoningEffort) CallOption

+ func WithCandidateCount(c int) CallOption

+ func WithFrequencyPenalty(frequencyPenalty float64) CallOption

+ func WithFunctionCallBehavior(behavior FunctionCallBehavior) CallOption

+ func WithFunctions(functions []FunctionDefinition) CallOption

+ func WithJSONMode() CallOption

+ func WithMaxLength(maxLength int) CallOption

+ func WithMaxTokens(maxTokens int) CallOption

+ func WithMetadata(metadata map[string]interface{}) CallOption

+ func WithMinLength(minLength int) CallOption

+ func WithMinP(minP float64) CallOption

+ func WithModel(model string) CallOption

+ func WithN(n int) CallOption

+ func WithOptions(options CallOptions) CallOption

+ func WithPresencePenalty(presencePenalty float64) CallOption

+ func WithReasoning(effort ReasoningEffort, tokens int) CallOption

+ func WithReasoningDisabled() CallOption

+ func WithRepetitionPenalty(repetitionPenalty float64) CallOption

+ func WithResponseFormat(responseFormat string) CallOption

+ func WithResponseMIMEType(responseMIMEType string) CallOption

+ func WithSeed(seed int) CallOption

+ func WithSpeed(speed float64) CallOption

+ func WithStopWords(stopWords []string) CallOption

+ func WithStreamingFunc(streamingFunc streaming.Callback) CallOption

+ func WithStructuredOutput(config StructuredOutputConfig) CallOption

+ func WithTemperature(temperature float64) CallOption

+ func WithToolChoice(choice any) CallOption

+ func WithTools(tools []Tool) CallOption

+ func WithTopK(topK int) CallOption

+ func WithTopP(topP float64) CallOption

+ func WithVoice(voice string) CallOption

+ func WithWebSearch(options *WebSearchOptions) CallOption

+ type CallOptions struct

+ CandidateCount *int

+ FrequencyPenalty *float64

+ FunctionCallBehavior FunctionCallBehavior

+ Functions []FunctionDefinition

+ JSONMode bool

+ MaxLength *int

+ MaxTokens *int

+ Metadata map[string]interface{}

+ MinLength *int

+ MinP *float64

+ Model *string

+ N *int

+ PresencePenalty *float64

+ Reasoning *ReasoningConfig

+ RepetitionPenalty *float64

+ ResponseFormat *string

+ ResponseMIMEType *string

+ Seed *int

+ Speed *float64

+ StopWords []string

+ StreamingFunc streaming.Callback

+ StructuredOutput *StructuredOutputConfig

+ Temperature *float64

+ ToolChoice any

+ Tools []Tool

+ TopK *int

+ TopP *float64

+ Voice *string

+ WebSearchOptions *WebSearchOptions

+ func (o *CallOptions) GetCandidateCount() int

+ func (o *CallOptions) GetFrequencyPenalty() float64

+ func (o *CallOptions) GetFunctionCallBehavior() FunctionCallBehavior

+ func (o *CallOptions) GetFunctions() []FunctionDefinition

+ func (o *CallOptions) GetJSONMode() bool

+ func (o *CallOptions) GetMaxLength() int

+ func (o *CallOptions) GetMaxTokens() int

+ func (o *CallOptions) GetMetadata() map[string]interface{}

+ func (o *CallOptions) GetMinLength() int

+ func (o *CallOptions) GetMinP() float64

+ func (o *CallOptions) GetModel() string

+ func (o *CallOptions) GetN() int

+ func (o *CallOptions) GetPresencePenalty() float64

+ func (o *CallOptions) GetReasoning() *ReasoningConfig

+ func (o *CallOptions) GetRepetitionPenalty() float64

+ func (o *CallOptions) GetResponseFormat() string

+ func (o *CallOptions) GetResponseMIMEType() string

+ func (o *CallOptions) GetSeed() int

+ func (o *CallOptions) GetSpeed() float64

+ func (o *CallOptions) GetStopWords() []string

+ func (o *CallOptions) GetStreamingFunc() streaming.Callback

+ func (o *CallOptions) GetStructuredOutput() *StructuredOutputConfig

+ func (o *CallOptions) GetTemperature() float64

+ func (o *CallOptions) GetToolChoice() any

+ func (o *CallOptions) GetTools() []Tool

+ func (o *CallOptions) GetTopK() int

+ func (o *CallOptions) GetTopP() float64

+ func (o *CallOptions) GetVoice() string

+ func (o *CallOptions) GetWebSearchOptions() *WebSearchOptions

+ func (o *CallOptions) ValidateStructuredOutput() error

+ type ChatMessage interface

+ GetContent func() string

+ GetType func() ChatMessageType

+ type ChatMessageModel struct

+ Data ChatMessageModelData

+ Type string

+ func ConvertChatMessageToModel(m ChatMessage) ChatMessageModel

+ func (c ChatMessageModel) ToChatMessage() ChatMessage

+ type ChatMessageModelData struct

+ Content string

+ Type string

+ type ChatMessageType string

+ const ChatMessageTypeAI

+ const ChatMessageTypeFunction

+ const ChatMessageTypeGeneric

+ const ChatMessageTypeHuman

+ const ChatMessageTypeSystem

+ const ChatMessageTypeTool

+ type ContentChoice struct

+ Content string

+ FuncCall *FunctionCall

+ GenerationInfo map[string]any

+ Reasoning *reasoning.ContentReasoning

+ StopReason string

+ ToolCalls []ToolCall

+ type ContentPart interface

+ type ContentResponse struct

+ Choices []*ContentChoice

+ type ErrStructuredOutputConflict struct

+ Detail string

+ Provider string

+ func (e *ErrStructuredOutputConflict) Error() string

+ type ErrStructuredOutputUnsupported struct

+ Model string

+ Provider string

+ Reason string

+ func (e *ErrStructuredOutputUnsupported) Error() string

+ type ErrStructuredOutputValidation struct

+ Cause error

+ Choice int

+ Model string

+ Provider string

+ StopReason string

+ func (e *ErrStructuredOutputValidation) Error() string

+ func (e *ErrStructuredOutputValidation) Unwrap() error

+ type Error struct

+ Cause error

+ Code ErrorCode

+ Details map[string]interface{}

+ Message string

+ Provider string

+ func NewError(code ErrorCode, provider, message string) *Error

+ func (e *Error) Error() string

+ func (e *Error) Is(target error) bool

+ func (e *Error) Unwrap() error

+ func (e *Error) WithCause(cause error) *Error

+ func (e *Error) WithDetail(key string, value interface{}) *Error

+ type ErrorCode string

+ const ErrCodeAuthentication

+ const ErrCodeCanceled

+ const ErrCodeContentFilter

+ const ErrCodeInvalidRequest

+ const ErrCodeNotImplemented

+ const ErrCodeProviderUnavailable

+ const ErrCodeQuotaExceeded

+ const ErrCodeRateLimit

+ const ErrCodeResourceNotFound

+ const ErrCodeTimeout

+ const ErrCodeTokenLimit

+ const ErrCodeUnknown

+ type ErrorMapper struct

+ func AnthropicErrorMapper() *ErrorMapper

+ func GoogleAIErrorMapper() *ErrorMapper

+ func NewErrorMapper(provider string) *ErrorMapper

+ func OpenAIErrorMapper() *ErrorMapper

+ func (m *ErrorMapper) AddMatcher(matcher ErrorMatcher) *ErrorMapper

+ func (m *ErrorMapper) Map(err error) error

+ func (m *ErrorMapper) WrapError(err error) error

+ type ErrorMatcher struct

+ Code ErrorCode

+ Match func(error) bool

+ Transform func(error) string

+ type FunctionCall struct

+ Arguments string

+ Name string

+ type FunctionCallBehavior string

+ const FunctionCallBehaviorAuto

+ const FunctionCallBehaviorNone

+ type FunctionChatMessage struct

+ Content string

+ Name string

+ func (m FunctionChatMessage) GetContent() string

+ func (m FunctionChatMessage) GetName() string

+ func (m FunctionChatMessage) GetType() ChatMessageType

+ type FunctionDefinition struct

+ Description string

+ Name string

+ Parameters any

+ Strict bool

+ type FunctionReference struct

+ Name string

+ type GenericChatMessage struct

+ Content string

+ Name string

+ Role string

+ func (m GenericChatMessage) GetContent() string

+ func (m GenericChatMessage) GetName() string

+ func (m GenericChatMessage) GetType() ChatMessageType

+ type HumanChatMessage struct

+ Content string

+ func (m HumanChatMessage) GetContent() string

+ func (m HumanChatMessage) GetType() ChatMessageType

+ type ImageURLContent struct

+ Detail string

+ URL string

+ func ImageURLPart(url string) ImageURLContent

+ func ImageURLWithDetailPart(url string, detail string) ImageURLContent

+ func (iuc *ImageURLContent) UnmarshalJSON(data []byte) error

+ func (iuc ImageURLContent) MarshalJSON() ([]byte, error)

+ func (iuc ImageURLContent) String() string

+ type LLM = Model

+ type MessageContent struct

+ Parts []ContentPart

+ Role ChatMessageType

+ func TextParts(role ChatMessageType, parts ...string) MessageContent

+ func (mc *MessageContent) UnmarshalJSON(data []byte) error

+ func (mc MessageContent) MarshalJSON() ([]byte, error)

+ type Model interface

+ Call func(ctx context.Context, prompt string, options ...CallOption) (string, error)

+ GenerateContent func(ctx context.Context, messages []MessageContent, options ...CallOption) (*ContentResponse, error)

+ type Named interface

+ GetName func() string

+ type PromptValue interface

+ Messages func() []ChatMessage

+ String func() string

+ type ReasoningConfig struct

+ Adaptive bool

+ Effort ReasoningEffort

+ Mode ReasoningMode

+ Tokens int

+ func (r *ReasoningConfig) GetEffort(maxTokens int) ReasoningEffort

+ func (r *ReasoningConfig) GetTokens(maxTokens int) int

+ func (r *ReasoningConfig) IsDisabled() bool

+ func (r *ReasoningConfig) IsEnabled() bool

+ func (r *ReasoningConfig) ResolveMode() ReasoningMode

+ type ReasoningEffort string

+ const ReasoningHigh

+ const ReasoningLow

+ const ReasoningMax

+ const ReasoningMedium

+ const ReasoningNone

+ const ReasoningXHigh

+ type ReasoningMode int

+ const ReasoningDefault

+ const ReasoningOff

+ const ReasoningOn

+ type ReasoningSupport struct

+ CannotDisable bool

+ DefaultOn *bool

+ Efforts []ReasoningEffort

+ Known bool

+ RejectsSampling bool

+ Supported bool

+ func ReasoningSupportFor(model string, p reasoning.Provider) ReasoningSupport

+ type StructuredOutputConfig struct

+ Description string

+ Name string

+ Schema json.RawMessage

+ func (c *StructuredOutputConfig) Clone() *StructuredOutputConfig

+ type SystemChatMessage struct

+ Content string

+ func (m SystemChatMessage) GetContent() string

+ func (m SystemChatMessage) GetType() ChatMessageType

+ type TextContent struct

+ Reasoning *reasoning.ContentReasoning

+ Text string

+ func TextPart(s string) TextContent

+ func TextPartWithReasoning(s string, reasoning *reasoning.ContentReasoning) TextContent

+ func (tc *TextContent) UnmarshalJSON(data []byte) error

+ func (tc TextContent) MarshalJSON() ([]byte, error)

+ func (tc TextContent) String() string

+ type Tool struct

+ Function *FunctionDefinition

+ Type string

+ type ToolCall struct

+ FunctionCall *FunctionCall

+ ID string

+ Reasoning *reasoning.ContentReasoning

+ Type string

+ func (tc *ToolCall) UnmarshalJSON(data []byte) error

+ func (tc ToolCall) MarshalJSON() ([]byte, error)

+ type ToolCallResponse struct

+ Content string

+ Name string

+ ToolCallID string

+ func (tc *ToolCallResponse) UnmarshalJSON(data []byte) error

+ func (tc ToolCallResponse) MarshalJSON() ([]byte, error)

+ type ToolChatMessage struct

+ Content string

+ ID string

+ Name string

+ func (m ToolChatMessage) GetContent() string

+ func (m ToolChatMessage) GetID() string

+ func (m ToolChatMessage) GetName() string

+ func (m ToolChatMessage) GetType() ChatMessageType

+ type ToolChoice struct

+ Function *FunctionReference

+ Type string

+ type UserLocation struct

+ Approximate *ApproximateLocation

+ Type string

+ type WebSearchOptions struct

+ SearchContextSize string

+ UserLocation *UserLocation

v0

v0.1.14-update.7

Aug 7, 2026