ProjectResponsesClient.CreateResponseStreaming Method

Definition

Namespace:

Azure.AI.Extensions.OpenAI

Assembly:

Azure.AI.Extensions.OpenAI.dll

Package:

Azure.AI.Extensions.OpenAI v2.0.0

Overloads

Name	Description
CreateResponseStreaming(CreateResponseOptions, CancellationToken)	Creates a streaming response using the supplied response options.
CreateResponseStreaming(IEnumerable<ResponseItem>, String, CancellationToken)	Creates a streaming response from the supplied input items.
CreateResponseStreaming(String, String, CancellationToken)	Creates a streaming response from user input text.
CreateResponseStreaming(String, IEnumerable<ResponseItem>, String, CancellationToken)	Creates a streaming response for the specified model from the supplied input items.
CreateResponseStreaming(String, String, String, CancellationToken)	Creates a streaming response for the specified model from user input text.

CreateResponseStreaming(CreateResponseOptions, CancellationToken)

Source:

ProjectResponsesClient.cs

Creates a streaming response using the supplied response options.

public override System.ClientModel.CollectionResult<OpenAI.Responses.StreamingResponseUpdate> CreateResponseStreaming(OpenAI.Responses.CreateResponseOptions options, System.Threading.CancellationToken cancellationToken = default);

override this.CreateResponseStreaming : OpenAI.Responses.CreateResponseOptions * System.Threading.CancellationToken -> System.ClientModel.CollectionResult<OpenAI.Responses.StreamingResponseUpdate>

Public Overrides Function CreateResponseStreaming (options As CreateResponseOptions, Optional cancellationToken As CancellationToken = Nothing) As CollectionResult(Of StreamingResponseUpdate)

Parameters

options

OpenAI.Responses.CreateResponseOptions

The options used to create the streaming response.

cancellationToken

CancellationToken

The cancellation token that can be used to cancel the operation.

Returns

CollectionResult<OpenAI.Responses.StreamingResponseUpdate>

The streaming response updates.

CreateResponseStreaming(IEnumerable<ResponseItem>, String, CancellationToken)

Source:

ProjectResponsesClient.cs

Creates a streaming response from the supplied input items.

public virtual System.ClientModel.CollectionResult<OpenAI.Responses.StreamingResponseUpdate> CreateResponseStreaming(System.Collections.Generic.IEnumerable<OpenAI.Responses.ResponseItem> inputItems, string previousResponseId = default, System.Threading.CancellationToken cancellationToken = default);

override this.CreateResponseStreaming : seq<OpenAI.Responses.ResponseItem> * string * System.Threading.CancellationToken -> System.ClientModel.CollectionResult<OpenAI.Responses.StreamingResponseUpdate>

Public Overridable Function CreateResponseStreaming (inputItems As IEnumerable(Of ResponseItem), Optional previousResponseId As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As CollectionResult(Of StreamingResponseUpdate)

Parameters

inputItems

IEnumerable<OpenAI.Responses.ResponseItem>

The input items used to create the streaming response.

previousResponseId

String

The ID of the previous response to continue.

cancellationToken

CancellationToken

The cancellation token that can be used to cancel the operation.

Returns

CollectionResult<OpenAI.Responses.StreamingResponseUpdate>

The streaming response updates.

CreateResponseStreaming(String, String, CancellationToken)

Source:

ProjectResponsesClient.cs

Creates a streaming response from user input text.

public virtual System.ClientModel.CollectionResult<OpenAI.Responses.StreamingResponseUpdate> CreateResponseStreaming(string userInputText, string previousResponseId = default, System.Threading.CancellationToken cancellationToken = default);

override this.CreateResponseStreaming : string * string * System.Threading.CancellationToken -> System.ClientModel.CollectionResult<OpenAI.Responses.StreamingResponseUpdate>

Public Overridable Function CreateResponseStreaming (userInputText As String, Optional previousResponseId As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As CollectionResult(Of StreamingResponseUpdate)

Parameters

userInputText

String

The user input text used to create the streaming response.

previousResponseId

String

The ID of the previous response to continue.

cancellationToken

CancellationToken

The cancellation token that can be used to cancel the operation.

Returns

CollectionResult<OpenAI.Responses.StreamingResponseUpdate>

The streaming response updates.

CreateResponseStreaming(String, IEnumerable<ResponseItem>, String, CancellationToken)

Source:

ProjectResponsesClient.cs

Creates a streaming response for the specified model from the supplied input items.

public override System.ClientModel.CollectionResult<OpenAI.Responses.StreamingResponseUpdate> CreateResponseStreaming(string model, System.Collections.Generic.IEnumerable<OpenAI.Responses.ResponseItem> inputItems, string previousResponseId = default, System.Threading.CancellationToken cancellationToken = default);

override this.CreateResponseStreaming : string * seq<OpenAI.Responses.ResponseItem> * string * System.Threading.CancellationToken -> System.ClientModel.CollectionResult<OpenAI.Responses.StreamingResponseUpdate>

Public Overrides Function CreateResponseStreaming (model As String, inputItems As IEnumerable(Of ResponseItem), Optional previousResponseId As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As CollectionResult(Of StreamingResponseUpdate)

Parameters

model

String

The model used to create the streaming response.

inputItems

IEnumerable<OpenAI.Responses.ResponseItem>

The input items used to create the streaming response.

previousResponseId

String

The ID of the previous response to continue.

cancellationToken

CancellationToken

The cancellation token that can be used to cancel the operation.

Returns

CollectionResult<OpenAI.Responses.StreamingResponseUpdate>

The streaming response updates.

CreateResponseStreaming(String, String, String, CancellationToken)

Source:

ProjectResponsesClient.cs

Creates a streaming response for the specified model from user input text.

public override System.ClientModel.CollectionResult<OpenAI.Responses.StreamingResponseUpdate> CreateResponseStreaming(string model, string userInputText, string previousResponseId = default, System.Threading.CancellationToken cancellationToken = default);

override this.CreateResponseStreaming : string * string * string * System.Threading.CancellationToken -> System.ClientModel.CollectionResult<OpenAI.Responses.StreamingResponseUpdate>

Public Overrides Function CreateResponseStreaming (model As String, userInputText As String, Optional previousResponseId As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As CollectionResult(Of StreamingResponseUpdate)

Parameters

model

String

The model used to create the streaming response.

userInputText

String

The user input text used to create the streaming response.

previousResponseId

String

The ID of the previous response to continue.

cancellationToken

CancellationToken

The cancellation token that can be used to cancel the operation.

Returns

CollectionResult<OpenAI.Responses.StreamingResponseUpdate>

The streaming response updates.