Class ConversationItemInputAudioTranscriptionFailedEvent
-
- All Implemented Interfaces:
public final class ConversationItemInputAudioTranscriptionFailedEventReturned when input audio transcription is configured, and a transcription request for a user message failed. These events are separate from other
errorevents so that the client can identify the related Item.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classConversationItemInputAudioTranscriptionFailedEvent.BuilderA builder for ConversationItemInputAudioTranscriptionFailedEvent.
public final classConversationItemInputAudioTranscriptionFailedEvent.ErrorDetails of the transcription error.
-
Method Summary
Modifier and Type Method Description final LongcontentIndex()The index of the content part containing the audio. final ConversationItemInputAudioTranscriptionFailedEvent.Errorerror()Details of the transcription error. final StringeventId()The unique ID of the server event. final StringitemId()The ID of the user message item. final JsonValue_type()The event type, must be conversation.item.input_audio_transcription.failed.final JsonField<Long>_contentIndex()Returns the raw JSON value of contentIndex. final JsonField<ConversationItemInputAudioTranscriptionFailedEvent.Error>_error()Returns the raw JSON value of error. final JsonField<String>_eventId()Returns the raw JSON value of eventId. final JsonField<String>_itemId()Returns the raw JSON value of itemId. final Map<String, JsonValue>_additionalProperties()final ConversationItemInputAudioTranscriptionFailedEvent.BuildertoBuilder()final ConversationItemInputAudioTranscriptionFailedEventvalidate()Validates that the types of all values in this object match their expected types recursively. final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static ConversationItemInputAudioTranscriptionFailedEvent.Builderbuilder()Returns a mutable builder for constructing an instance of ConversationItemInputAudioTranscriptionFailedEvent. -
-
Method Detail
-
contentIndex
final Long contentIndex()
The index of the content part containing the audio.
-
error
final ConversationItemInputAudioTranscriptionFailedEvent.Error error()
Details of the transcription error.
-
_type
final JsonValue _type()
The event type, must be
conversation.item.input_audio_transcription.failed.Expected to always return the following:
JsonValue.from("conversation.item.input_audio_transcription.failed")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.
-
_error
final JsonField<ConversationItemInputAudioTranscriptionFailedEvent.Error> _error()
Returns the raw JSON value of error.
Unlike error, this method doesn't throw if the JSON field has an unexpected type.
-
_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.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final ConversationItemInputAudioTranscriptionFailedEvent.Builder toBuilder()
-
validate
final ConversationItemInputAudioTranscriptionFailedEvent 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 ConversationItemInputAudioTranscriptionFailedEvent.Builder builder()
Returns a mutable builder for constructing an instance of ConversationItemInputAudioTranscriptionFailedEvent.
The following fields are required:
.contentIndex() .error() .eventId() .itemId()
-
-
-
-