dive

package module

Go to main page

Versions in this module

v0

v0.0.8

Jul 24, 2025

v0.0.7

Jun 12, 2025

v0.0.6

Jun 12, 2025

v0.0.5

May 28, 2025

Changes in this version

type TypedToolAdapter

+ func (t *TypedToolAdapter[T]) ToolConfiguration(providerName string) map[string]any

v0.0.4

May 23, 2025

Changes in this version

+ var ErrStreamClosed = errors.New("stream is closed")

+ func NewEventStream() (ResponseStream, EventPublisher)

+ func NewID() string

+ func ReadEventPayloads[T any](ctx context.Context, stream ResponseStream) ([]T, error)

+ func ReadMessages(ctx context.Context, stream ResponseStream) ([]*llm.Message, error)

type Agent

+ CreateResponse func(ctx context.Context, opts ...Option) (*Response, error)

+ StreamResponse func(ctx context.Context, opts ...Option) (ResponseStream, error)

+ type AutoApproveConfirmer struct

+ func (a *AutoApproveConfirmer) Confirm(ctx context.Context, req ConfirmationRequest) (bool, error)

+ type ConfirmationMode string

+ const ConfirmAlways

+ const ConfirmIfDestructive

+ const ConfirmIfNotReadOnly

+ const ConfirmNever

+ func (c ConfirmationMode) IsValid() bool

+ func (c ConfirmationMode) String() string

+ type ConfirmationRequest struct

+ Data interface{}

+ Details string

+ Prompt string

+ Tool Tool

+ type Confirmer interface

+ Confirm func(ctx context.Context, req ConfirmationRequest) (bool, error)

+ func NewConfirmer(mode string) (Confirmer, error)

+ type DenyAllConfirmer struct

+ func (d *DenyAllConfirmer) Confirm(ctx context.Context, req ConfirmationRequest) (bool, error)

type Environment

+ AddAgent func(agent Agent) error

+ Confirmer func() Confirmer

+ type EventCallback func(ctx context.Context, event *ResponseEvent) error

+ type EventPublisher interface

+ Close func()

+ Send func(ctx context.Context, event *ResponseEvent) error

+ type EventType string

+ const EventTypeError

+ const EventTypeLLMEvent

+ const EventTypeResponseCompleted

+ const EventTypeResponseCreated

+ const EventTypeResponseFailed

+ const EventTypeResponseInProgress

+ const EventTypeResponseToolCall

+ const EventTypeResponseToolError

+ const EventTypeResponseToolResult

+ func (t EventType) String() string

+ type Option func(*Options)

+ func WithEventCallback(callback EventCallback) Option

+ func WithInput(input string) Option

+ func WithMessage(message *llm.Message) Option

+ func WithMessages(messages []*llm.Message) Option

+ type Options struct

+ EventCallback EventCallback

+ Messages []*llm.Message

+ ThreadID string

+ UserID string

+ func (o *Options) Apply(opts []Option)

+ type Property = schema.Property

+ type Response struct

+ CreatedAt time.Time

+ FinishedAt *time.Time

+ ID string

+ Items []*ResponseItem

+ Model string

+ Usage *llm.Usage

+ func (r *Response) OutputText() string

+ func (r *Response) ToolCallResults() []*ToolCallResult

+ type ResponseEvent struct

+ Error error

+ Item *ResponseItem

+ Response *Response

+ Type EventType

+ type ResponseItem struct

+ Event *llm.Event

+ Message *llm.Message

+ ToolCall *llm.ToolUseContent

+ ToolCallResult *ToolCallResult

+ Type ResponseItemType

+ Usage *llm.Usage

+ type ResponseItemType string

+ const ResponseItemTypeMessage

+ const ResponseItemTypeToolCall

+ const ResponseItemTypeToolCallResult

+ type ResponseStream interface

+ Close func() error

+ Err func() error

+ Event func() *ResponseEvent

+ Next func(ctx context.Context) bool

+ type Schema = schema.Schema

+ type StepResult struct

+ Content string

+ Format OutputFormat

+ Object interface{}

+ Usage llm.Usage

+ type StructuredResponse struct

+ func ParseStructuredResponse(text string) StructuredResponse

