agent

Documentation

Index

• type Agent
  • func New(ret Retriever, llmClient llm.LLM) *Agent
  • func NewWithValidator(ret Retriever, llmClient llm.LLM, validator *strudel.Validator) *Agent
  • func (a *Agent) Generate(ctx context.Context, req GenerateRequest) (*GenerateResponse, error)
  • func (a *Agent) GenerateStream(ctx context.Context, req GenerateRequest, ...) error
  • func (a *Agent) SetValidator(v *strudel.Validator)
• type DocReference
• type GenerateRequest
• type GenerateResponse
• type Message
• type RAGCache
• type Retriever
• type StreamEvent
• type StrudelReference
• type SystemPromptContext

Types

type Agent

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

orchestrates rag-powered code generation

func New

func New(ret Retriever, llmClient llm.LLM) *Agent

func NewWithValidator

func NewWithValidator(ret Retriever, llmClient llm.LLM, validator *strudel.Validator) *Agent

creates an agent with code validation enabled

func (*Agent) Generate

func (a *Agent) Generate(ctx context.Context, req GenerateRequest) (*GenerateResponse, error)

func (*Agent) GenerateStream

func (a *Agent) GenerateStream(ctx context.Context, req GenerateRequest, onEvent func(event StreamEvent) error) error

generates code with streaming response chunks. the onEvent callback is called for each chunk and final metadata. note: streaming skips validation retry to maintain real-time delivery.

func (*Agent) SetValidator

func (a *Agent) SetValidator(v *strudel.Validator)

sets the validator for the agent

type DocReference

type DocReference struct {
	PageName     string `json:"page_name"`
	SectionTitle string `json:"section_title,omitempty"`
	URL          string `json:"url"`
}

reference to documentation used as context

type GenerateRequest

type GenerateRequest struct {
	UserQuery           string
	EditorState         string
	ConversationHistory []Message
	CustomGenerator     llm.TextGenerator // optional byok generator
	SessionID           string            // optional: enables rag caching for follow-up messages
	RAGCache            RAGCache          // optional: cache for rag results
}

all inputs for code generation

type GenerateResponse

type GenerateResponse struct {
	Code                string                    `json:"code,omitempty"`
	DocsRetrieved       int                       `json:"docs_retrieved"`
	ExamplesRetrieved   int                       `json:"examples_retrieved"`
	Examples            []retriever.ExampleResult `json:"-"` // for attribution tracking (internal)
	Docs                []retriever.SearchResult  `json:"-"` // for reference tracking (internal)
	StrudelReferences   []StrudelReference        `json:"strudel_references,omitempty"`
	DocReferences       []DocReference            `json:"doc_references,omitempty"`
	Model               string                    `json:"model"`
	IsActionable        bool                      `json:"is_actionable"`
	IsCodeResponse      bool                      `json:"is_code_response"` // true if response should update editor
	ClarifyingQuestions []string                  `json:"clarifying_questions,omitempty"`
	InputTokens         int                       `json:"input_tokens"`
	OutputTokens        int                       `json:"output_tokens"`
	DidRetry            bool                      `json:"did_retry,omitempty"`
	ValidationError     string                    `json:"validation_error,omitempty"`
}

generated code and metadata

type Message

type Message struct {
	Role                string             `json:"role"`                       // "user" or "assistant"
	Content             string             `json:"content"`                    // message content
	IsActionable        bool               `json:"is_actionable,omitempty"`    // true if response can be applied
	IsCodeResponse      bool               `json:"is_code_response,omitempty"` // true if AI generated code
	ClarifyingQuestions []string           `json:"clarifying_questions,omitempty"`
	StrudelReferences   []StrudelReference `json:"strudel_references,omitempty"`
	DocReferences       []DocReference     `json:"doc_references,omitempty"`
}

single conversation turn

type RAGCache

type RAGCache interface {
	GetRAGCache(ctx context.Context, sessionID string) (*buffer.CachedRAGResult, error)
	SetRAGCache(ctx context.Context, sessionID string, cache *buffer.CachedRAGResult) error
	ClearRAGCache(ctx context.Context, sessionID string) error
}

rag result caching interface

type Retriever

type Retriever interface {
	HybridSearchDocs(ctx context.Context, query, editorState string, k int) ([]retriever.SearchResult, error)
	HybridSearchExamples(ctx context.Context, query, editorState string, k int) ([]retriever.ExampleResult, error)
}

document and example retrieval interface

type StreamEvent

type StreamEvent struct {
	Type    string `json:"type"`              // "chunk", "refs", "done", "error"
	Content string `json:"content,omitempty"` // text chunk for type="chunk"
	Error   string `json:"error,omitempty"`   // error message for type="error"

	// final metadata sent with type="done"
	StrudelReferences []StrudelReference `json:"strudel_references,omitempty"`
	DocReferences     []DocReference     `json:"doc_references,omitempty"`
	Model             string             `json:"model,omitempty"`
	IsCodeResponse    bool               `json:"is_code_response,omitempty"`
	InputTokens       int                `json:"input_tokens,omitempty"`
	OutputTokens      int                `json:"output_tokens,omitempty"`
}

chunk of a streaming response

type StrudelReference

type StrudelReference struct {
	ID         string `json:"id"`
	Title      string `json:"title"`
	AuthorName string `json:"author_name"`
	URL        string `json:"url"`
}

reference to a strudel used as context

type SystemPromptContext

type SystemPromptContext struct {
	Cheatsheet    string
	EditorState   string
	Docs          []retriever.SearchResult
	Examples      []retriever.ExampleResult
	Conversations []Message
	QueryAnalysis *llm.QueryAnalysis // optional: helps generator tailor response
	UsedRAGCache  bool               // if true, add instruction for requesting more docs
}

all context needed to build the system prompt