chat

package

Go to main page

Versions in this module

v0

v0.21.0

Sep 12, 2026

Changes in this version

+ type ToolContent struct

+ Citations []Citation

+ Kind PartKind

+ Media *media.Media

+ Metadata metadata.Map

+ Text string

+ func (t *ToolContent) UnmarshalJSON(data []byte) error

+ func (t ToolContent) Clone() ToolContent

+ func (t ToolContent) MarshalJSON() ([]byte, error)

+ func (t ToolContent) Validate() error

v0.20.0

Sep 12, 2026

v0.19.0

Sep 11, 2026

v0.18.0

Sep 10, 2026

v0.17.0

Sep 10, 2026

v0.16.0

Sep 9, 2026

v0.15.0

Sep 7, 2026

v0.14.0

Sep 1, 2026

v0.13.0

Aug 31, 2026

Changes in this version

+ var ErrInvalidCitation = errors.New("chat: invalid citation")

+ var ErrInvalidToolChoice = errors.New("chat: invalid tool choice")

+ var ErrInvalidToolOutput = errors.New("chat: invalid tool output")

+ var ErrUnsupportedOutputFormat = errors.New("chat: unsupported output format")

+ type Citation struct

+ Quote string

+ Source CitationSource

+ Title string

+ func (c Citation) Clone() Citation

+ func (c Citation) Validate() error

+ type CitationSource struct

+ Kind CitationSourceKind

+ Value string

+ func (c CitationSource) Validate() error

+ type CitationSourceKind string

+ const CitationSourceReference

+ const CitationSourceURI

+ func (c CitationSourceKind) Valid() bool

type FinishReason

+ const FinishReasonRefusal

+ type JSONSchemaConfig struct

+ Description string

+ Name string

+ Schema json.RawMessage

type Options

+ MaxOutputTokens *int64

type Part

+ Citations []Citation

+ ReasoningState []byte

+ func NewRefusalPart(text string) Part

+ type PartDelta struct

+ Citation *Citation

+ Kind PartDeltaKind

+ Media *media.Media

+ Metadata metadata.Map

+ ReasoningState []byte

+ Text string

+ ToolCall *ToolCallDelta

+ func NewCitationDelta(citation Citation) PartDelta

+ func NewMediaDelta(value *media.Media) PartDelta

+ func NewReasoningDelta(text string, state []byte) PartDelta

+ func NewRefusalDelta(text string) PartDelta

+ func NewTextDelta(text string) PartDelta

+ func NewToolCallDelta(delta ToolCallDelta) PartDelta

+ func (p *PartDelta) UnmarshalJSON(data []byte) error

+ func (p PartDelta) Clone() PartDelta

+ func (p PartDelta) MarshalJSON() ([]byte, error)

+ func (p PartDelta) Validate() error

+ type PartDeltaKind string

+ const PartDeltaCitation

+ const PartDeltaMedia

+ const PartDeltaReasoning

+ const PartDeltaRefusal

+ const PartDeltaText

+ const PartDeltaToolCall

+ func (p PartDeltaKind) Valid() bool

type PartKind

+ const PartRefusal

type Request

+ ToolChoice *ToolChoice

type ResponseAccumulator

+ func (r *ResponseAccumulator) Text() string

+ type ResponseDelta struct

+ FinishReason FinishReason

+ MessageMetadata metadata.Map

+ Metadata *ResponseMetadata

+ OutputMetadata *OutputMetadata

+ Parts []PartDelta

+ func (r *ResponseDelta) Clone() *ResponseDelta

+ func (r *ResponseDelta) Text() string

+ func (r *ResponseDelta) UnmarshalJSON(data []byte) error

+ func (r *ResponseDelta) Validate() error

+ func (r ResponseDelta) MarshalJSON() ([]byte, error)

type ResponseMetadata

+ CreatedAt time.Time

+ type ToolChoice struct

+ Mode ToolChoiceMode

+ Name string

+ Parallelism ToolParallelism

+ func (t *ToolChoice) Clone() *ToolChoice

+ func (t ToolChoice) Validate() error

+ type ToolChoiceMode string

+ const ToolChoiceAuto

+ const ToolChoiceNamed

+ const ToolChoiceNone

+ const ToolChoiceRequired

+ func (t ToolChoiceMode) Valid() bool

type ToolOutput

+ func (t *ToolOutput) UnmarshalJSON(data []byte) error

+ func (t ToolOutput) MarshalJSON() ([]byte, error)

+ type ToolParallelism string

+ const ToolParallelismAllow

+ const ToolParallelismSingle

+ func (t ToolParallelism) Valid() bool

v0.12.0

Aug 30, 2026

v0.11.0

Aug 30, 2026

v0.10.0

Aug 30, 2026

v0.0.4

Aug 30, 2026

Changes in this version

+ var ErrInvalidMessage = errors.New("chat: invalid message")

+ var ErrInvalidOptions = errors.New("chat: invalid options")

+ var ErrInvalidOutputFormat = errors.New("chat: invalid output format")

+ var ErrInvalidPart = errors.New("chat: invalid part")

+ var ErrInvalidRequest = errors.New("chat: invalid request")

+ var ErrInvalidResponse = errors.New("chat: invalid response")

+ var ErrInvalidToolCall = errors.New("chat: invalid tool call")

+ var ErrInvalidToolDefinition = errors.New("chat: invalid tool definition")

+ var ErrInvalidToolResult = errors.New("chat: invalid tool result")

+ var ErrInvalidUsage = errors.New("chat: invalid usage")

+ type CallMiddleware func(next Model) Model

+ type FinishReason string

+ const FinishReasonContentFilter

+ const FinishReasonLength

+ const FinishReasonOther

+ const FinishReasonStop

+ const FinishReasonToolCalls

+ func (f FinishReason) String() string

+ func (f FinishReason) Valid() bool

+ type Message struct

+ Metadata metadata.Map

+ Parts []Part

+ Role Role

+ func NewAssistantMessage(parts ...Part) Message

+ func NewSystemMessage(text string) Message

+ func NewToolMessage(results ...ToolResult) Message

+ func NewUserMessage(parts ...Part) Message

+ func (m *Message) Text() string

+ func (m *Message) UnmarshalJSON(data []byte) error

+ func (m Message) Clone() Message

+ func (m Message) MarshalJSON() ([]byte, error)

+ func (m Message) Validate() error

+ type Model interface

+ Call func(ctx context.Context, request *Request) (*Response, error)

+ func Wrap(model Model, middlewares ...CallMiddleware) Model

+ type ModelFunc func(ctx context.Context, request *Request) (*Response, error)

+ func (m ModelFunc) Call(ctx context.Context, request *Request) (*Response, error)

+ type Options struct

+ Extensions metadata.Extensions

+ FrequencyPenalty *float64

+ MaxTokens *int64

+ Model string

+ OutputFormat *OutputFormat

+ PresencePenalty *float64

+ ReasoningEffort ReasoningEffort

+ Stop []string

+ Temperature *float64

+ TopK *int64

+ TopP *float64

+ func (o *Options) UnmarshalJSON(data []byte) error

+ func (o Options) Clone() Options

+ func (o Options) MarshalJSON() ([]byte, error)

+ func (o Options) Resolve(override Options) (Options, error)

+ func (o Options) Validate() error

+ type Output struct

+ FinishReason FinishReason

+ Message *Message

+ Metadata *OutputMetadata

+ func NewOutput(message *Message, finishReason FinishReason, metadata *OutputMetadata) (*Output, error)

+ func (o *Output) Text() string

+ func (o *Output) UnmarshalJSON(data []byte) error

+ func (o *Output) Validate() error

+ func (o Output) MarshalJSON() ([]byte, error)

+ type OutputFormat struct

+ Description string

+ Name string

+ Schema json.RawMessage

+ Type OutputFormatType

+ func NewJSONSchemaOutputFormat(name string, schema json.RawMessage) (OutputFormat, error)

+ func NewOutputFormat(formatType OutputFormatType) (OutputFormat, error)

+ func (o *OutputFormat) Clone() *OutputFormat

+ func (o *OutputFormat) FallbackInstruction() (string, error)

+ func (o *OutputFormat) SchemaAs[T any]() (T, error)

+ func (o *OutputFormat) UnmarshalJSON(data []byte) error

+ func (o OutputFormat) MarshalJSON() ([]byte, error)

+ func (o OutputFormat) Validate() error

+ type OutputFormatType string

+ const OutputFormatJSON

+ const OutputFormatJSONSchema

+ const OutputFormatText

+ type OutputMetadata struct

+ Extra metadata.Map

+ func (o *OutputMetadata) UnmarshalJSON(data []byte) error

+ func (o OutputMetadata) MarshalJSON() ([]byte, error)

+ type Part struct

+ Kind PartKind

+ Media *media.Media

+ Metadata metadata.Map

+ Signature []byte

+ Text string

+ ToolCall *ToolCall

+ ToolCallDelta *ToolCallDelta

+ ToolResult *ToolResult

+ func NewMediaPart(value *media.Media) Part

+ func NewReasoningPart(text string, signature []byte) Part

+ func NewTextPart(text string) Part

+ func NewToolCallDeltaPart(delta ToolCallDelta) Part

+ func NewToolCallPart(call ToolCall) Part

+ func NewToolResultPart(result ToolResult) Part

+ func (p *Part) UnmarshalJSON(data []byte) error

+ func (p Part) Clone() Part

+ func (p Part) MarshalJSON() ([]byte, error)

+ func (p Part) Validate() error

+ type PartKind string

+ const PartMedia

+ const PartReasoning

+ const PartText

+ const PartToolCall

+ const PartToolCallDelta

+ const PartToolResult

+ func (p PartKind) Valid() bool

+ type ReasoningEffort string

+ func (r ReasoningEffort) Validate() error

+ type Request struct

+ Messages []Message

+ Options Options

+ Tools []ToolDefinition

+ func NewRequest(messages ...Message) (*Request, error)

+ func (r *Request) Clone() *Request

+ func (r *Request) UnmarshalJSON(data []byte) error

+ func (r *Request) Validate() error

+ func (r Request) MarshalJSON() ([]byte, error)

+ type Response struct

+ Metadata *ResponseMetadata

+ Output *Output

+ func NewResponse(output *Output, metadata *ResponseMetadata) (*Response, error)

+ func (r *Response) Clone() *Response

+ func (r *Response) Text() string

+ func (r *Response) UnmarshalJSON(data []byte) error

+ func (r *Response) Validate() error

+ func (r Response) MarshalJSON() ([]byte, error)

+ type ResponseAccumulator struct

+ func (r *ResponseAccumulator) Add(chunk *Response) error

+ func (r *ResponseAccumulator) Response() *Response

+ type ResponseMetadata struct

+ Extra metadata.Map

+ ID string

+ Model string

+ Usage Usage

+ func (r *ResponseMetadata) UnmarshalJSON(data []byte) error

+ func (r ResponseMetadata) MarshalJSON() ([]byte, error)

+ type Role string

+ const RoleAssistant

+ const RoleSystem

+ const RoleTool

+ const RoleUser

+ func (r Role) Valid() bool

+ type StreamMiddleware func(next Streamer) Streamer

+ type Streamer interface

+ Stream func(ctx context.Context, request *Request) iter.Seq2[*Response, error]

+ func WrapStream(streamer Streamer, middlewares ...StreamMiddleware) Streamer

+ type StreamerFunc func(ctx context.Context, request *Request) iter.Seq2[*Response, error]

+ func (s StreamerFunc) Stream(ctx context.Context, request *Request) iter.Seq2[*Response, error]

+ type ToolCall struct

+ Arguments string

+ ID string

+ Name string

+ func (t ToolCall) Validate() error

+ type ToolCallDelta struct

+ Arguments string

+ ID string

+ Name string

+ func (t ToolCallDelta) Validate() error

+ type ToolDefinition struct

+ Description string

+ InputSchema json.RawMessage

+ Name string

+ func (t *ToolDefinition) UnmarshalJSON(data []byte) error

+ func (t ToolDefinition) Clone() ToolDefinition

+ func (t ToolDefinition) MarshalJSON() ([]byte, error)

+ func (t ToolDefinition) Validate() error

+ type ToolOutput struct

+ Content []Part

+ Details json.RawMessage

+ func NewJSONToolOutput(value json.RawMessage) (ToolOutput, error)

+ func NewTextToolOutput(text string) ToolOutput

+ func (o ToolOutput) Clone() ToolOutput

+ func (o ToolOutput) Text() (string, bool)

+ func (o ToolOutput) Validate() error

+ type ToolResult struct

+ ID string

+ IsError bool

+ Name string

+ Output ToolOutput

+ func (t ToolResult) Clone() ToolResult

+ func (t ToolResult) Validate() error

+ type Usage struct

+ CacheReadInputTokens *int64

+ CacheWriteInputTokens *int64

+ InputTokens int64

+ OutputTokens int64

+ ReasoningTokens *int64

+ func (u *Usage) UnmarshalJSON(data []byte) error

+ func (u Usage) MarshalJSON() ([]byte, error)

+ func (u Usage) TotalTokens() int64

+ func (u Usage) Validate() error

v0.0.3

Aug 28, 2026

v0.0.2

Aug 28, 2026

v0.0.1

Aug 27, 2026

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