StreamingChatCompletionsUpdate.Role Property

  • Reference

Definition

Namespace:
Azure.AI.Inference
Assembly:
Azure.AI.Inference.dll
Package:
Azure.AI.Inference v1.0.0-beta.2
Source:
StreamingChatCompletionsUpdate.cs

Gets the ChatRole associated with this update.

public Azure.AI.Inference.ChatRole? Role { get; }
member this.Role : Nullable<Azure.AI.Inference.ChatRole>
Public ReadOnly Property Role As Nullable(Of ChatRole)

Property Value

Nullable<ChatRole>

Remarks

Corresponds to e.g. $.choices[0].delta.role in the underlying REST schema.

ChatRole assignment typically occurs in a single update across a streamed Chat Completions choice and the value should be considered to be persist for all subsequent updates without a ChatRole that bear the same index.

Applies to