All Implemented Interfaces:


public final class BetaResponseRefusalDeltaEvent

Emitted when there is a partial refusal text.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`BetaResponseRefusalDeltaEvent.Builder`	A builder for BetaResponseRefusalDeltaEvent.
`public final class`	`BetaResponseRefusalDeltaEvent.Agent`	The agent that owns this multi-agent streaming event.

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

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 Long`	`sequenceNumber()`	The sequence number of this event.
`final JsonValue`	`_type()`	The type of the event.
`final Optional<BetaResponseRefusalDeltaEvent.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>`	`_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 JsonField<Long>`	`_sequenceNumber()`	Returns the raw JSON value of sequenceNumber.
`final JsonField<BetaResponseRefusalDeltaEvent.Agent>`	`_agent()`	Returns the raw JSON value of agent.
`final Map<String, JsonValue>`	`_additionalProperties()`
`final BetaResponseRefusalDeltaEvent.Builder`	`toBuilder()`
`final BetaResponseRefusalDeltaEvent`	`validate()`	Validates that the types of all values in this object match their expected types recursively.
`final Boolean`	`isValid()`
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`
`String`	`toString()`
`final static BetaResponseRefusalDeltaEvent.Builder`	`builder()`	Returns a mutable builder for constructing an instance of BetaResponseRefusalDeltaEvent.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
- Method Detail
  - contentIndex
```
 final Long contentIndex()
```
    The index of the content part that the refusal text is added to.
  - delta
```
 final String delta()
```
    The refusal text that is added.
  - itemId
```
 final String itemId()
```
    The ID of the output item that the refusal text is added to.
  - outputIndex
```
 final Long outputIndex()
```
    The index of the output item that the refusal text is added to.
  - sequenceNumber
```
 final Long sequenceNumber()
```
    The sequence number of this event.
  - _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).
  - agent
```
 final Optional<BetaResponseRefusalDeltaEvent.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.
  - _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.
  - _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<BetaResponseRefusalDeltaEvent.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 BetaResponseRefusalDeltaEvent.Builder toBuilder()
```
  - validate
```
 final BetaResponseRefusalDeltaEvent 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.
  - isValid
```
 final Boolean isValid()
```
  - equals
```
 Boolean equals(Object other)
```
  - hashCode
```
 Integer hashCode()
```
  - toString
```
 String toString()
```
  - builder
```
 final static BetaResponseRefusalDeltaEvent.Builder builder()
```
    Returns a mutable builder for constructing an instance of BetaResponseRefusalDeltaEvent.
    The following fields are required:
    .contentIndex() .delta() .itemId() .outputIndex() .sequenceNumber()

Class BetaResponseRefusalDeltaEvent

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

contentIndex

delta

itemId

outputIndex

sequenceNumber

_type

agent

_contentIndex

_delta

_itemId

_outputIndex

_sequenceNumber

_agent

_additionalProperties

toBuilder

validate

isValid

equals

hashCode

toString

builder