syndicate

package module

Go to main page

Versions in this module

v0

v0.4.0

May 31, 2025

Changes in this version

type PromptBuilder

+ func (pb *PromptBuilder) AddBlockquote(sectionName, text string) *PromptBuilder

+ func (pb *PromptBuilder) AddBoldText(sectionName, text string) *PromptBuilder

+ func (pb *PromptBuilder) AddBulletItem(sectionName, item string) *PromptBuilder

+ func (pb *PromptBuilder) AddBulletItemF(sectionName string, value interface{}) *PromptBuilder

+ func (pb *PromptBuilder) AddCodeBlock(sectionName, code, language string) *PromptBuilder

+ func (pb *PromptBuilder) AddCodeBlockF(sectionName string, value interface{}, language string) *PromptBuilder

+ func (pb *PromptBuilder) AddHeader(sectionName, text string, level int) *PromptBuilder

+ func (pb *PromptBuilder) AddHorizontalRule(sectionName string) *PromptBuilder

+ func (pb *PromptBuilder) AddItalicText(sectionName, text string) *PromptBuilder

+ func (pb *PromptBuilder) AddLink(sectionName, text, url string) *PromptBuilder

+ func (pb *PromptBuilder) AddTable(sectionName string, headers []string, rows [][]string) *PromptBuilder

type Tool

+ func NewTool(options ...ToolOption) (Tool, error)

+ type ToolConfig struct

+ Description string

+ ExecuteFunc func(args json.RawMessage) (interface{}, error)

+ Name string

+ Schema any

+ type ToolOption func(*ToolConfig) error

+ func WithToolDescription(description string) ToolOption

+ func WithToolExecuteHandler(executeFunc func(args json.RawMessage) (interface{}, error)) ToolOption

+ func WithToolName(name string) ToolOption

+ func WithToolSchema(schema any) ToolOption

v0.3.0

May 29, 2025

Changes in this version

type Agent

+ Chat func(ctx context.Context, options ...ChatOption) (string, error)

+ type AgentOption func(*agent) error

+ func WithClient(client LLMClient) AgentOption

+ func WithDescription(description string) AgentOption

+ func WithJSONResponseFormat(schemaName string, structSchema any) AgentOption

+ func WithMemory(memory Memory) AgentOption

+ func WithModel(model string) AgentOption

+ func WithName(name string) AgentOption

+ func WithSystemPrompt(prompt string) AgentOption

+ func WithTemperature(temperature float32) AgentOption

+ func WithTimeout(timeout time.Duration) AgentOption

+ func WithTool(tool Tool) AgentOption

+ func WithTools(tools ...Tool) AgentOption

+ type ChatOption func(*chatRequest)

+ func WithAdditionalMessages(messages ...[]Message) ChatOption

+ func WithChatTimeout(timeout time.Duration) ChatOption

+ func WithImages(imageURLs ...string) ChatOption

+ func WithInput(input string) ChatOption

+ func WithUserName(userName string) ChatOption

+ type ExecuteAgentOption func(*executeAgentRequest)

+ func WithExecuteAdditionalMessages(messages ...[]Message) ExecuteAgentOption

+ func WithExecuteImages(imageURLs ...string) ExecuteAgentOption

+ func WithExecuteInput(input string) ExecuteAgentOption

+ func WithExecuteUserName(userName string) ExecuteAgentOption

+ func WithGlobalHistoryContext() ExecuteAgentOption

type Memory

+ func NewMemory(options ...MemoryOption) (Memory, error)

+ type MemoryConfig struct

+ type MemoryOption func(*MemoryConfig) error

+ func WithAddHandler(addFunc func(message Message)) MemoryOption

+ func WithGetHandler(getFunc func() []Message) MemoryOption

type Message

+ ImageURLs []string

+ type PipelineOption func(*pipelineRequest)

+ func WithPipelineImages(imageURLs ...string) PipelineOption

+ func WithPipelineInput(input string) PipelineOption

+ func WithPipelineUserName(userName string) PipelineOption

type Syndicate

+ GetAgentNames func() []string

+ GetGlobalHistory func() []Message

+ GetPipeline func() []string

