Gemini Enterprise for Customer Experience V1BETA API - Class Google::Cloud::Ces::V1beta::AmbientSoundConfig (v0.1.0)

Reference documentation and code samples for the Gemini Enterprise for Customer Experience V1BETA API class Google::Cloud::Ces::V1beta::AmbientSoundConfig.

Configuration for the ambient sound to be played with the synthesized agent response, to enhance the naturalness of the conversation.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#gcs_uri

def gcs_uri() -> ::String
Returns
  • (::String) — Optional. Ambient noise as a mono-channel, 16kHz WAV file stored in Cloud Storage.

    Note: Please make sure the CES service agent service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com has storage.objects.get permission to the Cloud Storage object.

    Note: The following fields are mutually exclusive: gcs_uri, prebuilt_ambient_noise, prebuilt_ambient_sound. If a field in that set is populated, all other fields in the set will automatically be cleared.

#gcs_uri=

def gcs_uri=(value) -> ::String
Parameter
  • value (::String) — Optional. Ambient noise as a mono-channel, 16kHz WAV file stored in Cloud Storage.

    Note: Please make sure the CES service agent service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com has storage.objects.get permission to the Cloud Storage object.

    Note: The following fields are mutually exclusive: gcs_uri, prebuilt_ambient_noise, prebuilt_ambient_sound. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::String) — Optional. Ambient noise as a mono-channel, 16kHz WAV file stored in Cloud Storage.

    Note: Please make sure the CES service agent service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com has storage.objects.get permission to the Cloud Storage object.

    Note: The following fields are mutually exclusive: gcs_uri, prebuilt_ambient_noise, prebuilt_ambient_sound. If a field in that set is populated, all other fields in the set will automatically be cleared.

#prebuilt_ambient_noise

def prebuilt_ambient_noise() -> ::Google::Cloud::Ces::V1beta::AmbientSoundConfig::PrebuiltAmbientNoise
Returns
  • (::Google::Cloud::Ces::V1beta::AmbientSoundConfig::PrebuiltAmbientNoise) — Optional. Deprecated: prebuilt_ambient_noise is deprecated in favor of prebuilt_ambient_sound.

    Note: The following fields are mutually exclusive: prebuilt_ambient_noise, gcs_uri, prebuilt_ambient_sound. If a field in that set is populated, all other fields in the set will automatically be cleared.

#prebuilt_ambient_noise=

def prebuilt_ambient_noise=(value) -> ::Google::Cloud::Ces::V1beta::AmbientSoundConfig::PrebuiltAmbientNoise
Parameter
  • value (::Google::Cloud::Ces::V1beta::AmbientSoundConfig::PrebuiltAmbientNoise) — Optional. Deprecated: prebuilt_ambient_noise is deprecated in favor of prebuilt_ambient_sound.

    Note: The following fields are mutually exclusive: prebuilt_ambient_noise, gcs_uri, prebuilt_ambient_sound. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::Ces::V1beta::AmbientSoundConfig::PrebuiltAmbientNoise) — Optional. Deprecated: prebuilt_ambient_noise is deprecated in favor of prebuilt_ambient_sound.

    Note: The following fields are mutually exclusive: prebuilt_ambient_noise, gcs_uri, prebuilt_ambient_sound. If a field in that set is populated, all other fields in the set will automatically be cleared.

#prebuilt_ambient_sound

def prebuilt_ambient_sound() -> ::String
Returns
  • (::String) — Optional. Name of the prebuilt ambient sound. Valid values are:

    • "coffee_shop"
    • "keyboard"
    • "keypad"
    • "hum"
    • "office_1"
    • "office_2"
    • "office_3"
    • "room_1"
    • "room_2"
    • "room_3"
    • "room_4"
    • "room_5"
    • "air_conditioner"

    Note: The following fields are mutually exclusive: prebuilt_ambient_sound, prebuilt_ambient_noise, gcs_uri. If a field in that set is populated, all other fields in the set will automatically be cleared.

#prebuilt_ambient_sound=

def prebuilt_ambient_sound=(value) -> ::String
Parameter
  • value (::String) — Optional. Name of the prebuilt ambient sound. Valid values are:

    • "coffee_shop"
    • "keyboard"
    • "keypad"
    • "hum"
    • "office_1"
    • "office_2"
    • "office_3"
    • "room_1"
    • "room_2"
    • "room_3"
    • "room_4"
    • "room_5"
    • "air_conditioner"

    Note: The following fields are mutually exclusive: prebuilt_ambient_sound, prebuilt_ambient_noise, gcs_uri. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::String) — Optional. Name of the prebuilt ambient sound. Valid values are:

    • "coffee_shop"
    • "keyboard"
    • "keypad"
    • "hum"
    • "office_1"
    • "office_2"
    • "office_3"
    • "room_1"
    • "room_2"
    • "room_3"
    • "room_4"
    • "room_5"
    • "air_conditioner"

    Note: The following fields are mutually exclusive: prebuilt_ambient_sound, prebuilt_ambient_noise, gcs_uri. If a field in that set is populated, all other fields in the set will automatically be cleared.

#volume_gain_db

def volume_gain_db() -> ::Float
Returns
  • (::Float) — Optional. Volume gain (in dB) of the normal native volume supported by ambient noise, in the range [-96.0, 16.0]. If unset, or set to a value of 0.0 (dB), will play at normal native signal amplitude. A value of -6.0 (dB) will play at approximately half the amplitude of the normal native signal amplitude. A value of +6.0 (dB) will play at approximately twice the amplitude of the normal native signal amplitude. We strongly recommend not to exceed +10 (dB) as there's usually no effective increase in loudness for any value greater than that.

#volume_gain_db=

def volume_gain_db=(value) -> ::Float
Parameter
  • value (::Float) — Optional. Volume gain (in dB) of the normal native volume supported by ambient noise, in the range [-96.0, 16.0]. If unset, or set to a value of 0.0 (dB), will play at normal native signal amplitude. A value of -6.0 (dB) will play at approximately half the amplitude of the normal native signal amplitude. A value of +6.0 (dB) will play at approximately twice the amplitude of the normal native signal amplitude. We strongly recommend not to exceed +10 (dB) as there's usually no effective increase in loudness for any value greater than that.
Returns
  • (::Float) — Optional. Volume gain (in dB) of the normal native volume supported by ambient noise, in the range [-96.0, 16.0]. If unset, or set to a value of 0.0 (dB), will play at normal native signal amplitude. A value of -6.0 (dB) will play at approximately half the amplitude of the normal native signal amplitude. A value of +6.0 (dB) will play at approximately twice the amplitude of the normal native signal amplitude. We strongly recommend not to exceed +10 (dB) as there's usually no effective increase in loudness for any value greater than that.