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

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

An agent acts as the fundamental building block that provides instructions to the Large Language Model (LLM) for executing specific tasks.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#after_agent_callbacks

def after_agent_callbacks() -> ::Array<::Google::Cloud::Ces::V1::Callback>
Returns
  • (::Array<::Google::Cloud::Ces::V1::Callback>) — Optional. The callbacks to execute after the agent is called. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped.

#after_agent_callbacks=

def after_agent_callbacks=(value) -> ::Array<::Google::Cloud::Ces::V1::Callback>
Parameter
  • value (::Array<::Google::Cloud::Ces::V1::Callback>) — Optional. The callbacks to execute after the agent is called. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped.
Returns
  • (::Array<::Google::Cloud::Ces::V1::Callback>) — Optional. The callbacks to execute after the agent is called. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped.

#after_model_callbacks

def after_model_callbacks() -> ::Array<::Google::Cloud::Ces::V1::Callback>
Returns
  • (::Array<::Google::Cloud::Ces::V1::Callback>) — Optional. The callbacks to execute after the model is called. If there are multiple calls to the model, the callback will be executed multiple times. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped.

#after_model_callbacks=

def after_model_callbacks=(value) -> ::Array<::Google::Cloud::Ces::V1::Callback>
Parameter
  • value (::Array<::Google::Cloud::Ces::V1::Callback>) — Optional. The callbacks to execute after the model is called. If there are multiple calls to the model, the callback will be executed multiple times. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped.
Returns
  • (::Array<::Google::Cloud::Ces::V1::Callback>) — Optional. The callbacks to execute after the model is called. If there are multiple calls to the model, the callback will be executed multiple times. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped.

#after_tool_callbacks

def after_tool_callbacks() -> ::Array<::Google::Cloud::Ces::V1::Callback>
Returns
  • (::Array<::Google::Cloud::Ces::V1::Callback>) — Optional. The callbacks to execute after the tool is invoked. If there are multiple tool invocations, the callback will be executed multiple times. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped.

#after_tool_callbacks=

def after_tool_callbacks=(value) -> ::Array<::Google::Cloud::Ces::V1::Callback>
Parameter
  • value (::Array<::Google::Cloud::Ces::V1::Callback>) — Optional. The callbacks to execute after the tool is invoked. If there are multiple tool invocations, the callback will be executed multiple times. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped.
Returns
  • (::Array<::Google::Cloud::Ces::V1::Callback>) — Optional. The callbacks to execute after the tool is invoked. If there are multiple tool invocations, the callback will be executed multiple times. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped.

#before_agent_callbacks

def before_agent_callbacks() -> ::Array<::Google::Cloud::Ces::V1::Callback>
Returns
  • (::Array<::Google::Cloud::Ces::V1::Callback>) — Optional. The callbacks to execute before the agent is called. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped.

#before_agent_callbacks=

def before_agent_callbacks=(value) -> ::Array<::Google::Cloud::Ces::V1::Callback>
Parameter
  • value (::Array<::Google::Cloud::Ces::V1::Callback>) — Optional. The callbacks to execute before the agent is called. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped.
Returns
  • (::Array<::Google::Cloud::Ces::V1::Callback>) — Optional. The callbacks to execute before the agent is called. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped.

#before_model_callbacks

def before_model_callbacks() -> ::Array<::Google::Cloud::Ces::V1::Callback>
Returns
  • (::Array<::Google::Cloud::Ces::V1::Callback>) — Optional. The callbacks to execute before the model is called. If there are multiple calls to the model, the callback will be executed multiple times. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped.

#before_model_callbacks=

def before_model_callbacks=(value) -> ::Array<::Google::Cloud::Ces::V1::Callback>
Parameter
  • value (::Array<::Google::Cloud::Ces::V1::Callback>) — Optional. The callbacks to execute before the model is called. If there are multiple calls to the model, the callback will be executed multiple times. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped.
Returns
  • (::Array<::Google::Cloud::Ces::V1::Callback>) — Optional. The callbacks to execute before the model is called. If there are multiple calls to the model, the callback will be executed multiple times. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped.

#before_tool_callbacks

def before_tool_callbacks() -> ::Array<::Google::Cloud::Ces::V1::Callback>
Returns
  • (::Array<::Google::Cloud::Ces::V1::Callback>) — Optional. The callbacks to execute before the tool is invoked. If there are multiple tool invocations, the callback will be executed multiple times. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped.

#before_tool_callbacks=

