Gemini Enterprise for Customer Experience API - Module Google::Cloud::Ces (v0.1.0)

Reference documentation and code samples for the Gemini Enterprise for Customer Experience API module Google::Cloud::Ces.

Methods

.agent_service

def self.agent_service(version: :v1, transport: :grpc, &block) -> ::Object

Create a new client object for AgentService.

By default, this returns an instance of Google::Cloud::Ces::V1::AgentService::Client for a gRPC client for version V1 of the API. However, you can specify a different API version by passing it in the version parameter. If the AgentService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the AgentService service. You can determine whether the method will succeed by calling Ces.agent_service_available?.

About AgentService

The service that manages agent-related resources in Gemini Enterprise for Customer Engagement (CES).

Parameters
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (::Object) — A client object for the specified version.

.agent_service_available?

def self.agent_service_available?(version: :v1, transport: :grpc) -> boolean

Determines whether the AgentService service is supported by the current client. If true, you can retrieve a client object by calling Ces.agent_service. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the AgentService service, or if the versioned client gem needs an update to support the AgentService service.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (boolean) — Whether the service is available.

.configure

def self.configure() -> ::Google::Cloud::Config

Configure the google-cloud-ces library.

The following configuration parameters are supported:

  • credentials (type: String, Hash, Google::Auth::Credentials) - The path to the keyfile as a String, the contents of the keyfile as a Hash, or a Google::Auth::Credentials object.
  • lib_name (type: String) - The library name as recorded in instrumentation and logging.
  • lib_version (type: String) - The library version as recorded in instrumentation and logging.
  • interceptors (type: Array<GRPC::ClientInterceptor>) - An array of interceptors that are run before calls are executed.
  • timeout (type: Numeric) - Default timeout in seconds.
  • metadata (type: Hash{Symbol=>String}) - Additional headers to be sent with the call.
  • retry_policy (type: Hash) - The retry policy. The value is a hash with the following keys:
    • :initial_delay (type: Numeric) - The initial delay in seconds.
    • :max_delay (type: Numeric) - The max delay in seconds.
    • :multiplier (type: Numeric) - The incremental backoff multiplier.
    • :retry_codes (type: Array<String>) - The error codes that should trigger a retry.
Yields
  • (::Google::Cloud.configure.ces)
Returns
  • (::Google::Cloud::Config) — The default configuration used by this library

.session_service

def self.session_service(version: :v1, transport: :grpc, &block) -> ::Object

Create a new client object for SessionService.

By default, this returns an instance of Google::Cloud::Ces::V1::SessionService::Client for a gRPC client for version V1 of the API. However, you can specify a different API version by passing it in the version parameter. If the SessionService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the SessionService service. You can determine whether the method will succeed by calling Ces.session_service_available?.

About SessionService

Session service provides APIs for interacting with CES agents.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (::Object) — A client object for the specified version.

.session_service_available?

def self.session_service_available?(version: :v1, transport: :grpc) -> boolean

Determines whether the SessionService service is supported by the current client. If true, you can retrieve a client object by calling Ces.session_service. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the SessionService service, or if the versioned client gem needs an update to support the SessionService service.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (boolean) — Whether the service is available.

.tool_service

def self.tool_service(version: :v1, transport: :grpc, &block) -> ::Object

Create a new client object for ToolService.

By default, this returns an instance of Google::Cloud::Ces::V1::ToolService::Client for a gRPC client for version V1 of the API. However, you can specify a different API version by passing it in the version parameter. If the ToolService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the ToolService service. You can determine whether the method will succeed by calling Ces.tool_service_available?.

About ToolService

Tool service provides APIs for interacting with CES tools.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (::Object) — A client object for the specified version.

.tool_service_available?

def self.tool_service_available?(version: :v1, transport: :grpc) -> boolean

Determines whether the ToolService service is supported by the current client. If true, you can retrieve a client object by calling Ces.tool_service. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the ToolService service, or if the versioned client gem needs an update to support the ToolService service.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (boolean) — Whether the service is available.

.widget_service

def self.widget_service(version: :v1, transport: :grpc, &block) -> ::Object

Create a new client object for WidgetService.

By default, this returns an instance of Google::Cloud::Ces::V1::WidgetService::Client for a gRPC client for version V1 of the API. However, you can specify a different API version by passing it in the version parameter. If the WidgetService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the WidgetService service. You can determine whether the method will succeed by calling Ces.widget_service_available?.

About WidgetService

Provides APIs for widgets to interact with CES APIs.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (::Object) — A client object for the specified version.

.widget_service_available?

def self.widget_service_available?(version: :v1, transport: :grpc) -> boolean

Determines whether the WidgetService service is supported by the current client. If true, you can retrieve a client object by calling Ces.widget_service. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the WidgetService service, or if the versioned client gem needs an update to support the WidgetService service.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (boolean) — Whether the service is available.

Constants

VERSION

value: "0.1.0"