All Implemented Interfaces:


public final class RealtimeSessionCreateResponse.Audio.Input.TurnDetection.ServerVad.Builder

A builder for ServerVad.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

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 RealtimeSessionCreateResponse.Audio.Input.TurnDetection.ServerVad.Builder`	`type(JsonValue type)`	Sets the field to an arbitrary JSON value.
`final RealtimeSessionCreateResponse.Audio.Input.TurnDetection.ServerVad.Builder`	`createResponse(Boolean createResponse)`	Whether or not to automatically generate a response when a VAD stop event occurs.
`final RealtimeSessionCreateResponse.Audio.Input.TurnDetection.ServerVad.Builder`	`createResponse(JsonField<Boolean> createResponse)`	Sets Builder.createResponse to an arbitrary JSON value.
`final RealtimeSessionCreateResponse.Audio.Input.TurnDetection.ServerVad.Builder`	`idleTimeoutMs(Long idleTimeoutMs)`	Optional timeout after which a model response will be triggered automatically.
`final RealtimeSessionCreateResponse.Audio.Input.TurnDetection.ServerVad.Builder`	`idleTimeoutMs(Long idleTimeoutMs)`	Alias for Builder.idleTimeoutMs.
`final RealtimeSessionCreateResponse.Audio.Input.TurnDetection.ServerVad.Builder`	`idleTimeoutMs(Optional<Long> idleTimeoutMs)`	Alias for calling Builder.idleTimeoutMs with `idleTimeoutMs.orElse(null)`.
`final RealtimeSessionCreateResponse.Audio.Input.TurnDetection.ServerVad.Builder`	`idleTimeoutMs(JsonField<Long> idleTimeoutMs)`	Sets Builder.idleTimeoutMs to an arbitrary JSON value.
`final RealtimeSessionCreateResponse.Audio.Input.TurnDetection.ServerVad.Builder`	`interruptResponse(Boolean interruptResponse)`	Whether or not to automatically interrupt any ongoing response with output to the default conversation (i.e.
`final RealtimeSessionCreateResponse.Audio.Input.TurnDetection.ServerVad.Builder`	`interruptResponse(JsonField<Boolean> interruptResponse)`	Sets Builder.interruptResponse to an arbitrary JSON value.
`final RealtimeSessionCreateResponse.Audio.Input.TurnDetection.ServerVad.Builder`	`prefixPaddingMs(Long prefixPaddingMs)`	Used only for `server_vad` mode.
`final RealtimeSessionCreateResponse.Audio.Input.TurnDetection.ServerVad.Builder`	`prefixPaddingMs(JsonField<Long> prefixPaddingMs)`	Sets Builder.prefixPaddingMs to an arbitrary JSON value.
`final RealtimeSessionCreateResponse.Audio.Input.TurnDetection.ServerVad.Builder`	`silenceDurationMs(Long silenceDurationMs)`	Used only for `server_vad` mode.
`final RealtimeSessionCreateResponse.Audio.Input.TurnDetection.ServerVad.Builder`	`silenceDurationMs(JsonField<Long> silenceDurationMs)`	Sets Builder.silenceDurationMs to an arbitrary JSON value.
`final RealtimeSessionCreateResponse.Audio.Input.TurnDetection.ServerVad.Builder`	`threshold(Double threshold)`	Used only for `server_vad` mode.
`final RealtimeSessionCreateResponse.Audio.Input.TurnDetection.ServerVad.Builder`	`threshold(JsonField<Double> threshold)`	Sets Builder.threshold to an arbitrary JSON value.
`final RealtimeSessionCreateResponse.Audio.Input.TurnDetection.ServerVad.Builder`	`additionalProperties(Map<String, JsonValue> additionalProperties)`
`final RealtimeSessionCreateResponse.Audio.Input.TurnDetection.ServerVad.Builder`	`putAdditionalProperty(String key, JsonValue value)`
`final RealtimeSessionCreateResponse.Audio.Input.TurnDetection.ServerVad.Builder`	`putAllAdditionalProperties(Map<String, JsonValue> additionalProperties)`
`final RealtimeSessionCreateResponse.Audio.Input.TurnDetection.ServerVad.Builder`	`removeAdditionalProperty(String key)`
`final RealtimeSessionCreateResponse.Audio.Input.TurnDetection.ServerVad.Builder`	`removeAllAdditionalProperties(Set<String> keys)`
`final RealtimeSessionCreateResponse.Audio.Input.TurnDetection.ServerVad`	`build()`	Returns an immutable instance of ServerVad.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
- Method Detail
  - type
```
 final RealtimeSessionCreateResponse.Audio.Input.TurnDetection.ServerVad.Builder type(JsonValue type)
```
    Sets the field to an arbitrary JSON value.
    It is usually unnecessary to call this method because the field defaults to the following:
    JsonValue.from("server_vad")
    This method is primarily for setting the field to an undocumented or not yet supported value.
  - createResponse
```
 final RealtimeSessionCreateResponse.Audio.Input.TurnDetection.ServerVad.Builder createResponse(Boolean createResponse)
```
    Whether or not to automatically generate a response when a VAD stop event occurs.
  - createResponse
```
 final RealtimeSessionCreateResponse.Audio.Input.TurnDetection.ServerVad.Builder createResponse(JsonField<Boolean> createResponse)
```
    Sets Builder.createResponse to an arbitrary JSON value.
    You should usually call Builder.createResponse with a well-typed Boolean value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
  - idleTimeoutMs
```
 final RealtimeSessionCreateResponse.Audio.Input.TurnDetection.ServerVad.Builder idleTimeoutMs(Long idleTimeoutMs)
