ResponseStreamOptions Class

Definition

Namespace:
Azure.AI.AgentServer.Responses.Models
Assembly:
Azure.AI.AgentServer.Responses.dll
Package:
Azure.AI.AgentServer.Responses v1.0.0-beta.4
Source:
ResponseStreamOptions.cs

Options for streaming responses. Only set this when you set stream: true.

public class ResponseStreamOptions : System.ClientModel.Primitives.IJsonModel<Azure.AI.AgentServer.Responses.Models.ResponseStreamOptions>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.AgentServer.Responses.Models.ResponseStreamOptions>
type ResponseStreamOptions = class
    interface IJsonModel<ResponseStreamOptions>
    interface IPersistableModel<ResponseStreamOptions>
Public Class ResponseStreamOptions
Implements IJsonModel(Of ResponseStreamOptions), IPersistableModel(Of ResponseStreamOptions)
Inheritance
Object
ResponseStreamOptions
Implements
IJsonModel<ResponseStreamOptions> IPersistableModel<ResponseStreamOptions> IPersistableModel<T>

Constructors

Name Description
ResponseStreamOptions()

Initializes a new instance of ResponseStreamOptions.

Properties

Name Description
IncludeObfuscation

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.

Methods

Name Description
JsonModelCreateCore(Utf8JsonReader, ModelReaderWriterOptions)
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
PersistableModelCreateCore(BinaryData, ModelReaderWriterOptions)
PersistableModelWriteCore(ModelReaderWriterOptions)

Explicit Interface Implementations

Name Description
IJsonModel<ResponseStreamOptions>.Create(Utf8JsonReader, ModelReaderWriterOptions)
IJsonModel<ResponseStreamOptions>.Write(Utf8JsonWriter, ModelReaderWriterOptions)
IPersistableModel<ResponseStreamOptions>.Create(BinaryData, ModelReaderWriterOptions)
IPersistableModel<ResponseStreamOptions>.GetFormatFromOptions(ModelReaderWriterOptions)
IPersistableModel<ResponseStreamOptions>.Write(ModelReaderWriterOptions)

Applies to