agents

Documentation

Index

• func InitializeConnection(ctx context.Context, agentConfig Config, modelConfig models.Config) (client openai.Client, log logger.Logger, err error)
• type Config
• type Intent
• type Kind
• type OrchestratorAgent
• type Plan
• type Task
• type TasksAgent

Functions

func InitializeConnection

func InitializeConnection(ctx context.Context, agentConfig Config, modelConfig models.Config) (client openai.Client, log logger.Logger, err error)

Types

type Config

type Config struct {
	// Name is the identifier for the agent
	Name string

	// Description provides details about the agent's purpose
	Description string

	// SystemInstructions defines the agent's behavior and role
	SystemInstructions string

	// EngineURL is the base URL for the model inference engine
	EngineURL string

	// APIKey
	APIKey string

	KeepConversationHistory bool
}

Config represents the core configuration parameters for creating an agent

type Intent

type Intent struct {
	TopicDiscussion string `json:"topic_discussion"`
}

type Kind

type Kind string

AgentKind represents the type of agent

const (
	Basic        Kind = "Basic"
	Chat         Kind = "Chat"
	ChatServer   Kind = "ChatServer"
	Remote       Kind = "Remote"
	Tools        Kind = "Tools"
	Orchestrator Kind = "Orchestrator"
	Rag          Kind = "Rag"
	Compressor   Kind = "Compressor"
	Structured   Kind = "Structured"
	Macro        Kind = "Macro"
	Composite    Kind = "Composite"
	Tasks        Kind = "Tasks"
)

type OrchestratorAgent

type OrchestratorAgent interface {
	// IdentifyIntent sends messages and returns the identified intent
	IdentifyIntent(userMessages []messages.Message) (intent *Intent, finishReason string, err error)

	// IdentifyTopicFromText is a convenience method that takes a text string and returns the topic
	IdentifyTopicFromText(text string) (string, error)
}

OrchestratorAgent is an interface for agents that can identify intents/topics from user input

type Plan

type Plan struct {
	Tasks []Task `json:"tasks"`
}

type Task

type Task struct {
	ID          string `json:"id"`
	Description string `json:"description"`
	Responsible string `json:"responsible"`
}

type TasksAgent

type TasksAgent interface {
	// Work in progress - not fully defined yet
	IdentifyPlan(userMessages []messages.Message) (plan *Plan, finishReason string, err error)
	IdentifyPlanFromText(text string) (*Plan, error)
}