All Implemented Interfaces:


public final class BetaResponseTextDoneEvent

Emitted when text content is finalized.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`BetaResponseTextDoneEvent.Builder`	A builder for BetaResponseTextDoneEvent.
`public final class`	`BetaResponseTextDoneEvent.Logprob`	A logprob is the logarithmic probability that the model assigns to producing a particular token at a given position in the sequence. Less-negative (higher) logprob values indicate greater model confidence in that token choice.
`public final class`	`BetaResponseTextDoneEvent.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 text content is finalized.
`final String`	`itemId()`	The ID of the output item that the text content is finalized.
`final List<BetaResponseTextDoneEvent.Logprob>`	`logprobs()`	The log probabilities of the tokens in the delta.
`final Long`	`outputIndex()`	The index of the output item that the text content is finalized.
`final Long`	`sequenceNumber()`	The sequence number for this event.
`final String`	`text()`	The text content that is finalized.
`final JsonValue`	`_type()`	The type of the event.
`final Optional<BetaResponseTextDoneEvent.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<List<BetaResponseTextDoneEvent.Logprob>>`	`_logprobs()`	Returns the raw JSON value of logprobs.
`final JsonField<Long>`	`_outputIndex()`	Returns the raw JSON value of outputIndex.
`final JsonField<Long>`	`_sequenceNumber()`	Returns the raw JSON value of sequenceNumber.
`final JsonField<String>`	`_text()`	Returns the raw JSON value of text.
`final JsonField<BetaResponseTextDoneEvent.Agent>`	`_agent()`	Returns the raw JSON value of agent.
`final Map<String, JsonValue>`	`_additionalProperties()`
`final BetaResponseTextDoneEvent.Builder`	`toBuilder()`
`final BetaResponseTextDoneEvent`	`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 BetaResponseTextDoneEvent.Builder`	`builder()`	Returns a mutable builder for constructing an instance of BetaResponseTextDoneEvent.

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 text content is finalized.
  - itemId
```
 final String itemId()
```
    The ID of the output item that the text content is finalized.
  - logprobs
```
 final List<BetaResponseTextDoneEvent.Logprob> logprobs()
```
    The log probabilities of the tokens in the delta.
  - outputIndex
```
 final Long outputIndex()
```
    The index of the output item that the text content is finalized.
  - sequenceNumber
```
 final Long sequenceNumber()
```
    The sequence number for this event.
  - text
```
 final String text()
```
    The text content that is finalized.
  - _type
```
 final JsonValue _type()
```
    The type of the event. Always response.output_text.done.
    Expected to always return the following:
    JsonValue.from("response.output_text.done")
    However, this method can be useful for debugging and logging (e.g. if the server responded with an unexpected value).
  - agent
```
 final Optional<BetaResponseTextDoneEvent.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.
  - _logprobs
```
 final JsonField<List<BetaResponseTextDoneEvent.Logprob>> _logprobs()
```
    Returns the raw JSON value of logprobs.
    Unlike logprobs, 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.
  - _text
```
 final JsonField<String> _text()
```
    Returns the raw JSON value of text.
    Unlike text, this method doesn't throw if the JSON field has an unexpected type.
  - _agent
```
 final JsonField<BetaResponseTextDoneEvent.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 BetaResponseTextDoneEvent.Builder toBuilder()
```
  - validate
```
 final BetaResponseTextDoneEvent 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 BetaResponseTextDoneEvent.Builder builder()
```
    Returns a mutable builder for constructing an instance of BetaResponseTextDoneEvent.
    The following fields are required:
    .contentIndex() .itemId() .logprobs() .outputIndex() .sequenceNumber() .text()

Class BetaResponseTextDoneEvent

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

contentIndex

itemId

logprobs

outputIndex

sequenceNumber

text

_type

agent

_contentIndex

_itemId

_logprobs

_outputIndex

_sequenceNumber

_text

_agent

_additionalProperties

toBuilder

validate

isValid

equals

hashCode

toString

builder