chat

Documentation

Index

• func StepPrinterFunc(name string, w io.Writer) func(msg *message.Message) error
• func ToTypedEvent[T any](e Event) (*T, bool)
• type AddToHistoryStep
  • func (a *AddToHistoryStep) AddPublishedTopic(publisher message.Publisher, topic string) error
  • func (a *AddToHistoryStep) Start(ctx context.Context, input string) (steps.StepResult[string], error)
• type EchoStep
  • func NewEchoStep() *EchoStep
  • func (e *EchoStep) AddPublishedTopic(publisher message.Publisher, topic string) error
  • func (e *EchoStep) Interrupt()
  • func (e *EchoStep) Start(ctx context.Context, input conversation.Conversation) (steps.StepResult[string], error)
• type Event
  • func NewEventFromJson(b []byte) (Event, error)
  • func (e Event) ToPartialCompletion() (EventPartialCompletion, bool)
  • func (e Event) ToText() (EventText, bool)
• type EventMetadata
• type EventPartialCompletion
• type EventText
• type EventType
• type RunnableStep
  • func (r *RunnableStep) AddPublishedTopic(publisher message.Publisher, topic string) error
  • func (r *RunnableStep) Start(ctx context.Context, input interface{}) (steps.StepResult[string], error)
• type Step
• type StepOption
  • func WithSubscription(publisher message.Publisher, topic string) StepOption
• type ToolCall

Functions

func StepPrinterFunc

func StepPrinterFunc(name string, w io.Writer) func(msg *message.Message) error

func ToTypedEvent

func ToTypedEvent[T any](e Event) (*T, bool)

Types

type AddToHistoryStep

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

func (*AddToHistoryStep) AddPublishedTopic

func (a *AddToHistoryStep) AddPublishedTopic(publisher message.Publisher, topic string) error

func (*AddToHistoryStep) Start

func (a *AddToHistoryStep) Start(ctx context.Context, input string) (steps.StepResult[string], error)

type EchoStep

type EchoStep struct {
	TimePerCharacter time.Duration
	// contains filtered or unexported fields
}

func NewEchoStep

func NewEchoStep() *EchoStep

func (*EchoStep) AddPublishedTopic

func (e *EchoStep) AddPublishedTopic(publisher message.Publisher, topic string) error

func (*EchoStep) Interrupt

func (e *EchoStep) Interrupt()

func (*EchoStep) Start

func (e *EchoStep) Start(ctx context.Context, input conversation.Conversation) (steps.StepResult[string], error)

type Event

type Event struct {
	Type     EventType           `json:"type"`
	Error    error               `json:"error,omitempty"`
	Metadata EventMetadata       `json:"meta,omitempty"`
	Step     *steps.StepMetadata `json:"step,omitempty"`
	// contains filtered or unexported fields
}

func NewEventFromJson

func NewEventFromJson(b []byte) (Event, error)

func (Event) ToPartialCompletion

func (e Event) ToPartialCompletion() (EventPartialCompletion, bool)

func (Event) ToText

func (e Event) ToText() (EventText, bool)

type EventMetadata

type EventMetadata struct {
	ID       conversation.NodeID `json:"message_id"`
	ParentID conversation.NodeID `json:"parent_id"`
}

EventMetadata contains all the information that is passed along with watermill message, specific to chat steps.

type EventPartialCompletion

type EventPartialCompletion struct {
	Event
	Delta      string `json:"delta"`
	Completion string `json:"completion"`
}

type EventText

type EventText struct {
	Event
	Text string `json:"text"`
}

type EventType

type EventType string

const (
	EventTypeStart     EventType = "start"
	EventTypeStatus    EventType = "status"
	EventTypePartial   EventType = "partial"
	EventTypeFinal     EventType = "final"
	EventTypeError     EventType = "error"
	EventTypeInterrupt EventType = "interrupt"
)

type RunnableStep

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

func (*RunnableStep) AddPublishedTopic

func (r *RunnableStep) AddPublishedTopic(publisher message.Publisher, topic string) error

func (*RunnableStep) Start

func (r *RunnableStep) Start(ctx context.Context, input interface{}) (steps.StepResult[string], error)

type Step

type Step steps.Step[conversation.Conversation, string]

type StepOption

type StepOption func(Step) error

func WithSubscription

func WithSubscription(publisher message.Publisher, topic string) StepOption

type ToolCall

type ToolCall struct {
	Name      string `json:"name"`
	Arguments string `json:"arguments"`
}