Class RealtimeResponseStatus
-
- All Implemented Interfaces:
public final class RealtimeResponseStatus
Additional details about the status.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final class
RealtimeResponseStatus.Builder
A builder for RealtimeResponseStatus.
public final class
RealtimeResponseStatus.Error
A description of the error that caused the response to fail, populated when the
status
isfailed
.public final class
RealtimeResponseStatus.Reason
The reason the Response did not complete. For a
cancelled
Response, one ofturn_detected
(the server VAD detected a new start of speech) orclient_cancelled
(the client sent a cancel event). For anincomplete
Response, one ofmax_output_tokens
orcontent_filter
(the server-side safety filter activated and cut off the response).public final class
RealtimeResponseStatus.Type
The type of error that caused the response to fail, corresponding with the
status
field (completed
,cancelled
,incomplete
,failed
).
-
Method Summary
Modifier and Type Method Description final Optional<RealtimeResponseStatus.Error>
error()
A description of the error that caused the response to fail, populated when the status
isfailed
.final Optional<RealtimeResponseStatus.Reason>
reason()
The reason the Response did not complete. final Optional<RealtimeResponseStatus.Type>
type()
The type of error that caused the response to fail, corresponding with the status
field (completed
,cancelled
,incomplete
,failed
).final JsonField<RealtimeResponseStatus.Error>
_error()
Returns the raw JSON value of error. final JsonField<RealtimeResponseStatus.Reason>
_reason()
Returns the raw JSON value of reason. final JsonField<RealtimeResponseStatus.Type>
_type()
Returns the raw JSON value of type. final Map<String, JsonValue>
_additionalProperties()
final RealtimeResponseStatus.Builder
toBuilder()
final RealtimeResponseStatus
validate()
final Boolean
isValid()
Boolean
equals(Object other)
Integer
hashCode()
String
toString()
final static RealtimeResponseStatus.Builder
builder()
Returns a mutable builder for constructing an instance of RealtimeResponseStatus. -
-
Method Detail
-
error
final Optional<RealtimeResponseStatus.Error> error()
A description of the error that caused the response to fail, populated when the
status
isfailed
.
-
reason
final Optional<RealtimeResponseStatus.Reason> reason()
The reason the Response did not complete. For a
cancelled
Response, one ofturn_detected
(the server VAD detected a new start of speech) orclient_cancelled
(the client sent a cancel event). For anincomplete
Response, one ofmax_output_tokens
orcontent_filter
(the server-side safety filter activated and cut off the response).
-
type
final Optional<RealtimeResponseStatus.Type> type()
The type of error that caused the response to fail, corresponding with the
status
field (completed
,cancelled
,incomplete
,failed
).
-
_error
final JsonField<RealtimeResponseStatus.Error> _error()
Returns the raw JSON value of error.
Unlike error, this method doesn't throw if the JSON field has an unexpected type.
-
_reason
final JsonField<RealtimeResponseStatus.Reason> _reason()
Returns the raw JSON value of reason.
Unlike reason, this method doesn't throw if the JSON field has an unexpected type.
-
_type
final JsonField<RealtimeResponseStatus.Type> _type()
Returns the raw JSON value of type.
Unlike type, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final RealtimeResponseStatus.Builder toBuilder()
-
validate
final RealtimeResponseStatus validate()
-
builder
final static RealtimeResponseStatus.Builder builder()
Returns a mutable builder for constructing an instance of RealtimeResponseStatus.
-
-
-
-