Class ResponseTextDeltaEvent
-
- All Implemented Interfaces:
public final class ResponseTextDeltaEvent
Emitted when there is an additional text delta.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final class
ResponseTextDeltaEvent.Builder
A builder for ResponseTextDeltaEvent.
-
Method Summary
Modifier and Type Method Description final Long
contentIndex()
The index of the content part that the text delta was added to. final String
delta()
The text delta that was added. final String
itemId()
The ID of the output item that the text delta was added to. final Long
outputIndex()
The index of the output item that the text delta was added to. final JsonValue
_type()
The type of the event. final JsonField<Long>
_contentIndex()
Returns the raw JSON value of contentIndex. final JsonField<String>
_delta()
Returns the raw JSON value of delta. final JsonField<String>
_itemId()
Returns the raw JSON value of itemId. final JsonField<Long>
_outputIndex()
Returns the raw JSON value of outputIndex. final Map<String, JsonValue>
_additionalProperties()
final ResponseTextDeltaEvent.Builder
toBuilder()
final ResponseTextDeltaEvent
validate()
final Boolean
isValid()
Boolean
equals(Object other)
Integer
hashCode()
String
toString()
final static ResponseTextDeltaEvent.Builder
builder()
Returns a mutable builder for constructing an instance of ResponseTextDeltaEvent. -
-
Method Detail
-
contentIndex
final Long contentIndex()
The index of the content part that the text delta was added to.
-
outputIndex
final Long outputIndex()
The index of the output item that the text delta was added to.
-
_type
final JsonValue _type()
The type of the event. Always
response.output_text.delta
.Expected to always return the following:
JsonValue.from("response.output_text.delta")
However, this method can be useful for debugging and logging (e.g. if the server responded with an unexpected value).
-
_contentIndex
final JsonField<Long> _contentIndex()
Returns the raw JSON value of contentIndex.
Unlike contentIndex, this method doesn't throw if the JSON field has an unexpected type.
-
_delta
final JsonField<String> _delta()
Returns the raw JSON value of delta.
Unlike delta, this method doesn't throw if the JSON field has an unexpected type.
-
_itemId
final JsonField<String> _itemId()
Returns the raw JSON value of itemId.
Unlike itemId, this method doesn't throw if the JSON field has an unexpected type.
-
_outputIndex
final JsonField<Long> _outputIndex()
Returns the raw JSON value of outputIndex.
Unlike outputIndex, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final ResponseTextDeltaEvent.Builder toBuilder()
-
validate
final ResponseTextDeltaEvent validate()
-
builder
final static ResponseTextDeltaEvent.Builder builder()
Returns a mutable builder for constructing an instance of ResponseTextDeltaEvent.
The following fields are required:
.contentIndex() .delta() .itemId() .outputIndex()
-
-
-
-