brain

Documentation

Index

• Variables
• type Brain
  • func New(ctx context.Context, toolbox types.Toolbox, definition Definition) (*Brain, error)
  • func NewFromFile(ctx context.Context, toolbox types.Toolbox, file string) (*Brain, error)
  • func (m *Brain) Run(ctx context.Context, messages []types.Message) (Response, error)
• type Definition
  • func Default() Definition
• type Provider
  • func ParseProvider(name string) (Provider, error)
  • func (x Provider) IsValid() bool
  • func (x Provider) MarshalText() ([]byte, error)
  • func (x Provider) String() string
  • func (x *Provider) UnmarshalText(text []byte) error
• type Response
  • func (r Response) Called(name string) int
  • func (r Response) Reply() types.Content
  • func (r Response) TotalInputTokens() int
  • func (r Response) TotalOutputTokens() int
  • func (r Response) TotalTokens() int
• type Vision

Variables

var ErrInvalidProvider = errors.New("not a valid Provider")

var (
	ErrProviderNotFound = errors.New("provider not found")
)

Types

type Brain

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

func New

func New(ctx context.Context, toolbox types.Toolbox, definition Definition) (*Brain, error)

func NewFromFile

func NewFromFile(ctx context.Context, toolbox types.Toolbox, file string) (*Brain, error)

func (*Brain) Run

func (m *Brain) Run(ctx context.Context, messages []types.Message) (Response, error)

type Definition

type Definition struct {
	types.Config  `yaml:",inline"`    // model configuration
	Parallel      bool                `yaml:"parallel"`                       // allow parallel execution for calls
	Vision        *Vision             `yaml:"vision,omitempty" json:"vision"` // separate model for vision
	MaxIterations int                 `json:"max_iterations" yaml:"maxIterations"`
	Provider      Provider            `json:"provider" yaml:"provider"` // provider name (openai, bedrock)
	URL           string              `json:"url" yaml:"url"`           // provider URL
	Secret        utils.Value[string] `json:"secret" yaml:"secret"`     // provider secret
}

func Default

func Default() Definition

type Provider

type Provider string

Provider name ENUM(openai,bedrock,ollama,google)

const (
	// ProviderOpenai is a Provider of type openai.
	ProviderOpenai Provider = "openai"
	// ProviderBedrock is a Provider of type bedrock.
	ProviderBedrock Provider = "bedrock"
	// ProviderOllama is a Provider of type ollama.
	ProviderOllama Provider = "ollama"
	// ProviderGoogle is a Provider of type google.
	ProviderGoogle Provider = "google"
)

func ParseProvider

func ParseProvider(name string) (Provider, error)

ParseProvider attempts to convert a string to a Provider.

func (Provider) IsValid

func (x Provider) IsValid() bool

IsValid provides a quick way to determine if the typed value is part of the allowed enumerated values

func (Provider) MarshalText

func (x Provider) MarshalText() ([]byte, error)

MarshalText implements the text marshaller method.

func (Provider) String

func (x Provider) String() string

String implements the Stringer interface.

func (*Provider) UnmarshalText

func (x *Provider) UnmarshalText(text []byte) error

UnmarshalText implements the text unmarshaller method.

type Response

type Response []*types.Invoke

func (Response) Called

func (r Response) Called(name string) int

Called returns how many times function (tool) with specified name has been called.

func (Response) Reply

func (r Response) Reply() types.Content

Reply returns first non-tool calling model response. If nothing found, empty text content returned.

func (Response) TotalInputTokens

func (r Response) TotalInputTokens() int

TotalInputTokens returns sum of all used input tokens.

func (Response) TotalOutputTokens

func (r Response) TotalOutputTokens() int

TotalOutputTokens returns sum of all used output tokens.

func (Response) TotalTokens

func (r Response) TotalTokens() int

TotalTokens returns sum of all tokens.

type Vision

type Vision struct {
	Model string `json:"model" yaml:"model"`
}