polaris

package module

Go to main page

Versions in this module

v1

v1.3.1

Apr 23, 2025

Changes in this version

type Logger

+ Debugf func(string, ...any)

v1.3.0

Apr 22, 2025

Changes in this version

+ type ReqCtx struct

+ func (c *ReqCtx) Bool(key string) bool

+ func (c *ReqCtx) Float64(key string) float64

+ func (c *ReqCtx) FloatArray(key string) []float64

+ func (c *ReqCtx) Int(key string) int

+ func (c *ReqCtx) IntArray(key string) []int

+ func (c *ReqCtx) Object(key string) *ReqCtx

+ func (c *ReqCtx) ObjectArray(key string) []*ReqCtx

+ func (c *ReqCtx) Req() Req

+ func (c *ReqCtx) String(key string) string

+ func (c *ReqCtx) StringArray(key string) []string

v1.2.5

Apr 20, 2025

v1.2.4

Apr 19, 2025

Changes in this version

type Conn

+ func (c *Conn) RegisterSSEMCPTools(baseURL string, initReq mcp.InitializeRequest, ...) error

v1.2.3

Apr 19, 2025

Changes in this version

type Ctx

+ func (c *Ctx) Req() Req

+ type ErrorHandler func(error)

type Tool

+ ErrorHandler ErrorHandler

v1.2.2

Apr 15, 2025

Changes in this version

type ConnectOptionFunc

+ func RequestTimeout(timeout time.Duration) ConnectOptionFunc

v1.2.1

Apr 15, 2025

v1.2.0

Apr 13, 2025

Changes in this version

+ type GenerateJSONFunc func(...string) (Resp, error)

type Session

+ func Generate(ctx context.Context, options ...UseOptionFunc) (Session, error)

v1.1.0

Apr 10, 2025

Changes in this version

type Conn

+ func (c *Conn) Call(ctx context.Context, name string, req Req) (Resp, error)

+ func (c *Conn) NewConnection() (*Conn, error)

+ func (c *Conn) Tool(name string) (Tool, bool)

type Ctx

+ func (c *Ctx) ObjectArray(key string) []*Ctx

+ func (c *Ctx) StringArray(key string) []string

+ type GenerateJSON func(...string) (Resp, error)

+ func UseGenerateJSON(ctx context.Context, options ...UseOptionFunc) (GenerateJSON, error)

type JSONMap

+ func (m JSONMap) Array(key string, defaultValue []JSONMap) []JSONMap

+ func (m JSONMap) StringArray(key string, defaultValue []string) []string

type LiveSession

+ func (s *LiveSession) JSONOutput() bool

+ type Req = JSONMap

type Session

+ JSONOutput func() bool

type UseOptionFunc

+ func UseToolJSONOutput(conn *Conn, toolName string) UseOptionFunc

v1.0.0

Apr 6, 2025

Changes in this version

+ const AppName

+ const TopicListTool

+ const TopicRegisterTool

+ const TopicToolKeepalive

+ const TopicUnregisterTool

+ const Version

+ func AddBinarySystemInstruction(data []byte, mimeType string) func() []genai.Part

+ func AddTextSystemInstruction(values ...string) func() []genai.Part

+ func GobEncoder[T any]() *gobEncoder[T]

+ func JSONEncoder[T any]() *jsonEncoder[T]

+ type Array struct

+ Description string

+ Items TypeDef

+ Nullable NullableType

+ Required bool

+ func (a Array) IsRequired() bool

+ func (a Array) Schema() *genai.Schema

+ type Bool struct

+ Default bool

+ Description string

+ Nullable NullableType

+ Required bool

+ func (b Bool) IsRequired() bool

+ func (b Bool) Schema() *genai.Schema

+ type BoolArray struct

+ Description string

+ ItemDescription string

+ Nullable NullableType

+ Required bool

+ func (ba BoolArray) IsRequired() bool

+ func (ba BoolArray) Schema() *genai.Schema

+ type Conn struct

+ func Connect(options ...ConnectOptionFunc) (*Conn, error)

