Class ResponseTextDoneEvent
- 
                    
                    
- All Implemented Interfaces:
 
public final class ResponseTextDoneEventEmitted when text content is finalized.
 
- 
                
                    
                    
- 
                                
                            
                                
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classResponseTextDoneEvent.BuilderA builder for ResponseTextDoneEvent.
public final classResponseTextDoneEvent.LogprobA 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.
 
- 
                                
                            
                                
Method Summary
Modifier and Type Method Description final LongcontentIndex()The index of the content part that the text content is finalized. final StringitemId()The ID of the output item that the text content is finalized. final List<ResponseTextDoneEvent.Logprob>logprobs()The log probabilities of the tokens in the delta. final LongoutputIndex()The index of the output item that the text content is finalized. final LongsequenceNumber()The sequence number for this event. final Stringtext()The text content 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<List<ResponseTextDoneEvent.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 Map<String, JsonValue>_additionalProperties()final ResponseTextDoneEvent.BuildertoBuilder()final ResponseTextDoneEventvalidate()final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static ResponseTextDoneEvent.Builderbuilder()Returns a mutable builder for constructing an instance of ResponseTextDoneEvent. - 
                    
                    
                    
- 
                                
                            
                                
Method Detail
- 
                                        
contentIndex
final Long contentIndex()
The index of the content part that the text content is finalized.
 
- 
                                        
logprobs
final List<ResponseTextDoneEvent.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.
 
- 
                                        
_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).
 
- 
                                        
_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<ResponseTextDoneEvent.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.
 
- 
                                        
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
 
- 
                                        
toBuilder
final ResponseTextDoneEvent.Builder toBuilder()
 
- 
                                        
validate
final ResponseTextDoneEvent validate()
 
- 
                                        
builder
final static ResponseTextDoneEvent.Builder builder()
Returns a mutable builder for constructing an instance of ResponseTextDoneEvent.
The following fields are required:
.contentIndex() .itemId() .logprobs() .outputIndex() .sequenceNumber() .text() 
 - 
                                        
 
 - 
                                
                            
                                
 
 - 
                    
                    
                    
 
 -