Class BetaResponseRefusalDoneEvent
-
- All Implemented Interfaces:
public final class BetaResponseRefusalDoneEventEmitted when refusal text is finalized.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classBetaResponseRefusalDoneEvent.BuilderA builder for BetaResponseRefusalDoneEvent.
public final classBetaResponseRefusalDoneEvent.AgentThe agent that owns this multi-agent streaming event.
-
Method Summary
Modifier and Type Method Description final LongcontentIndex()The index of the content part that the refusal text is finalized. final StringitemId()The ID of the output item that the refusal text is finalized. final LongoutputIndex()The index of the output item that the refusal text is finalized. final Stringrefusal()The refusal text that is finalized. final LongsequenceNumber()The sequence number of this event. final JsonValue_type()The type of the event. final Optional<BetaResponseRefusalDoneEvent.Agent>agent()The agent that owns this multi-agent streaming 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 JsonField<Long>_sequenceNumber()Returns the raw JSON value of sequenceNumber. final JsonField<BetaResponseRefusalDoneEvent.Agent>_agent()Returns the raw JSON value of agent. final Map<String, JsonValue>_additionalProperties()final BetaResponseRefusalDoneEvent.BuildertoBuilder()final BetaResponseRefusalDoneEventvalidate()Validates that the types of all values in this object match their expected types recursively. final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static BetaResponseRefusalDoneEvent.Builderbuilder()Returns a mutable builder for constructing an instance of BetaResponseRefusalDoneEvent. -
-
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.
-
sequenceNumber
final Long sequenceNumber()
The sequence number of this event.
-
_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).
-
agent
final Optional<BetaResponseRefusalDoneEvent.Agent> agent()
The agent that owns this multi-agent streaming event.
-
_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.
-
_sequenceNumber
final JsonField<Long> _sequenceNumber()
Returns the raw JSON value of sequenceNumber.
Unlike sequenceNumber, this method doesn't throw if the JSON field has an unexpected type.
-
_agent
final JsonField<BetaResponseRefusalDoneEvent.Agent> _agent()
Returns the raw JSON value of agent.
Unlike agent, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final BetaResponseRefusalDoneEvent.Builder toBuilder()
-
validate
final BetaResponseRefusalDoneEvent validate()
Validates that the types of all values in this object match their expected types recursively.
This method is not forwards compatible with new types from the API for existing fields.
-
builder
final static BetaResponseRefusalDoneEvent.Builder builder()
Returns a mutable builder for constructing an instance of BetaResponseRefusalDoneEvent.
The following fields are required:
.contentIndex() .itemId() .outputIndex() .refusal() .sequenceNumber()
-
-
-
-