+ func (c *Conn) Close()

+ func (c *Conn) RegisterTool(t Tool) error

+ func (c *Conn) UnregisterTools() error

+ func (c *Conn) Use(ctx context.Context, options ...UseOptionFunc) (Session, error)

+ type ConnectOption struct

+ AllowReconnect bool

+ AuthPassword string

+ AuthUser string

+ Host string

+ MaxReconnects int

+ Name string

+ NatsURL string

+ NoEcho bool

+ NoRandomize bool

+ Port string

+ ReconnectWait time.Duration

+ ReqTimeout time.Duration

+ Timeout time.Duration

+ UseTLS bool

+ type ConnectOptionFunc func(*ConnectOption)

+ func AllowReconnect(allowReconnect bool) ConnectOptionFunc

+ func ConnectAddress(host, port string) ConnectOptionFunc

+ func ConnectAuth(user, password string) ConnectOptionFunc

+ func ConnectNoEcho(noEcho bool) ConnectOptionFunc

+ func ConnectNoRandomize(noRandomize bool) ConnectOptionFunc

+ func ConnectTLS(useTLS bool) ConnectOptionFunc

+ func ConnectTimeout(timeout time.Duration) ConnectOptionFunc

+ func MaxReconnects(maxReconnects int) ConnectOptionFunc

+ func Name(name string) ConnectOptionFunc

+ func NatsURL(url string) ConnectOptionFunc

+ func ReconnectWait(reconnectWait time.Duration) ConnectOptionFunc

+ type Ctx struct

+ func (c *Ctx) Bool(key string) bool

+ func (c *Ctx) Float64(key string) float64

+ func (c *Ctx) FloatArray(key string) []float64

+ func (c *Ctx) Int(key string) int

+ func (c *Ctx) IntArray(key string) []int

+ func (c *Ctx) Object(key string) *Ctx

+ func (c *Ctx) Set(r Resp)

+ func (c *Ctx) String(key string) string

+ type Encoder interface

+ Decode func([]byte) (T, error)

+ Encode func(v T) ([]byte, error)

+ type Float struct

+ Default float64

+ Description string

+ Nullable NullableType

+ Required bool

+ func (f Float) IsRequired() bool

+ func (f Float) Schema() *genai.Schema

+ type FloatArray struct

+ Description string

+ ItemDescription string

+ Nullable NullableType

+ Required bool

+ func (fa FloatArray) IsRequired() bool

+ func (fa FloatArray) Schema() *genai.Schema

+ type Int struct

+ Default int

+ Description string

+ Nullable NullableType

+ Required bool

+ func (i Int) IsRequired() bool

+ func (i Int) Schema() *genai.Schema

+ type IntArray struct

+ Description string

+ ItemDescription string

+ Nullable NullableType

+ Required bool

+ func (ia IntArray) IsRequired() bool

+ func (ia IntArray) Schema() *genai.Schema

+ type IntEnum struct

+ Description string

+ Nullable NullableType

+ Required bool

+ Values []string

+ func (ie IntEnum) IsRequired() bool

+ func (ie IntEnum) Schema() *genai.Schema

+ type JSONMap map[string]any

+ func (m JSONMap) Bool(key string, defaultValue bool) bool

+ func (m JSONMap) Float64(key string, defaultValue float64) float64

+ func (m JSONMap) Float64Array(key string, defaultValue []float64) []float64

+ func (m JSONMap) Int(key string, defaultValue int) int

+ func (m JSONMap) IntArray(key string, defaultValue []int) []int

+ func (m JSONMap) Object(key string, defaultValue JSONMap) JSONMap

+ func (m JSONMap) ObjectArray(key string, defaultValue []JSONMap) []JSONMap

+ func (m JSONMap) Set(key string, value any)

+ func (m JSONMap) String(key string, defaultValue string) string

+ func (m JSONMap) ToMap() map[string]any

+ type LiveSession struct

+ func (s *LiveSession) Close() error

+ func (s *LiveSession) SendText(values ...string) (iter.Seq2[string, error], error)