+ type SyndicateOption func(*syndicate) error

+ func WithAgent(agent Agent) SyndicateOption

+ func WithAgents(agents ...Agent) SyndicateOption

+ func WithGlobalHistory(history Memory) SyndicateOption

+ func WithPipeline(pipeline ...string) SyndicateOption

v0.2.6

Mar 8, 2025

Changes in this version

type Message

+ ToolCallID string

v0.2.5

Mar 8, 2025

v0.2.4

Mar 8, 2025

v0.2.3

Mar 8, 2025

v0.2.2

Mar 7, 2025

v0.2.1

Mar 7, 2025

Changes in this version

type AgentBuilder

+ func (b *AgentBuilder) SetDescription(description string) *AgentBuilder

v0.2.0

Feb 23, 2025

Changes in this version

type AgentBuilder

+ func NewAgent() *AgentBuilder

+ func (b *AgentBuilder) EquipTool(tool Tool) *AgentBuilder

+ type Syndicate struct

+ func (s *Syndicate) ExecuteAgent(ctx context.Context, agentName, userName, input string) (string, error)

+ func (s *Syndicate) ExecutePipeline(ctx context.Context, userName, input string) (string, error)

+ func (s *Syndicate) FindAgent(name string) (Agent, bool)

+ type SyndicateBuilder struct

+ func NewSyndicate() *SyndicateBuilder

+ func (b *SyndicateBuilder) Build() *Syndicate

+ func (b *SyndicateBuilder) DefinePipeline(pipeline []string) *SyndicateBuilder

+ func (b *SyndicateBuilder) RecruitAgent(agent Agent) *SyndicateBuilder

+ func (b *SyndicateBuilder) SetGlobalHistory(history Memory) *SyndicateBuilder

v0.1.0

Feb 22, 2025

Changes in this version

+ const FinishReasonLength

+ const FinishReasonStop

+ const FinishReasonToolCalls

+ const RoleAssistant

+ const RoleDeveloper

+ const RoleSystem

+ const RoleTool

+ const RoleUser

+ func GenerateRawSchema(v any) (json.RawMessage, error)

+ func ValidateDefinition(def *Definition) error

+ type Agent interface

+ AddTool func(tool Tool)

+ GetName func() string

+ Process func(ctx context.Context, userName string, input string, ...) (string, error)

+ SetConfigPrompt func(prompt string)

+ type AgentBuilder struct

+ func NewAgentBuilder() *AgentBuilder

+ func (b *AgentBuilder) AddTool(tool Tool) *AgentBuilder

+ func (b *AgentBuilder) Build() (*BaseAgent, error)

+ func (b *AgentBuilder) SetClient(client LLMClient) *AgentBuilder

+ func (b *AgentBuilder) SetConfigPrompt(prompt string) *AgentBuilder

+ func (b *AgentBuilder) SetJSONResponseFormat(schemaName string, structSchema any) *AgentBuilder

+ func (b *AgentBuilder) SetMemory(memory Memory) *AgentBuilder

+ func (b *AgentBuilder) SetModel(model string) *AgentBuilder

+ func (b *AgentBuilder) SetName(name string) *AgentBuilder

+ func (b *AgentBuilder) SetTemperature(temperature float32) *AgentBuilder

+ type BaseAgent struct

+ func (b *BaseAgent) AddTool(tool Tool)

+ func (b *BaseAgent) GetName() string

+ func (b *BaseAgent) Process(ctx context.Context, userName, input string, additionalMessages ...[]Message) (string, error)

+ func (b *BaseAgent) SetConfigPrompt(prompt string)

+ type ChatCompletionRequest struct

+ Messages []Message

+ Model string

+ ResponseFormat *ResponseFormat

+ Temperature float32

+ Tools []ToolDefinition

+ type ChatCompletionResponse struct

+ Choices []Choice

+ Usage Usage

+ type Choice struct

+ FinishReason string

+ Message Message

+ type DataType string

+ const Array

+ const Boolean

+ const Integer

+ const Null

+ const Number

+ const Object

+ const String

+ type DeepseekR1Client struct

+ func (d *DeepseekR1Client) CreateChatCompletion(ctx context.Context, req ChatCompletionRequest) (ChatCompletionResponse, error)

