assistant

Documentation

Index

• Variables
• func ChatCommand() *cobra.Command
• func CleanUpAssistantCode() *cobra.Command
• func GenerateCommand() *cobra.Command
• func MergeAssistantCode() *cobra.Command
• type Job
• type Reply
• type Result
• type Task
• type WorkerPool
  • func NewWorkerPool(ctx context.Context, workerSize int, jobQueueSize int) (*WorkerPool, error)
  • func (wp *WorkerPool) Results() <-chan Result
  • func (wp *WorkerPool) Start()
  • func (wp *WorkerPool) Stop()
  • func (wp *WorkerPool) Submit(job Job, timeout time.Duration) error
  • func (wp *WorkerPool) Wait()

Variables

var (
	ErrJobQueueFull   = fmt.Errorf("job queue is full")
	ErrJobQueueClosed = fmt.Errorf("job queue is closed")
)

var ErrnoAssistantMarker = fmt.Errorf("\n%s%s\n\n",
	`No Go code requiring AI assistant generation was detected. To trigger the AI assistant, ensure the following conditions are met:
    1. Define a function in Go code.
    2. Add detailed function comments (used as AI prompts).
    3. Add panic("implement me") inside the function body.

Example:`, fmt.Sprintf(`

    %s
    func MyFuncName() {
        %s
    }`, color.HiCyanString("// Describe the specific functionality of the function"), color.HiCyanString(`panic("implement me")`)))

nolint

Functions

func ChatCommand

func ChatCommand() *cobra.Command

ChatCommand chat with AI Assistant

func CleanUpAssistantCode

func CleanUpAssistantCode() *cobra.Command

CleanUpAssistantCode clean up all assistant generated code

func GenerateCommand

func GenerateCommand() *cobra.Command

GenerateCommand command

func MergeAssistantCode

func MergeAssistantCode() *cobra.Command

MergeAssistantCode merge AI assistant generated code into source Go file

Types

type Job

type Job struct {
	ID   int
	Task Task
}

Job represents a task

type Reply

type Reply struct {
	JobID     int      `json:"jobID"`
	ErrMsg    string   `json:"errMsg"`
	SrcFile   string   `json:"srcFile"`
	Functions []string `json:"functions"`
	Prompt    string   `json:"prompt"`

	Contents map[string]string `json:"contents"` // reply contents
}

Reply execute assistant task result

type Result

type Result struct {
	JobID     int
	Value     interface{}
	Err       error
	StartTime time.Time
	EndTime   time.Time
}

Result represents the execution result of a task

type Task

type Task interface {
	Execute(ctx context.Context) (interface{}, error)
}

Task is interface for Job

type WorkerPool

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

WorkerPool represents a worker pool

func NewWorkerPool

func NewWorkerPool(ctx context.Context, workerSize int, jobQueueSize int) (*WorkerPool, error)

NewWorkerPool creates a new worker pool

func (*WorkerPool) Results

func (wp *WorkerPool) Results() <-chan Result

Results returns the result channel

func (*WorkerPool) Start

func (wp *WorkerPool) Start()

Start starts the worker pool

func (*WorkerPool) Stop

func (wp *WorkerPool) Stop()

Stop stops the worker pool

func (*WorkerPool) Submit

func (wp *WorkerPool) Submit(job Job, timeout time.Duration) error

Submit submits a task to the worker pool

func (*WorkerPool) Wait

func (wp *WorkerPool) Wait()

Wait waits for all workers to complete and closes the result channel