+ func (s *StructuredResponse) Content() string

+ func (s *StructuredResponse) RawText() string

+ func (s *StructuredResponse) Status() TaskStatus

+ func (s *StructuredResponse) StatusDescription() string

+ func (s *StructuredResponse) Thinking() string

type Task

+ func NewTask(opts TaskOptions) *Task

+ type TaskOptions struct

+ Name string

+ Prompt string

+ Timeout time.Duration

type TaskStatus

+ const TaskStatusUnknown

+ type TerminalConfirmer struct

+ func NewTerminalConfirmer(opts TerminalConfirmerOptions) *TerminalConfirmer

+ func (c *TerminalConfirmer) Confirm(ctx context.Context, req ConfirmationRequest) (bool, error)

+ func (c *TerminalConfirmer) ShouldConfirm(req ConfirmationRequest) bool

+ type TerminalConfirmerOptions struct

+ Mode ConfirmationMode

+ type Tool interface

+ Annotations func() ToolAnnotations

+ Call func(ctx context.Context, input any) (*ToolResult, error)

+ Description func() string

+ Name func() string

+ Schema func() schema.Schema

+ type ToolAnnotations struct

+ DestructiveHint bool

+ Extra map[string]any

+ IdempotentHint bool

+ OpenWorldHint bool

+ ReadOnlyHint bool

+ Title string

+ func (a *ToolAnnotations) MarshalJSON() ([]byte, error)

+ func (a *ToolAnnotations) UnmarshalJSON(data []byte) error

+ type ToolCallResult struct

+ Error error

+ ID string

+ Input any

+ Name string

+ Result *ToolResult

+ type ToolResult struct

+ Content []*ToolResultContent

+ IsError bool

+ func NewToolResult(content ...*ToolResultContent) *ToolResult

+ func NewToolResultError(text string) *ToolResult

+ func NewToolResultText(text string) *ToolResult

+ type ToolResultContent struct

+ Annotations map[string]any

+ Data string

+ MimeType string

+ Text string

+ Type ToolResultContentType

+ type ToolResultContentType string

+ const ToolResultContentTypeAudio

+ const ToolResultContentTypeImage

+ const ToolResultContentTypeText

+ func (t ToolResultContentType) String() string

+ type TypedTool interface

+ Annotations func() ToolAnnotations

+ Call func(ctx context.Context, input T) (*ToolResult, error)

+ Description func() string

+ Name func() string

+ Schema func() schema.Schema

+ type TypedToolAdapter struct

+ func ToolAdapter[T any](tool TypedTool[T]) *TypedToolAdapter[T]

+ func (t *TypedToolAdapter[T]) Annotations() ToolAnnotations

+ func (t *TypedToolAdapter[T]) Call(ctx context.Context, input any) (*ToolResult, error)

+ func (t *TypedToolAdapter[T]) Description() string

+ func (t *TypedToolAdapter[T]) Name() string

+ func (t *TypedToolAdapter[T]) Schema() schema.Schema

+ func (t *TypedToolAdapter[T]) Unwrap() TypedTool[T]

v0.0.3

Mar 26, 2025

Changes in this version

+ var ErrThreadNotFound = fmt.Errorf("thread not found")

+ type Chunk struct

+ Content string

+ Document Document

+ DocumentID string

+ Heading string

+ Index int

+ type Document interface

+ Chunks func() []*Chunk

+ Content func() string

+ ContentType func() string

+ Description func() string

+ ID func() string

+ Name func() string

+ Path func() string

+ SetContent func(content string) error

+ Version func() int

+ type DocumentMetadata struct

+ ContentType string

+ Description string

+ Name string

+ Path string

+ Version int

+ type DocumentRef struct

+ Glob string

+ Name string

+ Tags []string

+ type DocumentRepository interface

+ DeleteDocument func(ctx context.Context, doc Document) error

+ Exists func(ctx context.Context, name string) (bool, error)

+ GetDocument func(ctx context.Context, name string) (Document, error)

+ ListDocuments func(ctx context.Context, input *ListDocumentInput) (*ListDocumentOutput, error)

+ PutDocument func(ctx context.Context, doc Document) error