+ type Definition struct

+ AdditionalProperties any

+ Description string

+ Enum []string

+ Items *Definition

+ Properties map[string]Definition

+ Required []string

+ Type DataType

+ func (d *Definition) MarshalJSON() ([]byte, error)

+ type Embedder struct

+ func (e *Embedder) GenerateEmbedding(ctx context.Context, data string, model ...openai.EmbeddingModel) ([]float32, error)

+ type EmbedderBuilder struct

+ func NewEmbedderBuilder() *EmbedderBuilder

+ func (b *EmbedderBuilder) Build() (*Embedder, error)

+ func (b *EmbedderBuilder) SetClient(client *openai.Client) *EmbedderBuilder

+ func (b *EmbedderBuilder) SetModel(model openai.EmbeddingModel) *EmbedderBuilder

+ type JSONSchema struct

+ Name string

+ Schema json.RawMessage

+ Strict bool

+ type LLMClient interface

+ CreateChatCompletion func(ctx context.Context, req ChatCompletionRequest) (ChatCompletionResponse, error)

+ func NewDeepseekR1Client(apiKey, baseURL string) LLMClient

+ func NewOpenAIAzureClient(apiKey, endpoint string) LLMClient

+ func NewOpenAIClient(apiKey string) LLMClient

+ type Memory interface

+ Add func(message Message)

+ Clear func()

+ Get func() []Message

+ func NewSimpleMemory() Memory

+ type Message struct

+ Content string

+ Name string

+ Role string

+ ToolCalls []ToolCall

+ ToolID string

+ type OpenAIClient struct

+ func (o *OpenAIClient) CreateChatCompletion(ctx context.Context, req ChatCompletionRequest) (ChatCompletionResponse, error)

+ type Orchestrator struct

+ func NewOrchestrator() *Orchestrator

+ func (o *Orchestrator) GetAgent(name string) (Agent, bool)

+ func (o *Orchestrator) Process(ctx context.Context, agentName, userName, input string) (string, error)

+ func (o *Orchestrator) ProcessSequence(ctx context.Context, userName, input string) (string, error)

+ type OrchestratorBuilder struct

+ func NewOrchestratorBuilder() *OrchestratorBuilder

+ func (b *OrchestratorBuilder) AddAgent(agent Agent) *OrchestratorBuilder

+ func (b *OrchestratorBuilder) Build() *Orchestrator

+ func (b *OrchestratorBuilder) SetGlobalHistory(history Memory) *OrchestratorBuilder

+ func (b *OrchestratorBuilder) SetSequence(seq []string) *OrchestratorBuilder

+ type PromptBuilder struct

+ func NewPromptBuilder() *PromptBuilder

+ func (pb *PromptBuilder) AddListItem(sectionName, item string) *PromptBuilder

+ func (pb *PromptBuilder) AddListItemF(sectionName string, value interface{}) *PromptBuilder

+ func (pb *PromptBuilder) AddSubSection(childName, parentName string) *PromptBuilder

+ func (pb *PromptBuilder) AddText(sectionName, text string) *PromptBuilder

+ func (pb *PromptBuilder) AddTextF(sectionName string, value interface{}) *PromptBuilder

+ func (pb *PromptBuilder) Build() string

+ func (pb *PromptBuilder) CreateSection(name string) *PromptBuilder

+ type ResponseFormat struct

+ JSONSchema *JSONSchema

+ Type string

+ type Section struct

+ Lines []string

+ Name string

+ SubSections []*Section

+ type SimpleMemory struct

+ func (s *SimpleMemory) Add(message Message)

+ func (s *SimpleMemory) Clear()

+ func (s *SimpleMemory) Get() []Message

+ type Tool interface

+ Execute func(args json.RawMessage) (interface{}, error)

+ GetDefinition func() ToolDefinition

+ type ToolCall struct

+ Args json.RawMessage

+ ID string

+ Name string

+ type ToolDefinition struct

+ Description string

+ Name string

+ Parameters json.RawMessage

+ type Usage struct

+ CompletionTokens int

+ PromptTokens int

+ TotalTokens int

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