Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

stream

package

Go to main page

Versions in this module

v0

v0.1.2

May 6, 2026

Changes in this version

type EventType

+ const EventSource

type Input

+ RefineToolInput func(toolName string, input json.RawMessage) (json.RawMessage, error)

type Result

+ Sources func() []SourceEvent

+ type SourceEvent struct

+ Filename string

+ ID string

+ MediaType string

+ ProviderMetadata map[string]any

+ SourceType SourceType

+ Title string

+ URL string

+ type SourceType string

+ const SourceTypeDocument

+ const SourceTypeURL

v0.1.1

Apr 29, 2026

Changes in this version

+ func IntPtr(v int) *int

+ type Attachment struct

+ Data string

+ Filename string

+ MimeType string

+ type CallOptions struct

+ AbortSignal context.Context

+ FrequencyPenalty *float64

+ Headers map[string]string

+ IncludeRawChunks bool

+ MaxOutputTokens *int

+ Messages []message.Message

+ PresencePenalty *float64

+ ProviderOptions map[string]any

+ Reasoning ReasoningEffort

+ ResponseFormat *ResponseFormat

+ Seed *int

+ StopSequences []string

+ Temperature *float64

+ ToolChoice any

+ Tools []tool.Tool

+ TopK *int

+ TopP *float64

+ type ErrorEvent struct

+ Error error

+ type Event struct

+ Data EventData

+ Type EventType

+ type EventData interface

+ type EventType string

+ const EventError

+ const EventFinish

+ const EventFinishStep

+ const EventRawChunk

+ const EventReasoningDelta

+ const EventReasoningEnd

+ const EventReasoningStart

+ const EventStart

+ const EventStartStep

+ const EventTextDelta

+ const EventTextEnd

+ const EventTextStart

+ const EventToolCall

+ const EventToolError

+ const EventToolInputDelta

+ const EventToolInputEnd

+ const EventToolInputStart

+ const EventToolResult

+ type FailedToolCall struct

+ Error error

+ Input json.RawMessage

+ ToolCallID string

+ ToolName string

+ type FinishEvent struct

+ FinishReason FinishReason

+ ProviderMetadata map[string]any

+ Usage Usage

+ type FinishReason string

+ const FinishReasonContentFilter

+ const FinishReasonError

+ const FinishReasonLength

+ const FinishReasonOther

+ const FinishReasonStop

+ const FinishReasonToolCalls

+ type FinishStepEvent struct

+ FinishReason FinishReason

+ ProviderMetadata map[string]any

+ Usage Usage

+ type Input struct

+ AbortSignal context.Context

+ ActiveTools []string

+ Executor tool.Executor

+ Headers map[string]string

+ IncludeRawChunks bool

+ MaxOutputTokens *int

+ MaxRetries int

+ MaxSteps int

+ Messages []message.Message

+ Model Model

+ OnError func(error)

+ OnFinish func(result OnFinishData)

+ OnStepFinish func(step StepResultData)

+ Output Output

+ ProviderOptions map[string]any

+ Reasoning ReasoningEffort

+ RepairToolCall func(failed FailedToolCall) (*RepairedToolCall, error)

+ StopSequences []string

+ Temperature *float64

+ ToolChoice any

+ Tools tool.Set

+ TopK *int

+ TopP *float64

+ type InputTokens struct

+ CacheRead *int

+ CacheWrite *int

+ NoCache *int

+ Total *int

+ type Model interface

+ ID func() string

+ Provider func() string

+ Stream func(ctx context.Context, options *CallOptions) (<-chan Event, error)

+ type OnFinishData struct

+ FinalStep StepResultData

+ Steps []StepResultData

+ TotalUsage Usage

+ type Output interface

+ Name func() string

+ ParseComplete func(text string, ctx OutputParseContext) (any, error)

+ ParsePartial func(text string) any

+ ResponseFormat func() *ResponseFormat

+ type OutputParseContext struct

+ FinishReason FinishReason

+ Usage Usage

+ type OutputTokens struct

+ Reasoning *int

+ Text *int

+ Total *int

+ type RawChunkEvent struct

+ RawValue any

+ type ReasoningDeltaEvent struct

+ ID string

+ ProviderMetadata map[string]any

+ Text string

+ type ReasoningEffort = string

+ const ReasoningEffortHigh

+ const ReasoningEffortLow

+ const ReasoningEffortMedium

+ const ReasoningEffortMinimal

+ const ReasoningEffortNone

+ const ReasoningEffortXHigh

+ type ReasoningEndEvent struct

+ ID string

+ ProviderMetadata map[string]any

+ type ReasoningStartEvent struct

+ ID string

+ ProviderMetadata map[string]any

+ type RepairedToolCall struct

+ Input json.RawMessage

+ ToolName string

+ type ResponseFormat struct

+ Description string

+ Name string

+ Schema json.RawMessage

+ Type string

+ type Result struct

+ FinishReason func() FinishReason

+ FullStream <-chan Event

+ Output func() any

+ Text func() string

+ ToolCalls func() []ToolCall

+ ToolResults func() []ToolResultEvent

+ Usage func() Usage

+ type StartEvent struct

+ Warnings []Warning

+ type StartStepEvent struct

+ type StepResultData interface

+ GetFinishReason func() FinishReason

+ GetUsage func() Usage

+ Text func() string

+ ToolCalls func() []ToolCall

+ ToolResults func() []ToolResultEvent

+ type TextDeltaEvent struct

+ ProviderMetadata map[string]any

+ Text string

+ type TextEndEvent struct

+ ProviderMetadata map[string]any

+ type TextStartEvent struct

+ ProviderMetadata map[string]any

+ type ToolCall struct

+ ID string

+ Input json.RawMessage

+ Name string

+ type ToolCallEvent struct

+ Input json.RawMessage

+ ProviderMetadata map[string]any

+ ToolCallID string

+ ToolName string

+ type ToolErrorEvent struct

+ Error error

+ Input json.RawMessage

+ ToolCallID string

+ ToolName string

+ type ToolInputDeltaEvent struct

+ Delta string

+ ID string

+ type ToolInputEndEvent struct

+ ID string

+ type ToolInputStartEvent struct

+ ID string

+ ToolName string

+ type ToolOutput struct

+ Attachments []Attachment

+ Metadata map[string]any

+ Output string

+ Title string

+ type ToolResultEvent struct

+ Input json.RawMessage

+ Output ToolOutput

+ ToolCallID string

+ ToolName string

+ type Usage struct

+ InputTokens InputTokens

+ OutputTokens OutputTokens

+ Raw map[string]any

+ func UsageFrom(prompt, completion int) Usage

+ func (u *Usage) Add(other Usage)

+ func (u Usage) GrandTotal() int

+ func (u Usage) InputTotal() int

+ func (u Usage) OutputTotal() int

+ type Warning struct

+ Details string

+ Feature string

+ Message string

+ Type WarningType

+ func CompatibilityWarning(feature, details string) Warning

+ func OtherWarning(message string) Warning

+ func UnsupportedWarning(feature, details string) Warning

+ type WarningType string

+ const WarningCompatibility

+ const WarningOther

+ const WarningUnsupported

v0.1.0

Apr 24, 2026