Class StreamOptions

Inheritance

object

StreamOptions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Glitch9.AIDevKit

Assembly: Glitch9.AIDevKit.dll

Syntax

public sealed class StreamOptions

Properties

IncludeObfuscation

Optional. When true, stream obfuscation will be enabled. Stream obfuscation adds random characters to an obfuscation field on streaming delta events to normalize payload sizes as a mitigation to certain side-channel attacks. These obfuscation fields are included by default, but add a small amount of overhead to the data stream. You can set include_obfuscation to false to optimize for bandwidth if you trust the network links between your application and the OpenAI API.

Declaration

[JsonProperty("include_obfuscation")]
public bool? IncludeObfuscation { get; set; }

Property Value

Type	Description
bool?

IncludeUsage

If set, an additional chunk will be streamed before the data: [DONE] message. The usage field on this chunk shows the token usage statistics for the entire request,

and the choices field will always be an empty array. All other chunks will also include a usage field, but with a null value.

Declaration

[JsonProperty("include_usage")]
public bool IncludeUsage { get; set; }

Property Value

Type	Description
bool

Extension Methods

ArrayExtensions.ToArrayOrEmpty<T>(T)

ArrayExtensions.ToArrayOrNull<T>(T)

EventExtensions.ToDelta<T>(T, string, int, string, bool)

EventExtensions.ToDone<T>(T, string, int, string)

EventExtensions.ToEvent<T>(T)

EventExtensions.UpcastDelta<T1, T2>(T1, string, int, string, bool)

FallbackExtensions.IsOr<TParent, TChild>(TParent, TChild)

ResponseCastingExtensions.GetResult<T>(T)

SystemExtensions.GetName(object)