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

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

An app serves as a top-level container for a group of agents, including the root agent and its sub-agents, along with their associated configurations. These agents work together to achieve specific goals within the app's context.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#audio_processing_config

def audio_processing_config() -> ::Google::Cloud::Ces::V1beta::AudioProcessingConfig
Returns

#audio_processing_config=

def audio_processing_config=(value) -> ::Google::Cloud::Ces::V1beta::AudioProcessingConfig
Parameter
Returns

#client_certificate_settings

def client_certificate_settings() -> ::Google::Cloud::Ces::V1beta::ClientCertificateSettings
Returns

#client_certificate_settings=

def client_certificate_settings=(value) -> ::Google::Cloud::Ces::V1beta::ClientCertificateSettings
Parameter
Returns

#create_time

def create_time() -> ::Google::Protobuf::Timestamp
Returns

#data_store_settings

def data_store_settings() -> ::Google::Cloud::Ces::V1beta::DataStoreSettings
Returns

#data_store_settings=

def data_store_settings=(value) -> ::Google::Cloud::Ces::V1beta::DataStoreSettings
Parameter
Returns

#default_channel_profile

def default_channel_profile() -> ::Google::Cloud::Ces::V1beta::ChannelProfile
Returns

#default_channel_profile=

def default_channel_profile=(value) -> ::Google::Cloud::Ces::V1beta::ChannelProfile
Parameter
Returns

#deployment_count

def deployment_count() -> ::Integer
Returns
  • (::Integer) — Output only. Number of deployments in the app.

#description

def description() -> ::String
Returns
  • (::String) — Optional. Human-readable description of the app.

#description=

def description=(value) -> ::String
Parameter
  • value (::String) — Optional. Human-readable description of the app.
Returns
  • (::String) — Optional. Human-readable description of the app.

#display_name

def display_name() -> ::String
Returns
  • (::String) — Required. Display name of the app.

#display_name=

def display_name=(value) -> ::String
Parameter
  • value (::String) — Required. Display name of the app.
Returns
  • (::String) — Required. Display name of the app.

#error_handling_settings

def error_handling_settings() -> ::Google::Cloud::Ces::V1beta::ErrorHandlingSettings
Returns

#error_handling_settings=

def error_handling_settings=(value) -> ::Google::Cloud::Ces::V1beta::ErrorHandlingSettings
Parameter
Returns

#etag

def etag() -> ::String
Returns
  • (::String) — Output only. Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.

#evaluation_metrics_thresholds

def evaluation_metrics_thresholds() -> ::Google::Cloud::Ces::V1beta::EvaluationMetricsThresholds
Returns

#evaluation_metrics_thresholds=

def evaluation_metrics_thresholds=(value) -> ::Google::Cloud::Ces::V1beta::EvaluationMetricsThresholds
Parameter
Returns

#evaluation_personas

def evaluation_personas() -> ::Array<::Google::Cloud::Ces::V1beta::EvaluationPersona>
Returns

#evaluation_personas=

def evaluation_personas=(value) -> ::Array<::Google::Cloud::Ces::V1beta::EvaluationPersona>
Parameter
Returns

#evaluation_settings

def evaluation_settings() -> ::Google::Cloud::Ces::V1beta::EvaluationSettings
Returns

#evaluation_settings=

def evaluation_settings=(value) -> ::Google::Cloud::Ces::V1beta::EvaluationSettings
Parameter
Returns

#global_instruction

def global_instruction() -> ::String
Returns
  • (::String) — Optional. Instructions for all the agents in the app. You can use this instruction to set up a stable identity or personality across all the agents.

#global_instruction=

def global_instruction=(value) -> ::String
Parameter
  • value (::String) — Optional. Instructions for all the agents in the app. You can use this instruction to set up a stable identity or personality across all the agents.
Returns
  • (::String) — Optional. Instructions for all the agents in the app. You can use this instruction to set up a stable identity or personality across all the agents.

#guardrails

def guardrails() -> ::Array<::String>
Returns
  • (::Array<::String>) — Optional. List of guardrails for the app. Format: projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}

#guardrails=