+ RegisterDocument func(ctx context.Context, name, path string) error

type Environment

+ ThreadRepository func() ThreadRepository

+ type FileDocumentRepository struct

+ func NewFileDocumentRepository(rootDir string) (*FileDocumentRepository, error)

+ func (r *FileDocumentRepository) DeleteDocument(ctx context.Context, doc Document) error

+ func (r *FileDocumentRepository) Exists(ctx context.Context, name string) (bool, error)

+ func (r *FileDocumentRepository) GetDocument(ctx context.Context, name string) (Document, error)

+ func (r *FileDocumentRepository) ListDocuments(ctx context.Context, input *ListDocumentInput) (*ListDocumentOutput, error)

+ func (r *FileDocumentRepository) PutDocument(ctx context.Context, doc Document) error

+ func (r *FileDocumentRepository) RegisterDocument(ctx context.Context, name, path string) error

+ type ListDocumentInput struct

+ PathPrefix string

+ Recursive bool

+ type ListDocumentOutput struct

+ Items []Document

+ type MemoryDocumentRepository struct

+ func NewMemoryDocumentRepository() *MemoryDocumentRepository

+ func (r *MemoryDocumentRepository) DeleteDocument(ctx context.Context, doc Document) error

+ func (r *MemoryDocumentRepository) Exists(ctx context.Context, name string) (bool, error)

+ func (r *MemoryDocumentRepository) GetDocument(ctx context.Context, name string) (Document, error)

+ func (r *MemoryDocumentRepository) ListDocuments(ctx context.Context, input *ListDocumentInput) (*ListDocumentOutput, error)

+ func (r *MemoryDocumentRepository) PutDocument(ctx context.Context, doc Document) error

+ func (r *MemoryDocumentRepository) RegisterDocument(ctx context.Context, name, path string) error

+ type MemoryThreadRepository struct

+ func NewMemoryThreadRepository() *MemoryThreadRepository

+ func (r *MemoryThreadRepository) DeleteThread(ctx context.Context, id string) error

+ func (r *MemoryThreadRepository) GetThread(ctx context.Context, id string) (*Thread, error)

+ func (r *MemoryThreadRepository) PutThread(ctx context.Context, thread *Thread) error

+ func (r *MemoryThreadRepository) WithThreads(threads []*Thread) *MemoryThreadRepository

type OutputFormat

+ const OutputFormatJSON

+ const OutputFormatMarkdown

+ const OutputFormatText

+ type TextDocument struct

+ func NewTextDocument(opts TextDocumentOptions) *TextDocument

+ func (d *TextDocument) Chunks() []*Chunk

+ func (d *TextDocument) Content() string

+ func (d *TextDocument) ContentType() string

+ func (d *TextDocument) Description() string

+ func (d *TextDocument) ID() string

+ func (d *TextDocument) IncrementVersion()

+ func (d *TextDocument) Name() string

+ func (d *TextDocument) Path() string

+ func (d *TextDocument) SetContent(content string) error

+ func (d *TextDocument) SetName(name string)

+ func (d *TextDocument) SetPath(path string)

+ func (d *TextDocument) Version() int

+ type TextDocumentOptions struct

+ Content string

+ ContentType string

+ Description string

+ ID string

+ Name string

+ Path string

+ Version int

+ type Thread struct

+ CreatedAt time.Time

+ ID string

+ Messages []*llm.Message

+ UpdatedAt time.Time

+ UserID string

+ type ThreadRepository interface

+ DeleteThread func(ctx context.Context, id string) error

+ GetThread func(ctx context.Context, id string) (*Thread, error)

+ PutThread func(ctx context.Context, thread *Thread) error

v0.0.2

Mar 26, 2025

Changes in this version

+ func AgentNames(agents []Agent) []string

+ func DateString(t time.Time) string

+ func FormatMessages(messages []*llm.Message) string

+ func RandomName() string

+ func TruncateText(text string, maxWords int) string

+ func WaitForEvent[T any](ctx context.Context, stream Stream) (T, error)

+ type Agent interface

+ Generate func(ctx context.Context, message *llm.Message, opts ...GenerateOption) (*llm.Response, error)

