Class ResponseRefusalDoneEvent
-
- All Implemented Interfaces:
public final class ResponseRefusalDoneEvent
Emitted when refusal text is finalized.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final class
ResponseRefusalDoneEvent.Builder
A builder for ResponseRefusalDoneEvent.
-
Method Summary
Modifier and Type Method Description final Long
contentIndex()
The index of the content part that the refusal text is finalized. final String
itemId()
The ID of the output item that the refusal text is finalized. final Long
outputIndex()
The index of the output item that the refusal text is finalized. final String
refusal()
The refusal text that is finalized. final JsonValue
_type()
The type of the event. final JsonField<Long>
_contentIndex()
Returns the raw JSON value of contentIndex. final JsonField<String>
_itemId()
Returns the raw JSON value of itemId. final JsonField<Long>
_outputIndex()
Returns the raw JSON value of outputIndex. final JsonField<String>
_refusal()
Returns the raw JSON value of refusal. final Map<String, JsonValue>
_additionalProperties()
final ResponseRefusalDoneEvent.Builder
toBuilder()
final ResponseRefusalDoneEvent
validate()
final Boolean
isValid()
Boolean
equals(Object other)
Integer
hashCode()
String
toString()
final static ResponseRefusalDoneEvent.Builder
builder()
Returns a mutable builder for constructing an instance of ResponseRefusalDoneEvent. -
-
Method Detail
-
contentIndex
final Long contentIndex()
The index of the content part that the refusal text is finalized.
-
outputIndex
final Long outputIndex()
The index of the output item that the refusal text is finalized.
-
_type
final JsonValue _type()
The type of the event. Always
response.refusal.done
.Expected to always return the following:
JsonValue.from("response.refusal.done")
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.
-
_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.
-
_refusal
final JsonField<String> _refusal()
Returns the raw JSON value of refusal.
Unlike refusal, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final ResponseRefusalDoneEvent.Builder toBuilder()
-
validate
final ResponseRefusalDoneEvent validate()
-
builder
final static ResponseRefusalDoneEvent.Builder builder()
Returns a mutable builder for constructing an instance of ResponseRefusalDoneEvent.
The following fields are required:
.contentIndex() .itemId() .outputIndex() .refusal()
-
-
-
-