def guardrails=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — Optional. List of guardrails for the app. Format: projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}
Returns
  • (::Array<::String>) — Optional. List of guardrails for the app. Format: projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}

#language_settings

def language_settings() -> ::Google::Cloud::Ces::V1beta::LanguageSettings
Returns

#language_settings=

def language_settings=(value) -> ::Google::Cloud::Ces::V1beta::LanguageSettings
Parameter
Returns

#locked

def locked() -> ::Boolean
Returns
  • (::Boolean) — Optional. Indicates whether the app is locked for changes. If the app is locked, modifications to the app resources will be rejected.

#locked=

def locked=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Optional. Indicates whether the app is locked for changes. If the app is locked, modifications to the app resources will be rejected.
Returns
  • (::Boolean) — Optional. Indicates whether the app is locked for changes. If the app is locked, modifications to the app resources will be rejected.

#logging_settings

def logging_settings() -> ::Google::Cloud::Ces::V1beta::LoggingSettings
Returns

#logging_settings=

def logging_settings=(value) -> ::Google::Cloud::Ces::V1beta::LoggingSettings
Parameter
Returns

#metadata

def metadata() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Optional. Metadata about the app. This field can be used to store additional information relevant to the app's details or intended usages.

#metadata=

def metadata=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::Map{::String => ::String}) — Optional. Metadata about the app. This field can be used to store additional information relevant to the app's details or intended usages.
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Optional. Metadata about the app. This field can be used to store additional information relevant to the app's details or intended usages.

#model_settings

def model_settings() -> ::Google::Cloud::Ces::V1beta::ModelSettings
Returns

#model_settings=

def model_settings=(value) -> ::Google::Cloud::Ces::V1beta::ModelSettings
Parameter
Returns

#name

def name() -> ::String
Returns
  • (::String) — Identifier. The unique identifier of the app. Format: projects/{project}/locations/{location}/apps/{app}

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — Identifier. The unique identifier of the app. Format: projects/{project}/locations/{location}/apps/{app}
Returns
  • (::String) — Identifier. The unique identifier of the app. Format: projects/{project}/locations/{location}/apps/{app}

#pinned

def pinned() -> ::Boolean
Returns
  • (::Boolean) — Optional. Whether the app is pinned in the app list.

#pinned=

def pinned=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Optional. Whether the app is pinned in the app list.
Returns
  • (::Boolean) — Optional. Whether the app is pinned in the app list.

#predefined_variable_declarations

def predefined_variable_declarations() -> ::Array<::Google::Cloud::Ces::V1beta::App::VariableDeclaration>
Returns

#root_agent

def root_agent() -> ::String
Returns
  • (::String) — Optional. The root agent is the entry point of the app. Format: projects/{project}/locations/{location}/apps/{app}/agents/{agent}

#root_agent=

def root_agent=(value) -> ::String
Parameter
  • value (::String) — Optional. The root agent is the entry point of the app. Format: projects/{project}/locations/{location}/apps/{app}/agents/{agent}
Returns
  • (::String) — Optional. The root agent is the entry point of the app. Format: projects/{project}/locations/{location}/apps/{app}/agents/{agent}

#time_zone_settings

def time_zone_settings() -> ::Google::Cloud::Ces::V1beta::TimeZoneSettings
Returns

#time_zone_settings=

def time_zone_settings=(value) -> ::Google::Cloud::Ces::V1beta::TimeZoneSettings
Parameter
Returns

#tool_execution_mode

def tool_execution_mode() -> ::Google::Cloud::Ces::V1beta::App::ToolExecutionMode
Returns

#tool_execution_mode=

def tool_execution_mode=(value) -> ::Google::Cloud::Ces::V1beta::App::ToolExecutionMode
Parameter
Returns

#update_time

def update_time() -> ::Google::Protobuf::Timestamp
Returns

#variable_declarations

def variable_declarations() -> ::Array<::Google::Cloud::Ces::V1beta::App::VariableDeclaration>
Returns

#variable_declarations=

def variable_declarations=(value) -> ::Array<::Google::Cloud::Ces::V1beta::App::VariableDeclaration>
Parameter
Returns