def before_tool_callbacks=(value) -> ::Array<::Google::Cloud::Ces::V1::Callback>
Parameter
  • value (::Array<::Google::Cloud::Ces::V1::Callback>) — Optional. The callbacks to execute before the tool is invoked. If there are multiple tool invocations, the callback will be executed multiple times. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped.
Returns
  • (::Array<::Google::Cloud::Ces::V1::Callback>) — Optional. The callbacks to execute before the tool is invoked. If there are multiple tool invocations, the callback will be executed multiple times. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped.

#child_agents

def child_agents() -> ::Array<::String>
Returns
  • (::Array<::String>) — Optional. List of child agents in the agent tree. Format: projects/{project}/locations/{location}/apps/{app}/agents/{agent}

#child_agents=

def child_agents=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — Optional. List of child agents in the agent tree. Format: projects/{project}/locations/{location}/apps/{app}/agents/{agent}
Returns
  • (::Array<::String>) — Optional. List of child agents in the agent tree. Format: projects/{project}/locations/{location}/apps/{app}/agents/{agent}

#create_time

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

#description

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

#description=

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

#display_name

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

#display_name=

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

#etag

def etag() -> ::String
Returns
  • (::String) — 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.

#etag=

def etag=(value) -> ::String
Parameter
  • value (::String) — 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.
Returns
  • (::String) — 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.

#generated_summary

def generated_summary() -> ::String
Returns
  • (::String) — Output only. If the agent is generated by the LLM assistant, this field contains a descriptive summary of the generation.

#guardrails

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

#instruction

def instruction() -> ::String
Returns
  • (::String) — Optional. Instructions for the LLM model to guide the agent's behavior.

#instruction=

def instruction=(value) -> ::String
Parameter
  • value (::String) — Optional. Instructions for the LLM model to guide the agent's behavior.
Returns
  • (::String) — Optional. Instructions for the LLM model to guide the agent's behavior.

#llm_agent

def llm_agent() -> ::Google::Cloud::Ces::V1::Agent::LlmAgent
Returns
  • (::Google::Cloud::Ces::V1::Agent::LlmAgent) — Optional. The default agent type.

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

#llm_agent=

def llm_agent=(value) -> ::Google::Cloud::Ces::V1::Agent::LlmAgent
Parameter
  • value (::Google::Cloud::Ces::V1::Agent::LlmAgent) — Optional. The default agent type.

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

Returns
  • (::Google::Cloud::Ces::V1::Agent::LlmAgent) — Optional. The default agent type.

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

#model_settings

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

#model_settings=

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

#name

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

#name=

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

#remote_dialogflow_agent

def remote_dialogflow_agent() -> ::Google::Cloud::Ces::V1::Agent::RemoteDialogflowAgent
Returns
  • (::Google::Cloud::Ces::V1::Agent::RemoteDialogflowAgent) — Optional. The remote Dialogflow agent to be used for the agent execution. If this field is set, all other agent level properties will be ignored.

    Note: If the Dialogflow agent is in a different project from the app, you should grant roles/dialogflow.client to the CES service agent service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.

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

#remote_dialogflow_agent=

def remote_dialogflow_agent=(value) -> ::Google::Cloud::Ces::V1::Agent::RemoteDialogflowAgent
Parameter
  • value (::Google::Cloud::Ces::V1::Agent::RemoteDialogflowAgent) — Optional. The remote Dialogflow agent to be used for the agent execution. If this field is set, all other agent level properties will be ignored.

    Note: If the Dialogflow agent is in a different project from the app, you should grant roles/dialogflow.client to the CES service agent service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.

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

Returns
  • (::Google::Cloud::Ces::V1::Agent::RemoteDialogflowAgent) — Optional. The remote Dialogflow agent to be used for the agent execution. If this field is set, all other agent level properties will be ignored.

    Note: If the Dialogflow agent is in a different project from the app, you should grant roles/dialogflow.client to the CES service agent service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.

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

#tools

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

#tools=

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

#toolsets

def toolsets() -> ::Array<::Google::Cloud::Ces::V1::Agent::AgentToolset>
Returns

#toolsets=

def toolsets=(value) -> ::Array<::Google::Cloud::Ces::V1::Agent::AgentToolset>
Parameter
Returns

#transfer_rules

def transfer_rules() -> ::Array<::Google::Cloud::Ces::V1::TransferRule>
Returns

#transfer_rules=

def transfer_rules=(value) -> ::Array<::Google::Cloud::Ces::V1::TransferRule>
Parameter
Returns

#update_time

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