+ Goal func() string

+ IsSupervisor func() bool

+ Name func() string

+ SetEnvironment func(env Environment)

+ Stream func(ctx context.Context, message *llm.Message, opts ...GenerateOption) (Stream, error)

+ Work func(ctx context.Context, task Task) (Stream, error)

+ type DiskOutputPlugin struct

+ func NewDiskOutputPlugin(dir string) (*DiskOutputPlugin, error)

+ func (p *DiskOutputPlugin) Name() string

+ func (p *DiskOutputPlugin) OutputExists(ctx context.Context, name, fingerprint string) (bool, error)

+ func (p *DiskOutputPlugin) ReadOutput(ctx context.Context, name, fingerprint string) (string, error)

+ func (p *DiskOutputPlugin) WriteOutput(ctx context.Context, name, fingerprint string, output string) error

+ type Environment interface

+ Agents func() []Agent

+ DocumentRepository func() document.Repository

+ GetAgent func(name string) (Agent, error)

+ Name func() string

+ RegisterAgent func(agent Agent) error

+ type Event struct

+ Error error

+ Origin EventOrigin

+ Payload any

+ Type string

+ type EventHandlerAgent interface

+ AcceptedEvents func() []string

+ HandleEvent func(ctx context.Context, event *Event) error

+ type EventOrigin struct

+ AgentID string

+ AgentName string

+ EnvironmentID string

+ EnvironmentName string

+ TaskID string

+ TaskName string

+ WorkflowID string

+ WorkflowName string

+ type GenerateOption func(*GenerateOptions)

+ func WithThreadID(threadID string) GenerateOption

+ func WithUserID(userID string) GenerateOption

+ type GenerateOptions struct

+ ThreadID string

+ UserID string

+ func (o *GenerateOptions) Apply(opts []GenerateOption)

+ type InMemoryOutputPlugin struct

+ func NewInMemoryOutputPlugin() *InMemoryOutputPlugin

+ func (p *InMemoryOutputPlugin) Name() string

+ func (p *InMemoryOutputPlugin) OutputExists(ctx context.Context, name, fingerprint string) (bool, error)

+ func (p *InMemoryOutputPlugin) ReadOutput(ctx context.Context, name, fingerprint string) (string, error)

+ func (p *InMemoryOutputPlugin) WriteOutput(ctx context.Context, name, fingerprint string, output string) error

+ type Input struct

+ Default interface{}

+ Description string

+ Name string

+ Required bool

+ Type string

+ type Output struct

+ Default interface{}

+ Description string

+ Document string

+ Format string

+ Name string

+ Type string

+ type OutputFormat string

+ const OutputJSON

+ const OutputMarkdown

+ const OutputText

+ type OutputPlugin interface

+ Name func() string

+ OutputExists func(ctx context.Context, name, fingerprint string) (bool, error)

+ ReadOutput func(ctx context.Context, name, fingerprint string) (string, error)

+ WriteOutput func(ctx context.Context, name, fingerprint string, output string) error

+ type Prompt struct

+ Context []*PromptContext

+ Name string

+ Output string

+ OutputFormat string

+ Text string

+ type PromptContext struct

+ Description string

+ Name string

+ Text string

+ type Publisher interface

+ Close func()

+ Send func(ctx context.Context, event *Event) error

+ type RunnableAgent interface

+ IsRunning func() bool

+ Start func(ctx context.Context) error

+ Stop func(ctx context.Context) error

+ type Stream interface

+ Close func() error

+ Err func() error

+ Event func() *Event

+ Next func(ctx context.Context) bool

+ Publisher func() Publisher

+ func NewStream() Stream

+ type Task interface

+ Name func() string

+ Prompt func() (*Prompt, error)

+ Timeout func() time.Duration

+ type TaskResult struct

+ Content string

+ Error error

+ Format OutputFormat

+ Object interface{}

+ Task Task

+ Usage llm.Usage

+ type TaskStatus string

+ const TaskStatusActive

+ const TaskStatusBlocked

+ const TaskStatusCompleted

+ const TaskStatusError

+ const TaskStatusInvalid

+ const TaskStatusPaused

+ const TaskStatusQueued

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