+ type Logger interface

+ DebugF func(string, ...any)

+ Errorf func(string, ...any)

+ Infof func(string, ...any)

+ Warnf func(string, ...any)

+ type NullableType string

+ const NullableNo

+ const NullableYes

+ func (n NullableType) Nullable() bool

+ type Object struct

+ Description string

+ Nullable NullableType

+ Properties Properties

+ Required bool

+ func (o Object) IsRequired() bool

+ func (o Object) Schema() *genai.Schema

+ type ObjectArray struct

+ Description string

+ ItemDescription string

+ Items Properties

+ Nullable NullableType

+ Required bool

+ func (oa ObjectArray) IsRequired() bool

+ func (oa ObjectArray) Schema() *genai.Schema

+ type Properties map[string]TypeDef

+ type Registry struct

+ func CreateRegistry(opts ...RegistryOption) (*Registry, error)

+ func (r *Registry) Close()

+ type RegistryClusterOption func(*server.ClusterOpts)

+ func WithClussterAdvertise(advertise string) RegistryClusterOption

+ func WithClusterHost(host string) RegistryClusterOption

+ func WithClusterName(name string) RegistryClusterOption

+ func WithClusterPort(port int) RegistryClusterOption

+ type RegistryOption func(*server.Options)

+ func WithBind(host string, port int) RegistryOption

+ func WithClusterOption(opts ...RegistryClusterOption) RegistryOption

+ func WithMaxPayload(size int32) RegistryOption

+ func WithRoutes(routesStr string) RegistryOption

+ type Resp = JSONMap

+ type RespError struct

+ Msg string

+ Success bool

+ func (e RespError) Err() error

+ func (e RespError) String() string

+ type Session interface

+ Close func() error

+ SendText func(...string) (iter.Seq2[string, error], error)

+ func Use(ctx context.Context, options ...UseOptionFunc) (Session, error)

+ type String struct

+ Default string

+ Description string

+ Nullable NullableType

+ Required bool

+ func (s String) IsRequired() bool

+ func (s String) Schema() *genai.Schema

+ type StringArray struct

+ Description string

+ ItemDescription string

+ Nullable NullableType

+ Required bool

+ func (sa StringArray) IsRequired() bool

+ func (sa StringArray) Schema() *genai.Schema

+ type StringEnum struct

+ Description string

+ Nullable NullableType

+ Required bool

+ Values []string

+ func (se StringEnum) IsRequired() bool

+ func (se StringEnum) Schema() *genai.Schema

+ type SystemInstructionOptfion func() []genai.Part

+ type Tool struct

+ Description string

+ Handler ToolHandler

+ Name string

+ Parameters Object

+ Response Object

+ func (t Tool) FunctionDeclaration() genai.FunctionDeclaration

+ type ToolHandler func(*Ctx) error

+ type TypeDef interface

+ IsRequired func() bool

+ Schema func() *genai.Schema

+ type UseOption struct

+ DebugMode bool

+ DefaultArgsFunc func() map[string]any

+ JSONOutput bool

+ Logger Logger

+ MaxOutputTokens int32

+ Model string

+ OutputSchema TypeDef

+ SystemInstructions []genai.Part

+ Temperature float32

+ TopP float32

+ UseLocalTool bool

+ type UseOptionFunc func(*UseOption)

+ func UseDebugMode(enable bool) UseOptionFunc

+ func UseDefaultArgs(fn func() map[string]any) UseOptionFunc

+ func UseJSONOutput(schema TypeDef) UseOptionFunc

+ func UseLocalTool(enable bool) UseOptionFunc

+ func UseLogger(lg Logger) UseOptionFunc

+ func UseMaxOutputTokens(size int32) UseOptionFunc

+ func UseModel(name string) UseOptionFunc

+ func UseSystemInstruction(sysInstructionOptions ...SystemInstructionOptfion) UseOptionFunc

+ func UseTemperature(v float32) UseOptionFunc

+ func UseTopP(v float32) UseOptionFunc

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL