Class StreamOptions

Namespace

Mythosia.AI.Models.Streaming

Assembly

Mythosia.AI.Abstractions.dll

Options for controlling streaming behavior

public class StreamOptions

Inheritance

object

StreamOptions

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

StreamOptions()

public StreamOptions()

Properties

Default

Creates default options

public static StreamOptions Default { get; }

Property Value

StreamOptions

FullOptions

Default options for full featured streaming

public static StreamOptions FullOptions { get; }

Property Value

StreamOptions

IncludeFunctionCalls

Include function calling support (default: true)

public bool IncludeFunctionCalls { get; set; }

Property Value

bool

IncludeMetadata

Include metadata in streaming content (default: true when using StreamingContent)

public bool IncludeMetadata { get; set; }

Property Value

bool

IncludeReasoning

Include reasoning/thinking content from reasoning models like GPT-5, o3 (default: false)

public bool IncludeReasoning { get; set; }

Property Value

bool

Minimal

Creates options for minimal overhead streaming

public static StreamOptions Minimal { get; }

Property Value

StreamOptions

TextOnly

Filter out everything except text content (default: false)

public bool TextOnly { get; set; }

Property Value

bool

TextOnlyOptions

Default options for simple text streaming

public static StreamOptions TextOnlyOptions { get; }

Property Value

StreamOptions

WithFunctions

Creates options for function calling scenarios

public static StreamOptions WithFunctions { get; }

Property Value

StreamOptions

Methods

AsTextOnly(bool)

Builder pattern for fluent configuration

public StreamOptions AsTextOnly(bool textOnly = true)

Parameters

textOnly bool

Returns

StreamOptions

Clone()

Creates a copy of these options

public StreamOptions Clone()

Returns

StreamOptions

WithFunctionCalls(bool)

Builder pattern for fluent configuration

public StreamOptions WithFunctionCalls(bool include = true)

Parameters

include bool

Returns

StreamOptions

WithMetadata(bool)

Builder pattern for fluent configuration

public StreamOptions WithMetadata(bool include = true)

Parameters

include bool

Returns

StreamOptions

WithReasoning(bool)

Builder pattern for fluent configuration

public StreamOptions WithReasoning(bool include = true)

Parameters

include bool

Returns

StreamOptions