sumer

package

v0.0.1 Latest Latest Go to latest Published: Nov 29, 2023 License: MIT Imports: 20 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/jopbrown/codesum

Links

Open Source Insights

Documentation ¶

Index ¶

func FileSummaryQuestion(prompt strutil.Expander, fileName, fileContent string) string
func FinalSummaryQuestion(prompt strutil.Expander) string
func SummaryTableQuestion(prompt strutil.Expander, fileList []string) string
type CodeSummary
- func NewCodeSummary() *CodeSummary
type FileSummary
- func (ps *FileSummary) GetSummary() string
type Message
type PartialSummaries
type QA
- func NewQA(question, answer string) *QA
type Summarizer
- func NewSummarizer(cfg *cfgs.Config, pushMsgCallback func(msg *openai.ChatCompletionMessage), ...) (*Summarizer, error)
- func (sumer *Summarizer) Summarize(ctx context.Context, codeFolder string) (reportPath string, err error)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func FileSummaryQuestion ¶

func FileSummaryQuestion(prompt strutil.Expander, fileName, fileContent string) string

func FinalSummaryQuestion ¶

func FinalSummaryQuestion(prompt strutil.Expander) string

func SummaryTableQuestion ¶

func SummaryTableQuestion(prompt strutil.Expander, fileList []string) string

Types ¶

type CodeSummary ¶

type CodeSummary struct {
	PartialList    []*PartialSummaries
	FinalSummaryQA *QA
}

func NewCodeSummary ¶

func NewCodeSummary() *CodeSummary

func (*CodeSummary) AddPartialSummaries ¶

func (cs *CodeSummary) AddPartialSummaries(systemPrompt string) *PartialSummaries

func (*CodeSummary) FinalSummary ¶

func (cs *CodeSummary) FinalSummary() string

func (*CodeSummary) GetFileSummaryTable ¶

func (cs *CodeSummary) GetFileSummaryTable() string

func (*CodeSummary) RequestFinalSummaryMessages ¶

func (cs *CodeSummary) RequestFinalSummaryMessages(question string) []Message

func (*CodeSummary) SaveMarkdown ¶

func (cs *CodeSummary) SaveMarkdown(fname string) error

func (*CodeSummary) SetFinalSummaryQA ¶

func (cs *CodeSummary) SetFinalSummaryQA(question, answer string) *QA

func (*CodeSummary) WriteFileSummaryTable ¶

func (cs *CodeSummary) WriteFileSummaryTable(w io.Writer)

func (*CodeSummary) WriteMarkdown ¶

func (cs *CodeSummary) WriteMarkdown(w io.Writer) error

type FileSummary ¶

type FileSummary struct {
	FileName string
	QA       *QA
}

func (*FileSummary) GetSummary ¶

func (ps *FileSummary) GetSummary() string

type Message ¶

type Message = openai.ChatCompletionMessage

type PartialSummaries ¶

type PartialSummaries struct {
	System       *Message
	FilesSummary []*FileSummary
	SummaryQA    *QA
}

func (*PartialSummaries) AddFileSummary ¶

func (ps *PartialSummaries) AddFileSummary(fileName, question, answer string) *FileSummary

func (*PartialSummaries) FileList ¶

func (r *PartialSummaries) FileList() []string

func (*PartialSummaries) GetSummary ¶

func (pa *PartialSummaries) GetSummary() string

func (*PartialSummaries) PopFileSummary ¶

func (ps *PartialSummaries) PopFileSummary() *FileSummary

func (*PartialSummaries) RequestFileSummaryMessages ¶

func (ps *PartialSummaries) RequestFileSummaryMessages(question string) []Message

func (*PartialSummaries) SetSummaryQA ¶

func (pa *PartialSummaries) SetSummaryQA(question, answer string) *QA

func (*PartialSummaries) SetSystemPrompt ¶

func (ps *PartialSummaries) SetSystemPrompt(prompt string) *Message

type QA ¶

type QA struct {
	Question *Message
	Answer   *Message
}

func NewQA ¶

func NewQA(question, answer string) *QA

type Summarizer ¶

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

func NewSummarizer ¶

func NewSummarizer(cfg *cfgs.Config, pushMsgCallback func(msg *openai.ChatCompletionMessage), streamAnswerCallbackOpt ...func(token string)) (*Summarizer, error)

func (*Summarizer) Summarize ¶

func (sumer *Summarizer) Summarize(ctx context.Context, codeFolder string) (reportPath string, err error)

Source Files ¶

View all Source files

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