StreamingResponse<T> Class

Definition

Namespace:

Azure.AI.OpenAI

Assembly:

Azure.AI.OpenAI.dll

Package:

Azure.AI.OpenAI v1.0.0-beta.17

Source:

StreamingResponse.cs

Represents an operation response with streaming content that can be deserialized and enumerated while the response is still being received.

public class StreamingResponse<T> : IDisposable, System.Collections.Generic.IAsyncEnumerable<T>

type StreamingResponse<'T> = class
    interface IDisposable
    interface IAsyncEnumerable<'T>

Public Class StreamingResponse(Of T)
Implements IAsyncEnumerable(Of T), IDisposable

Type Parameters

T

The data type representative of distinct, streamable items.

Inheritance

Object

StreamingResponse<T>

Implements

IAsyncEnumerable<T> IDisposable

Methods

CreateFromResponse(Response, Func<Response,IAsyncEnumerable<T>>)	Creates a new instance of StreamingResponse<T> using the provided underlying HTTP response. The provided function will be used to resolve the response into an asynchronous enumeration of streamed response items.
Dispose()	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
Dispose(Boolean)
EnumerateValues()	Gets the asynchronously enumerable collection of distinct, streamable items in the response.
GetRawResponse()	Gets the underlying Response instance that this StreamingResponse<T> may enumerate over.

Explicit Interface Implementations

IAsyncEnumerable<T>.GetAsyncEnumerator(CancellationToken)

Returns an enumerator that iterates asynchronously through the collection.