llm

Documentation

Index

• Constants
• Variables
• func RedactDiagnostic(text string, limit int) string
• func ValidateJSONRequest(req JSONRequest) error
• type JSONGenerator
• type JSONRequest
• type JSONResponse
  • func RunJSON(ctx context.Context, generator JSONGenerator, req JSONRequest, provider string, ...) (JSONResponse, error)
• type NoopUsageReporter
  • func (NoopUsageReporter) RecordUsage(context.Context, string, string, Usage)
• type OpenAICompatibleConfig
• type OpenAICompatibleJSONGenerator
  • func NewOpenAICompatibleJSONGenerator(cfg OpenAICompatibleConfig) (*OpenAICompatibleJSONGenerator, error)
  • func (g *OpenAICompatibleJSONGenerator) GenerateJSON(ctx context.Context, req JSONRequest) (JSONResponse, error)
• type Usage
• type UsageReporter

Constants

const (
	DefaultDiagnosticLimit = 4096
)

Variables

var (
	ErrNilContext         = errors.New("llm: context is nil")
	ErrNilJSONGenerator   = errors.New("llm: json generator is nil")
	ErrInvalidJSONRequest = errors.New("llm: invalid json request")
)

var (
	ErrOpenAIEmptyOutput   = errors.New("llm: openai empty output")
	ErrOpenAIRefusalOutput = errors.New("llm: openai refusal output")
)

Functions

func RedactDiagnostic

func RedactDiagnostic(text string, limit int) string

func ValidateJSONRequest

func ValidateJSONRequest(req JSONRequest) error

Types

type JSONGenerator

type JSONGenerator interface {
	GenerateJSON(ctx context.Context, req JSONRequest) (JSONResponse, error)
}

type JSONRequest

type JSONRequest struct {
	TaskName        string
	SystemPrompt    string
	UserPrompt      string
	SchemaName      string
	Schema          map[string]any
	Model           string
	Temperature     *float64
	ReasoningEffort string
	WebSearch       bool
	ChatCompletions bool
}

type JSONResponse

type JSONResponse struct {
	Text         string
	Model        string
	Usage        Usage
	FallbackUsed bool
}

func RunJSON

func RunJSON(ctx context.Context, generator JSONGenerator, req JSONRequest, provider string, reporter UsageReporter) (JSONResponse, error)

type NoopUsageReporter

type NoopUsageReporter struct{}

func (NoopUsageReporter) RecordUsage

func (NoopUsageReporter) RecordUsage(context.Context, string, string, Usage)

type OpenAICompatibleConfig

type OpenAICompatibleConfig struct {
	BaseURL                      string
	APIKey                       string
	HTTPClient                   *http.Client
	AllowChatCompletionsFallback bool
}

type OpenAICompatibleJSONGenerator

type OpenAICompatibleJSONGenerator struct {
	// contains filtered or unexported fields
}

func NewOpenAICompatibleJSONGenerator

func NewOpenAICompatibleJSONGenerator(cfg OpenAICompatibleConfig) (*OpenAICompatibleJSONGenerator, error)

func (*OpenAICompatibleJSONGenerator) GenerateJSON

func (g *OpenAICompatibleJSONGenerator) GenerateJSON(ctx context.Context, req JSONRequest) (JSONResponse, error)

type Usage

type Usage struct {
	InputTokens           int
	OutputTokens          int
	TotalTokens           int
	CachedInputTokens     int
	ReasoningOutputTokens int
}

type UsageReporter

type UsageReporter interface {
	RecordUsage(ctx context.Context, provider, model string, usage Usage)
}