Class ConversationItemInputAudioTranscriptionDeltaEvent
-
- All Implemented Interfaces:
public final class ConversationItemInputAudioTranscriptionDeltaEvent
Returned when the text value of an input audio transcription content part is updated with incremental transcription results.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final class
ConversationItemInputAudioTranscriptionDeltaEvent.Builder
A builder for ConversationItemInputAudioTranscriptionDeltaEvent.
-
Method Summary
Modifier and Type Method Description final String
eventId()
The unique ID of the server event. final String
itemId()
The ID of the item containing the audio that is being transcribed. final JsonValue
_type()
The event type, must be conversation.item.input_audio_transcription.delta
.final Optional<Long>
contentIndex()
The index of the content part in the item's content array. final Optional<String>
delta()
The text delta. final Optional<List<LogProbProperties>>
logprobs()
The log probabilities of the transcription. final JsonField<String>
_eventId()
Returns the raw JSON value of eventId. final JsonField<String>
_itemId()
Returns the raw JSON value of itemId. final JsonField<Long>
_contentIndex()
Returns the raw JSON value of contentIndex. final JsonField<String>
_delta()
Returns the raw JSON value of delta. final JsonField<List<LogProbProperties>>
_logprobs()
Returns the raw JSON value of logprobs. final Map<String, JsonValue>
_additionalProperties()
final ConversationItemInputAudioTranscriptionDeltaEvent.Builder
toBuilder()
final ConversationItemInputAudioTranscriptionDeltaEvent
validate()
final Boolean
isValid()
Boolean
equals(Object other)
Integer
hashCode()
String
toString()
final static ConversationItemInputAudioTranscriptionDeltaEvent.Builder
builder()
Returns a mutable builder for constructing an instance of ConversationItemInputAudioTranscriptionDeltaEvent. -
-
Method Detail
-
_type
final JsonValue _type()
The event type, must be
conversation.item.input_audio_transcription.delta
.Expected to always return the following:
JsonValue.from("conversation.item.input_audio_transcription.delta")
However, this method can be useful for debugging and logging (e.g. if the server responded with an unexpected value).
-
contentIndex
final Optional<Long> contentIndex()
The index of the content part in the item's content array.
-
logprobs
final Optional<List<LogProbProperties>> logprobs()
The log probabilities of the transcription. These can be enabled by configurating the session with
"include": ["item.input_audio_transcription.logprobs"]
. Each entry in the array corresponds a log probability of which token would be selected for this chunk of transcription. This can help to identify if it was possible there were multiple valid options for a given chunk of transcription.
-
_eventId
final JsonField<String> _eventId()
Returns the raw JSON value of eventId.
Unlike eventId, 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.
-
_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.
-
_logprobs
final JsonField<List<LogProbProperties>> _logprobs()
Returns the raw JSON value of logprobs.
Unlike logprobs, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final ConversationItemInputAudioTranscriptionDeltaEvent.Builder toBuilder()
-
validate
final ConversationItemInputAudioTranscriptionDeltaEvent validate()
-
builder
final static ConversationItemInputAudioTranscriptionDeltaEvent.Builder builder()
Returns a mutable builder for constructing an instance of ConversationItemInputAudioTranscriptionDeltaEvent.
The following fields are required:
.eventId() .itemId()
-
-
-
-