RaiSseTextSelector Class

  • java.lang.Object
    • com.azure.ai.agents.models.RaiSseTextSelector

Implements

public final class RaiSseTextSelector
implements JsonSerializable<RaiSseTextSelector>

An SSE event-type to text-field selector for streaming invocation output.

Constructor Summary

Constructor Description
RaiSseTextSelector(String eventType)

Creates an instance of RaiSseTextSelector class.

Method Summary

Modifier and Type Method and Description
static RaiSseTextSelector fromJson(JsonReader jsonReader)

Reads an instance of RaiSseTextSelector from the JsonReader.

String getEventType()

Get the eventType property: The SSE event `type` value that carries text.

String getTextField()

Get the textField property: The field on a matched event holding the text delta.

RaiSseTextSelector setTextField(String textField)

Set the textField property: The field on a matched event holding the text delta.

JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

Constructor Details

RaiSseTextSelector

public RaiSseTextSelector(String eventType)

Creates an instance of RaiSseTextSelector class.

Parameters:

eventType - the eventType value to set.

Method Details

fromJson

public static RaiSseTextSelector fromJson(JsonReader jsonReader)

Reads an instance of RaiSseTextSelector from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of RaiSseTextSelector if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

- If the deserialized JSON object was missing any required properties.

getEventType

public String getEventType()

Get the eventType property: The SSE event `type` value that carries text.

Returns:

the eventType value.

getTextField

public String getTextField()

Get the textField property: The field on a matched event holding the text delta. When omitted, the service defaults to `delta`.

Returns:

the textField value.

setTextField

public RaiSseTextSelector setTextField(String textField)

Set the textField property: The field on a matched event holding the text delta. When omitted, the service defaults to `delta`.

Parameters:

textField - the textField value to set.

Returns:

the RaiSseTextSelector object itself.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to