claude

Documentation

Index

• Constants
• func IsClaudeEngine(engine string) bool
• type ChatStep
  • func NewChatStep(stepSettings *settings.StepSettings, tools []api.Tool, ...) (*ChatStep, error)
  • func (csf *ChatStep) AddPublishedTopic(publisher message.Publisher, topic string) error
  • func (csf *ChatStep) Start(ctx context.Context, messages conversation.Conversation) (steps.StepResult[string], error)
• type ChatStepOption
  • func WithChatStepMessageID(messageID conversation.NodeID) ChatStepOption
  • func WithChatStepParentID(parentID conversation.NodeID) ChatStepOption
  • func WithChatStepSubscriptionManager(subscriptionManager *events2.PublisherManager) ChatStepOption
• type ContentBlockMerger
  • func NewContentBlockMerger(metadata chat.EventMetadata, stepMetadata *steps.StepMetadata) *ContentBlockMerger
  • func (cbm *ContentBlockMerger) Add(event api.StreamingEvent) ([]chat.Event, error)
  • func (cbm *ContentBlockMerger) Error() *api.Error
  • func (cbm *ContentBlockMerger) Response() *api.MessageResponse
  • func (cbm *ContentBlockMerger) Text() string
• type MessagesStep
  • func NewStep(settings *settings.StepSettings) *MessagesStep
  • func (csf *MessagesStep) AddPublishedTopic(publisher message.Publisher, topic string) error
  • func (csf *MessagesStep) Interrupt()
  • func (csf *MessagesStep) Start(ctx context.Context, messages conversation.Conversation) (steps.StepResult[string], error)

Constants

const MessageIdMetadataSlug = "claude_message_id"

const ModelMetadataSlug = "claude_model"

const RoleMetadataSlug = "claude_role"

const StopReasonMetadataSlug = "claude_stop_reason"

const StopSequenceMetadataSlug = "claude_stop_sequence"

const UsageMetadataSlug = "claude_usage"

Functions

func IsClaudeEngine

func IsClaudeEngine(engine string) bool

Types

type ChatStep

type ChatStep struct {
	Settings *settings.StepSettings
	Tools    []api.Tool
	// contains filtered or unexported fields
}

func NewChatStep

func NewChatStep(
	stepSettings *settings.StepSettings,
	tools []api.Tool,
	options ...ChatStepOption,
) (*ChatStep, error)

func (*ChatStep) AddPublishedTopic

func (csf *ChatStep) AddPublishedTopic(publisher message.Publisher, topic string) error

func (*ChatStep) Start

func (csf *ChatStep) Start(
	ctx context.Context,
	messages conversation.Conversation,
) (steps.StepResult[string], error)

type ChatStepOption

type ChatStepOption func(*ChatStep) error

func WithChatStepMessageID

func WithChatStepMessageID(messageID conversation.NodeID) ChatStepOption

func WithChatStepParentID

func WithChatStepParentID(parentID conversation.NodeID) ChatStepOption

func WithChatStepSubscriptionManager

func WithChatStepSubscriptionManager(subscriptionManager *events2.PublisherManager) ChatStepOption

type ContentBlockMerger

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

ContentBlockMerger manages the streaming response from Claude AI API for chat completion. It processes various event types to reconstruct the full message response, handling multiple content blocks, metadata updates, and error conditions.

The merger accumulates content from text and tool use blocks, manages message metadata, and provides access to the reconstructed response and any errors encountered.

Usage:

1. Create a new merger with NewContentBlockMerger()
2. For each streaming event, call Add() to process and update the internal state
3. Use Text() to get the current accumulated response text
4. Access the full response with Response() or any errors with Error()

The merger handles parallel stream fragments, ensuring proper ordering and combination of content blocks in the final response.

func NewContentBlockMerger

func NewContentBlockMerger(metadata chat.EventMetadata, stepMetadata *steps.StepMetadata) *ContentBlockMerger

func (*ContentBlockMerger) Add

func (cbm *ContentBlockMerger) Add(event api.StreamingEvent) ([]chat.Event, error)

func (*ContentBlockMerger) Error

func (cbm *ContentBlockMerger) Error() *api.Error

func (*ContentBlockMerger) Response

func (cbm *ContentBlockMerger) Response() *api.MessageResponse

func (*ContentBlockMerger) Text

func (cbm *ContentBlockMerger) Text() string

Text returns the accumulated main response so far. In the claude case, this is the concatenated list of all the individual text blocks so far

type MessagesStep

type MessagesStep struct {
	Settings *settings.StepSettings
	// contains filtered or unexported fields
}

func NewStep

func NewStep(settings *settings.StepSettings) *MessagesStep

func (*MessagesStep) AddPublishedTopic

func (csf *MessagesStep) AddPublishedTopic(publisher message.Publisher, topic string) error

func (*MessagesStep) Interrupt

func (csf *MessagesStep) Interrupt()

func (*MessagesStep) Start

func (csf *MessagesStep) Start(
	ctx context.Context,
	messages conversation.Conversation,
) (steps.StepResult[string], error)