```
    Optional timeout after which a model response will be triggered automatically. This is useful for situations in which a long pause from the user is unexpected, such as a phone call. The model will effectively prompt the user to continue the conversation based on the current context.
    The timeout value will be applied after the last model response's audio has finished playing, i.e. it's set to the response.done time plus audio playback duration.
    An input_audio_buffer.timeout_triggered event (plus events associated with the Response) will be emitted when the timeout is reached. Idle timeout is currently only supported for server_vad mode.
  - idleTimeoutMs
```
 final RealtimeSessionCreateResponse.Audio.Input.TurnDetection.ServerVad.Builder idleTimeoutMs(Long idleTimeoutMs)
```
    Alias for Builder.idleTimeoutMs.
    This unboxed primitive overload exists for backwards compatibility.
  - idleTimeoutMs
```
 final RealtimeSessionCreateResponse.Audio.Input.TurnDetection.ServerVad.Builder idleTimeoutMs(Optional<Long> idleTimeoutMs)
```
    Alias for calling Builder.idleTimeoutMs with idleTimeoutMs.orElse(null).
  - idleTimeoutMs
```
 final RealtimeSessionCreateResponse.Audio.Input.TurnDetection.ServerVad.Builder idleTimeoutMs(JsonField<Long> idleTimeoutMs)
```
    Sets Builder.idleTimeoutMs to an arbitrary JSON value.
    You should usually call Builder.idleTimeoutMs with a well-typed Long value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
  - interruptResponse
```
 final RealtimeSessionCreateResponse.Audio.Input.TurnDetection.ServerVad.Builder interruptResponse(Boolean interruptResponse)
```
    Whether or not to automatically interrupt any ongoing response with output to the default conversation (i.e. conversation of auto) when a VAD start event occurs.
  - interruptResponse
```
 final RealtimeSessionCreateResponse.Audio.Input.TurnDetection.ServerVad.Builder interruptResponse(JsonField<Boolean> interruptResponse)
```
    Sets Builder.interruptResponse to an arbitrary JSON value.
    You should usually call Builder.interruptResponse with a well-typed Boolean value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
  - prefixPaddingMs
```
 final RealtimeSessionCreateResponse.Audio.Input.TurnDetection.ServerVad.Builder prefixPaddingMs(Long prefixPaddingMs)
```
    Used only for server_vad mode. Amount of audio to include before the VAD detected speech (in milliseconds). Defaults to 300ms.
  - prefixPaddingMs
```
 final RealtimeSessionCreateResponse.Audio.Input.TurnDetection.ServerVad.Builder prefixPaddingMs(JsonField<Long> prefixPaddingMs)
```
    Sets Builder.prefixPaddingMs to an arbitrary JSON value.
    You should usually call Builder.prefixPaddingMs with a well-typed Long value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
  - silenceDurationMs
```
 final RealtimeSessionCreateResponse.Audio.Input.TurnDetection.ServerVad.Builder silenceDurationMs(Long silenceDurationMs)
```
    Used only for server_vad mode. Duration of silence to detect speech stop (in milliseconds). Defaults to 500ms. With shorter values the model will respond more quickly, but may jump in on short pauses from the user.
  - silenceDurationMs
```
 final RealtimeSessionCreateResponse.Audio.Input.TurnDetection.ServerVad.Builder silenceDurationMs(JsonField<Long> silenceDurationMs)
```
    Sets Builder.silenceDurationMs to an arbitrary JSON value.
    You should usually call Builder.silenceDurationMs with a well-typed Long value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
  - threshold
```
 final RealtimeSessionCreateResponse.Audio.Input.TurnDetection.ServerVad.Builder threshold(Double threshold)
```
    Used only for server_vad mode. Activation threshold for VAD (0.0 to 1.0), this defaults to 0.5. A higher threshold will require louder audio to activate the model, and thus might perform better in noisy environments.
  - threshold
```
 final RealtimeSessionCreateResponse.Audio.Input.TurnDetection.ServerVad.Builder threshold(JsonField<Double> threshold)
```
    Sets Builder.threshold to an arbitrary JSON value.
    You should usually call Builder.threshold with a well-typed Double value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
  - additionalProperties
```
 final RealtimeSessionCreateResponse.Audio.Input.TurnDetection.ServerVad.Builder additionalProperties(Map<String, JsonValue> additionalProperties)
```
  - putAdditionalProperty
```
 final RealtimeSessionCreateResponse.Audio.Input.TurnDetection.ServerVad.Builder putAdditionalProperty(String key, JsonValue value)
```
  - putAllAdditionalProperties
```
 final RealtimeSessionCreateResponse.Audio.Input.TurnDetection.ServerVad.Builder putAllAdditionalProperties(Map<String, JsonValue> additionalProperties)
```
  - removeAdditionalProperty
```
 final RealtimeSessionCreateResponse.Audio.Input.TurnDetection.ServerVad.Builder removeAdditionalProperty(String key)
```
  - removeAllAdditionalProperties
```
 final RealtimeSessionCreateResponse.Audio.Input.TurnDetection.ServerVad.Builder removeAllAdditionalProperties(Set<String> keys)
```
  - build
```
 final RealtimeSessionCreateResponse.Audio.Input.TurnDetection.ServerVad build()
```
    Returns an immutable instance of ServerVad.
    Further updates to this Builder will not mutate the returned instance.

Class RealtimeSessionCreateResponse.Audio.Input.TurnDetection.ServerVad.Builder

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

type

createResponse

createResponse

idleTimeoutMs

idleTimeoutMs

idleTimeoutMs

idleTimeoutMs

interruptResponse

interruptResponse

prefixPaddingMs

prefixPaddingMs

silenceDurationMs

silenceDurationMs

threshold

threshold

additionalProperties

putAdditionalProperty

putAllAdditionalProperties

removeAdditionalProperty

removeAllAdditionalProperties

build