structured

Documentation

Index

• func StructToJSONSchema(t reflect.Type) map[string]any
• type Agent
  • func NewAgent[Output any](ctx context.Context, agentConfig agents.Config, modelConfig models.Config, ...) (*Agent[Output], error)
  • func (agent *Agent[Output]) AddMessage(role roles.Role, content string)
  • func (agent *Agent[Output]) AddMessages(msgs []messages.Message)
  • func (agent *Agent[Output]) ExportMessagesToJSON() (string, error)
  • func (agent *Agent[Output]) GenerateStructuredData(userMessages []messages.Message) (response *Output, finishReason string, err error)
  • func (agent *Agent[Output]) GetConfig() agents.Config
  • func (agent *Agent[Output]) GetContext() context.Context
  • func (agent *Agent[Output]) GetLastRequestJSON() (string, error)
  • func (agent *Agent[Output]) GetLastRequestRawJSON() string
  • func (agent *Agent[Output]) GetLastResponseJSON() (string, error)
  • func (agent *Agent[Output]) GetLastResponseRawJSON() string
  • func (agent *Agent[Output]) GetMessages() []messages.Message
  • func (agent *Agent[Output]) GetModelConfig() models.Config
  • func (agent *Agent[Output]) GetModelID() string
  • func (agent *Agent[Output]) GetName() string
  • func (agent *Agent[Output]) Kind() agents.Kind
  • func (agent *Agent[Output]) ResetMessages()
  • func (agent *Agent[Output]) SetConfig(config agents.Config)
  • func (agent *Agent[Output]) SetContext(ctx context.Context)
  • func (agent *Agent[Output]) SetModelConfig(config models.Config)
• type AgentOption
• type BaseAgent
  • func NewBaseAgent[Output any](ctx context.Context, agentConfig agents.Config, ...) (structuredAgent *BaseAgent[Output], err error)
  • func (agent *BaseAgent[Output]) GenerateStructuredData(messages []openai.ChatCompletionMessageParamUnion) (response *Output, finishReason string, err error)
  • func (agent *BaseAgent[Output]) Kind() (kind agents.Kind)
• type StructuredAgentOption
  • func AfterCompletion[Output any](fn func(*Agent[Output])) StructuredAgentOption[Output]
  • func BeforeCompletion[Output any](fn func(*Agent[Output])) StructuredAgentOption[Output]
• type StructuredResult

Functions

func StructToJSONSchema

func StructToJSONSchema(t reflect.Type) map[string]any

Types

type Agent

type Agent[Output any] struct {
	// contains filtered or unexported fields
}

Agent represents a simplified structured data agent that hides OpenAI SDK details

func NewAgent

func NewAgent[Output any](
	ctx context.Context,
	agentConfig agents.Config,
	modelConfig models.Config,
	opts ...StructuredAgentOption[Output],
) (*Agent[Output], error)

NewAgent creates a new simplified structured data agent

func (*Agent[Output]) AddMessage

func (agent *Agent[Output]) AddMessage(role roles.Role, content string)

func (*Agent[Output]) AddMessages

func (agent *Agent[Output]) AddMessages(msgs []messages.Message)

AddMessages adds multiple messages to the conversation history

func (*Agent[Output]) ExportMessagesToJSON

func (agent *Agent[Output]) ExportMessagesToJSON() (string, error)

func (*Agent[Output]) GenerateStructuredData

func (agent *Agent[Output]) GenerateStructuredData(userMessages []messages.Message) (response *Output, finishReason string, err error)

Generate sends messages and returns structured data

func (*Agent[Output]) GetConfig

func (agent *Agent[Output]) GetConfig() agents.Config

GetConfig returns the agent configuration

func (*Agent[Output]) GetContext

func (agent *Agent[Output]) GetContext() context.Context

GetContext returns the agent's context

func (*Agent[Output]) GetLastRequestJSON

func (agent *Agent[Output]) GetLastRequestJSON() (string, error)

func (*Agent[Output]) GetLastRequestRawJSON

func (agent *Agent[Output]) GetLastRequestRawJSON() string

func (*Agent[Output]) GetLastResponseJSON

func (agent *Agent[Output]) GetLastResponseJSON() (string, error)

func (*Agent[Output]) GetLastResponseRawJSON

func (agent *Agent[Output]) GetLastResponseRawJSON() string

func (*Agent[Output]) GetMessages

func (agent *Agent[Output]) GetMessages() []messages.Message

GetMessages returns all conversation messages

func (*Agent[Output]) GetModelConfig

func (agent *Agent[Output]) GetModelConfig() models.Config

GetModelConfig returns the model configuration

func (*Agent[Output]) GetModelID

func (agent *Agent[Output]) GetModelID() string

func (*Agent[Output]) GetName

func (agent *Agent[Output]) GetName() string

func (*Agent[Output]) Kind

func (agent *Agent[Output]) Kind() agents.Kind

Kind returns the agent type

func (*Agent[Output]) ResetMessages

func (agent *Agent[Output]) ResetMessages()

ResetMessages clears all messages except the system instruction

func (*Agent[Output]) SetConfig

func (agent *Agent[Output]) SetConfig(config agents.Config)

SetConfig updates the agent configuration

func (*Agent[Output]) SetContext

func (agent *Agent[Output]) SetContext(ctx context.Context)

SetContext updates the agent's context

func (*Agent[Output]) SetModelConfig

func (agent *Agent[Output]) SetModelConfig(config models.Config)

SetModelConfig updates the model configuration Note: This updates the stored config but doesn't regenerate the internal OpenAI params For most parameters to take effect, create a new agent with the new config

type AgentOption

type AgentOption[Output any] func(*BaseAgent[Output])

type BaseAgent

type BaseAgent[Output any] struct {
	*base.Agent
}

BaseAgent wraps the shared base.Agent for structured output functionality

func NewBaseAgent

func NewBaseAgent[Output any](
	ctx context.Context,
	agentConfig agents.Config,
	modelConfig openai.ChatCompletionNewParams,
	options ...AgentOption[Output],
) (structuredAgent *BaseAgent[Output], err error)

func (*BaseAgent[Output]) GenerateStructuredData

func (agent *BaseAgent[Output]) GenerateStructuredData(messages []openai.ChatCompletionMessageParamUnion) (response *Output, finishReason string, err error)

func (*BaseAgent[Output]) Kind

func (agent *BaseAgent[Output]) Kind() (kind agents.Kind)

type StructuredAgentOption

type StructuredAgentOption[Output any] func(*Agent[Output])

StructuredAgentOption is a functional option for configuring an Agent during creation

func AfterCompletion

func AfterCompletion[Output any](fn func(*Agent[Output])) StructuredAgentOption[Output]

AfterCompletion sets a hook that is called after each structured data generation

func BeforeCompletion

func BeforeCompletion[Output any](fn func(*Agent[Output])) StructuredAgentOption[Output]

BeforeCompletion sets a hook that is called before each structured data generation

type StructuredResult

type StructuredResult[Output any] struct {
	Data         *Output
	FinishReason string
}

StructuredResult represents the result of structured data generation