Class ResponseRefusalDeltaEvent
-
- All Implemented Interfaces:
public final class ResponseRefusalDeltaEvent
Emitted when there is a partial refusal text.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final class
ResponseRefusalDeltaEvent.Builder
A builder for ResponseRefusalDeltaEvent.
-
Method Summary
Modifier and Type Method Description final Long
contentIndex()
The index of the content part that the refusal text is added to. final String
delta()
The refusal text that is added. final String
itemId()
The ID of the output item that the refusal text is added to. final Long
outputIndex()
The index of the output item that the refusal text is 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 ResponseRefusalDeltaEvent.Builder
toBuilder()
final ResponseRefusalDeltaEvent
validate()
final Boolean
isValid()
Boolean
equals(Object other)
Integer
hashCode()
String
toString()
final static ResponseRefusalDeltaEvent.Builder
builder()
Returns a mutable builder for constructing an instance of ResponseRefusalDeltaEvent. -
-
Method Detail
-
contentIndex
final Long contentIndex()
The index of the content part that the refusal text is added to.
-
outputIndex
final Long outputIndex()
The index of the output item that the refusal text is added to.
-
_type
final JsonValue _type()
The type of the event. Always
response.refusal.delta
.Expected to always return the following:
JsonValue.from("response.refusal.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 ResponseRefusalDeltaEvent.Builder toBuilder()
-
validate
final ResponseRefusalDeltaEvent validate()
-
builder
final static ResponseRefusalDeltaEvent.Builder builder()
Returns a mutable builder for constructing an instance of ResponseRefusalDeltaEvent.
The following fields are required:
.contentIndex() .delta() .itemId() .outputIndex()
-
-
-
-