Class Agent (0.7.0)

  public 
  
 final 
  
 class 
 Agent 
  
 extends 
  
 GeneratedMessage 
  
 implements 
  
 AgentOrBuilder 
 

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

Protobuf type google.cloud.ces.v1.Agent

Implements

AgentOrBuilder

Static Fields

AFTER_AGENT_CALLBACKS_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 AFTER_AGENT_CALLBACKS_FIELD_NUMBER 
 
Field Value
Type
Description
int

AFTER_MODEL_CALLBACKS_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 AFTER_MODEL_CALLBACKS_FIELD_NUMBER 
 
Field Value
Type
Description
int

AFTER_TOOL_CALLBACKS_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 AFTER_TOOL_CALLBACKS_FIELD_NUMBER 
 
Field Value
Type
Description
int

BEFORE_AGENT_CALLBACKS_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 BEFORE_AGENT_CALLBACKS_FIELD_NUMBER 
 
Field Value
Type
Description
int

BEFORE_MODEL_CALLBACKS_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 BEFORE_MODEL_CALLBACKS_FIELD_NUMBER 
 
Field Value
Type
Description
int

BEFORE_TOOL_CALLBACKS_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 BEFORE_TOOL_CALLBACKS_FIELD_NUMBER 
 
Field Value
Type
Description
int

CHILD_AGENTS_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 CHILD_AGENTS_FIELD_NUMBER 
 
Field Value
Type
Description
int

CREATE_TIME_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 CREATE_TIME_FIELD_NUMBER 
 
Field Value
Type
Description
int

DESCRIPTION_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 DESCRIPTION_FIELD_NUMBER 
 
Field Value
Type
Description
int

DISPLAY_NAME_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 DISPLAY_NAME_FIELD_NUMBER 
 
Field Value
Type
Description
int

ETAG_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 ETAG_FIELD_NUMBER 
 
Field Value
Type
Description
int

GENERATED_SUMMARY_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 GENERATED_SUMMARY_FIELD_NUMBER 
 
Field Value
Type
Description
int

GUARDRAILS_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 GUARDRAILS_FIELD_NUMBER 
 
Field Value
Type
Description
int

INSTRUCTION_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 INSTRUCTION_FIELD_NUMBER 
 
Field Value
Type
Description
int

LLM_AGENT_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 LLM_AGENT_FIELD_NUMBER 
 
Field Value
Type
Description
int

MODEL_SETTINGS_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 MODEL_SETTINGS_FIELD_NUMBER 
 
Field Value
Type
Description
int

NAME_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 NAME_FIELD_NUMBER 
 
Field Value
Type
Description
int

REMOTE_DIALOGFLOW_AGENT_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 REMOTE_DIALOGFLOW_AGENT_FIELD_NUMBER 
 
Field Value
Type
Description
int

TOOLSETS_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 TOOLSETS_FIELD_NUMBER 
 
Field Value
Type
Description
int

TOOLS_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 TOOLS_FIELD_NUMBER 
 
Field Value
Type
Description
int

TRANSFER_RULES_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 TRANSFER_RULES_FIELD_NUMBER 
 
Field Value
Type
Description
int

UPDATE_TIME_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 UPDATE_TIME_FIELD_NUMBER 
 
Field Value
Type
Description
int

Static Methods

getDefaultInstance()

  public 
  
 static 
  
 Agent 
  
 getDefaultInstance 
 () 
 
Returns
Type
Description

getDescriptor()

  public 
  
 static 
  
 final 
  
 Descriptors 
 . 
 Descriptor 
  
 getDescriptor 
 () 
 
Returns
Type
Description

newBuilder()

  public 
  
 static 
  
 Agent 
 . 
 Builder 
  
 newBuilder 
 () 
 
Returns
Type
Description

newBuilder(Agent prototype)

  public 
  
 static 
  
 Agent 
 . 
 Builder 
  
 newBuilder 
 ( 
 Agent 
  
 prototype 
 ) 
 
Parameter
Name
Description
prototype
Returns
Type
Description

parseDelimitedFrom(InputStream input)

  public 
  
 static 
  
 Agent 
  
 parseDelimitedFrom 
 ( 
 InputStream 
  
 input 
 ) 
 
Parameter
Name
Description
input
Returns
Type
Description
Exceptions
Type
Description

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

  public 
  
 static 
  
 Agent 
  
 parseDelimitedFrom 
 ( 
 InputStream 
  
 input 
 , 
  
 ExtensionRegistryLite 
  
 extensionRegistry 
 ) 
 
Parameters
Name
Description
input
extensionRegistry
Returns
Type
Description
Exceptions
Type
Description

parseFrom(byte[] data)

  public 
  
 static 
  
 Agent 
  
 parseFrom 
 ( 
 byte 
 [] 
  
 data 
 ) 
 
Parameter
Name
Description
data
byte []
Returns
Type
Description
Exceptions
Type
Description

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

  public 
  
 static 
  
 Agent 
  
 parseFrom 
 ( 
 byte 
 [] 
  
 data 
 , 
  
 ExtensionRegistryLite 
  
 extensionRegistry 
 ) 
 
Parameters
Name
Description
data
byte []
extensionRegistry
Returns
Type
Description
Exceptions
Type
Description

parseFrom(ByteString data)

  public 
  
 static 
  
 Agent 
  
 parseFrom 
 ( 
 ByteString 
  
 data 
 ) 
 
Parameter
Name
Description
data
Returns
Type
Description
Exceptions
Type
Description

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

  public 
  
 static 
  
 Agent 
  
 parseFrom 
 ( 
 ByteString 
  
 data 
 , 
  
 ExtensionRegistryLite 
  
 extensionRegistry 
 ) 
 
Parameters
Name
Description
data
extensionRegistry
Returns
Type
Description
Exceptions
Type
Description

parseFrom(CodedInputStream input)

  public 
  
 static 
  
 Agent 
  
 parseFrom 
 ( 
 CodedInputStream 
  
 input 
 ) 
 
Parameter
Name
Description
Returns
Type
Description
Exceptions
Type
Description

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

  public 
  
 static 
  
 Agent 
  
 parseFrom 
 ( 
 CodedInputStream 
  
 input 
 , 
  
 ExtensionRegistryLite 
  
 extensionRegistry 
 ) 
 
Parameters
Name
Description
extensionRegistry
Returns
Type
Description
Exceptions
Type
Description

parseFrom(InputStream input)

  public 
  
 static 
  
 Agent 
  
 parseFrom 
 ( 
 InputStream 
  
 input 
 ) 
 
Parameter
Name
Description
input
Returns
Type
Description
Exceptions
Type
Description

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

  public 
  
 static 
  
 Agent 
  
 parseFrom 
 ( 
 InputStream 
  
 input 
 , 
  
 ExtensionRegistryLite 
  
 extensionRegistry 
 ) 
 
Parameters
Name
Description
input
extensionRegistry
Returns
Type
Description
Exceptions
Type
Description

parseFrom(ByteBuffer data)

  public 
  
 static 
  
 Agent 
  
 parseFrom 
 ( 
 ByteBuffer 
  
 data 
 ) 
 
Parameter
Name
Description
data
Returns
Type
Description
Exceptions
Type
Description

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

  public 
  
 static 
  
 Agent 
  
 parseFrom 
 ( 
 ByteBuffer 
  
 data 
 , 
  
 ExtensionRegistryLite 
  
 extensionRegistry 
 ) 
 
Parameters
Name
Description
data
extensionRegistry
Returns
Type
Description
Exceptions
Type
Description

parser()

  public 
  
 static 
  
 Parser<Agent> 
  
 parser 
 () 
 
Returns
Type
Description

Methods

equals(Object obj)

  public 
  
 boolean 
  
 equals 
 ( 
 Object 
  
 obj 
 ) 
 
Parameter
Name
Description
obj
Returns
Type
Description
Overrides

getAfterAgentCallbacks(int index)

  public 
  
 Callback 
  
 getAfterAgentCallbacks 
 ( 
 int 
  
 index 
 ) 
 

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.

repeated .google.cloud.ces.v1.Callback after_agent_callbacks = 19 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name
Description
index
int
Returns
Type
Description

getAfterAgentCallbacksCount()

  public 
  
 int 
  
 getAfterAgentCallbacksCount 
 () 
 

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.

repeated .google.cloud.ces.v1.Callback after_agent_callbacks = 19 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type
Description
int

getAfterAgentCallbacksList()

  public 
  
 List<Callback> 
  
 getAfterAgentCallbacksList 
 () 
 

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.

repeated .google.cloud.ces.v1.Callback after_agent_callbacks = 19 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type
Description

getAfterAgentCallbacksOrBuilder(int index)

  public 
  
 CallbackOrBuilder 
  
 getAfterAgentCallbacksOrBuilder 
 ( 
 int 
  
 index 
 ) 
 

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.

repeated .google.cloud.ces.v1.Callback after_agent_callbacks = 19 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name
Description
index
int
Returns
Type
Description

getAfterAgentCallbacksOrBuilderList()

  public 
  
 List 
< ? 
  
 extends 
  
 CallbackOrBuilder 
>  
 getAfterAgentCallbacksOrBuilderList 
 () 
 

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.

repeated .google.cloud.ces.v1.Callback after_agent_callbacks = 19 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type
Description
List < ? extends com.google.cloud.ces.v1.CallbackOrBuilder >

getAfterModelCallbacks(int index)

  public 
  
 Callback 
  
 getAfterModelCallbacks 
 ( 
 int 
  
 index 
 ) 
 

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.

repeated .google.cloud.ces.v1.Callback after_model_callbacks = 21 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name
Description
index
int
Returns
Type
Description

getAfterModelCallbacksCount()

  public 
  
 int 
  
 getAfterModelCallbacksCount 
 () 
 

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.

repeated .google.cloud.ces.v1.Callback after_model_callbacks = 21 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type
Description
int

getAfterModelCallbacksList()

  public 
  
 List<Callback> 
  
 getAfterModelCallbacksList 
 () 
 

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.

repeated .google.cloud.ces.v1.Callback after_model_callbacks = 21 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type
Description

getAfterModelCallbacksOrBuilder(int index)

  public 
  
 CallbackOrBuilder 
  
 getAfterModelCallbacksOrBuilder 
 ( 
 int 
  
 index 
 ) 
 

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.

repeated .google.cloud.ces.v1.Callback after_model_callbacks = 21 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name
Description
index
int
Returns
Type
Description

getAfterModelCallbacksOrBuilderList()

  public 
  
 List 
< ? 
  
 extends 
  
 CallbackOrBuilder 
>  
 getAfterModelCallbacksOrBuilderList 
 () 
 

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.

repeated .google.cloud.ces.v1.Callback after_model_callbacks = 21 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type
Description
List < ? extends com.google.cloud.ces.v1.CallbackOrBuilder >

getAfterToolCallbacks(int index)

  public 
  
 Callback 
  
 getAfterToolCallbacks 
 ( 
 int 
  
 index 
 ) 
 

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.

repeated .google.cloud.ces.v1.Callback after_tool_callbacks = 23 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name
Description
index
int
Returns
Type
Description

getAfterToolCallbacksCount()

  public 
  
 int 
  
 getAfterToolCallbacksCount 
 () 
 

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.

repeated .google.cloud.ces.v1.Callback after_tool_callbacks = 23 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type
Description
int

getAfterToolCallbacksList()

  public 
  
 List<Callback> 
  
 getAfterToolCallbacksList 
 () 
 

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.

repeated .google.cloud.ces.v1.Callback after_tool_callbacks = 23 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type
Description

getAfterToolCallbacksOrBuilder(int index)

  public 
  
 CallbackOrBuilder 
  
 getAfterToolCallbacksOrBuilder 
 ( 
 int 
  
 index 
 ) 
 

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.

repeated .google.cloud.ces.v1.Callback after_tool_callbacks = 23 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name
Description
index
int
Returns
Type
Description

getAfterToolCallbacksOrBuilderList()

  public 
  
 List 
< ? 
  
 extends 
  
 CallbackOrBuilder 
>  
 getAfterToolCallbacksOrBuilderList 
 () 
 

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.

repeated .google.cloud.ces.v1.Callback after_tool_callbacks = 23 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type
Description
List < ? extends com.google.cloud.ces.v1.CallbackOrBuilder >

getAgentTypeCase()

  public 
  
 Agent 
 . 
 AgentTypeCase 
  
 getAgentTypeCase 
 () 
 
Returns
Type
Description

getBeforeAgentCallbacks(int index)

  public 
  
 Callback 
  
 getBeforeAgentCallbacks 
 ( 
 int 
  
 index 
 ) 
 

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.

repeated .google.cloud.ces.v1.Callback before_agent_callbacks = 18 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name
Description
index
int
Returns
Type
Description

getBeforeAgentCallbacksCount()

  public 
  
 int 
  
 getBeforeAgentCallbacksCount 
 () 
 

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.

repeated .google.cloud.ces.v1.Callback before_agent_callbacks = 18 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type
Description
int

getBeforeAgentCallbacksList()

  public 
  
 List<Callback> 
  
 getBeforeAgentCallbacksList 
 () 
 

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.

repeated .google.cloud.ces.v1.Callback before_agent_callbacks = 18 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type
Description

getBeforeAgentCallbacksOrBuilder(int index)

  public 
  
 CallbackOrBuilder 
  
 getBeforeAgentCallbacksOrBuilder 
 ( 
 int 
  
 index 
 ) 
 

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.

repeated .google.cloud.ces.v1.Callback before_agent_callbacks = 18 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name
Description
index
int
Returns
Type
Description

getBeforeAgentCallbacksOrBuilderList()

  public 
  
 List 
< ? 
  
 extends 
  
 CallbackOrBuilder 
>  
 getBeforeAgentCallbacksOrBuilderList 
 () 
 

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.

repeated .google.cloud.ces.v1.Callback before_agent_callbacks = 18 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type
Description
List < ? extends com.google.cloud.ces.v1.CallbackOrBuilder >

getBeforeModelCallbacks(int index)

  public 
  
 Callback 
  
 getBeforeModelCallbacks 
 ( 
 int 
  
 index 
 ) 
 

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.

repeated .google.cloud.ces.v1.Callback before_model_callbacks = 20 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name
Description
index
int
Returns
Type
Description

getBeforeModelCallbacksCount()

  public 
  
 int 
  
 getBeforeModelCallbacksCount 
 () 
 

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.

repeated .google.cloud.ces.v1.Callback before_model_callbacks = 20 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type
Description
int

getBeforeModelCallbacksList()

  public 
  
 List<Callback> 
  
 getBeforeModelCallbacksList 
 () 
 

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.

repeated .google.cloud.ces.v1.Callback before_model_callbacks = 20 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type
Description

getBeforeModelCallbacksOrBuilder(int index)

  public 
  
 CallbackOrBuilder 
  
 getBeforeModelCallbacksOrBuilder 
 ( 
 int 
  
 index 
 ) 
 

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.

repeated .google.cloud.ces.v1.Callback before_model_callbacks = 20 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name
Description
index
int
Returns
Type
Description

getBeforeModelCallbacksOrBuilderList()

  public 
  
 List 
< ? 
  
 extends 
  
 CallbackOrBuilder 
>  
 getBeforeModelCallbacksOrBuilderList 
 () 
 

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.

repeated .google.cloud.ces.v1.Callback before_model_callbacks = 20 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type
Description
List < ? extends com.google.cloud.ces.v1.CallbackOrBuilder >

getBeforeToolCallbacks(int index)

  public 
  
 Callback 
  
 getBeforeToolCallbacks 
 ( 
 int 
  
 index 
 ) 
 

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.

repeated .google.cloud.ces.v1.Callback before_tool_callbacks = 22 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name
Description
index
int
Returns
Type
Description

getBeforeToolCallbacksCount()

  public 
  
 int 
  
 getBeforeToolCallbacksCount 
 () 
 

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.

repeated .google.cloud.ces.v1.Callback before_tool_callbacks = 22 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type
Description
int

getBeforeToolCallbacksList()

  public 
  
 List<Callback> 
  
 getBeforeToolCallbacksList 
 () 
 

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.

repeated .google.cloud.ces.v1.Callback before_tool_callbacks = 22 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type
Description

getBeforeToolCallbacksOrBuilder(int index)

  public 
  
 CallbackOrBuilder 
  
 getBeforeToolCallbacksOrBuilder 
 ( 
 int 
  
 index 
 ) 
 

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.

repeated .google.cloud.ces.v1.Callback before_tool_callbacks = 22 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name
Description
index
int
Returns
Type
Description

getBeforeToolCallbacksOrBuilderList()

  public 
  
 List 
< ? 
  
 extends 
  
 CallbackOrBuilder 
>  
 getBeforeToolCallbacksOrBuilderList 
 () 
 

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.

repeated .google.cloud.ces.v1.Callback before_tool_callbacks = 22 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type
Description
List < ? extends com.google.cloud.ces.v1.CallbackOrBuilder >

getChildAgents(int index)

  public 
  
 String 
  
 getChildAgents 
 ( 
 int 
  
 index 
 ) 
 

Optional. List of child agents in the agent tree. Format: projects/{project}/locations/{location}/apps/{app}/agents/{agent}

repeated string child_agents = 8 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name
Description
index
int

The index of the element to return.

Returns
Type
Description

The childAgents at the given index.

getChildAgentsBytes(int index)

  public 
  
 ByteString 
  
 getChildAgentsBytes 
 ( 
 int 
  
 index 
 ) 
 

Optional. List of child agents in the agent tree. Format: projects/{project}/locations/{location}/apps/{app}/agents/{agent}

repeated string child_agents = 8 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name
Description
index
int

The index of the value to return.

Returns
Type
Description

The bytes of the childAgents at the given index.

getChildAgentsCount()

  public 
  
 int 
  
 getChildAgentsCount 
 () 
 

Optional. List of child agents in the agent tree. Format: projects/{project}/locations/{location}/apps/{app}/agents/{agent}

repeated string child_agents = 8 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type
Description
int

The count of childAgents.

getChildAgentsList()

  public 
  
 ProtocolStringList 
  
 getChildAgentsList 
 () 
 

Optional. List of child agents in the agent tree. Format: projects/{project}/locations/{location}/apps/{app}/agents/{agent}

repeated string child_agents = 8 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type
Description

A list containing the childAgents.

getCreateTime()

  public 
  
 Timestamp 
  
 getCreateTime 
 () 
 

Output only. Timestamp when the agent was created.

.google.protobuf.Timestamp create_time = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type
Description

The createTime.

getCreateTimeOrBuilder()

  public 
  
 TimestampOrBuilder 
  
 getCreateTimeOrBuilder 
 () 
 

Output only. Timestamp when the agent was created.

.google.protobuf.Timestamp create_time = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type
Description

getDefaultInstanceForType()

  public 
  
 Agent 
  
 getDefaultInstanceForType 
 () 
 
Returns
Type
Description

getDescription()

  public 
  
 String 
  
 getDescription 
 () 
 

Optional. Human-readable description of the agent.

string description = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type
Description

The description.

getDescriptionBytes()

  public 
  
 ByteString 
  
 getDescriptionBytes 
 () 
 

Optional. Human-readable description of the agent.

string description = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type
Description

The bytes for description.

getDisplayName()

  public 
  
 String 
  
 getDisplayName 
 () 
 

Required. Display name of the agent.

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type
Description

The displayName.

getDisplayNameBytes()

  public 
  
 ByteString 
  
 getDisplayNameBytes 
 () 
 

Required. Display name of the agent.

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type
Description

The bytes for displayName.

getEtag()

  public 
  
 String 
  
 getEtag 
 () 
 

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.

string etag = 24;

Returns
Type
Description

The etag.

getEtagBytes()

  public 
  
 ByteString 
  
 getEtagBytes 
 () 
 

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.

string etag = 24;

Returns
Type
Description

The bytes for etag.

getGeneratedSummary()

  public 
  
 String 
  
 getGeneratedSummary 
 () 
 

Output only. If the agent is generated by the LLM assistant, this field contains a descriptive summary of the generation.

string generated_summary = 29 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type
Description

The generatedSummary.

getGeneratedSummaryBytes()

  public 
  
 ByteString 
  
 getGeneratedSummaryBytes 
 () 
 

Output only. If the agent is generated by the LLM assistant, this field contains a descriptive summary of the generation.

string generated_summary = 29 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type
Description

The bytes for generatedSummary.

getGuardrails(int index)

  public 
  
 String 
  
 getGuardrails 
 ( 
 int 
  
 index 
 ) 
 

Optional. List of guardrails for the agent. Format: projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}

repeated string guardrails = 17 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name
Description
index
int

The index of the element to return.

Returns
Type
Description

The guardrails at the given index.

getGuardrailsBytes(int index)

  public 
  
 ByteString 
  
 getGuardrailsBytes 
 ( 
 int 
  
 index 
 ) 
 

Optional. List of guardrails for the agent. Format: projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}

repeated string guardrails = 17 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name
Description
index
int

The index of the value to return.

Returns
Type
Description

The bytes of the guardrails at the given index.

getGuardrailsCount()

  public 
  
 int 
  
 getGuardrailsCount 
 () 
 

Optional. List of guardrails for the agent. Format: projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}

repeated string guardrails = 17 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type
Description
int

The count of guardrails.

getGuardrailsList()

  public 
  
 ProtocolStringList 
  
 getGuardrailsList 
 () 
 

Optional. List of guardrails for the agent. Format: projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}

repeated string guardrails = 17 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type
Description

A list containing the guardrails.

getInstruction()

  public 
  
 String 
  
 getInstruction 
 () 
 

Optional. Instructions for the LLM model to guide the agent's behavior.

string instruction = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type
Description

The instruction.

getInstructionBytes()

  public 
  
 ByteString 
  
 getInstructionBytes 
 () 
 

Optional. Instructions for the LLM model to guide the agent's behavior.

string instruction = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type
Description

The bytes for instruction.

getLlmAgent()

  public 
  
 Agent 
 . 
 LlmAgent 
  
 getLlmAgent 
 () 
 

Optional. The default agent type.

.google.cloud.ces.v1.Agent.LlmAgent llm_agent = 26 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type
Description

The llmAgent.

getLlmAgentOrBuilder()

  public 
  
 Agent 
 . 
 LlmAgentOrBuilder 
  
 getLlmAgentOrBuilder 
 () 
 

Optional. The default agent type.

.google.cloud.ces.v1.Agent.LlmAgent llm_agent = 26 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type
Description

getModelSettings()

  public 
  
 ModelSettings 
  
 getModelSettings 
 () 
 

Optional. Configurations for the LLM model.

.google.cloud.ces.v1.ModelSettings model_settings = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type
Description

The modelSettings.

getModelSettingsOrBuilder()

  public 
  
 ModelSettingsOrBuilder 
  
 getModelSettingsOrBuilder 
 () 
 

Optional. Configurations for the LLM model.

.google.cloud.ces.v1.ModelSettings model_settings = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type
Description

getName()

  public 
  
 String 
  
 getName 
 () 
 

Identifier. The unique identifier of the agent. Format: projects/{project}/locations/{location}/apps/{app}/agents/{agent}

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type
Description

The name.

getNameBytes()

  public 
  
 ByteString 
  
 getNameBytes 
 () 
 

Identifier. The unique identifier of the agent. Format: projects/{project}/locations/{location}/apps/{app}/agents/{agent}

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type
Description

The bytes for name.

getParserForType()

  public 
  
 Parser<Agent> 
  
 getParserForType 
 () 
 
Returns
Type
Description
Overrides

getRemoteDialogflowAgent()

  public 
  
 Agent 
 . 
 RemoteDialogflowAgent 
  
 getRemoteDialogflowAgent 
 () 
 

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 .

.google.cloud.ces.v1.Agent.RemoteDialogflowAgent remote_dialogflow_agent = 27 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type
Description

The remoteDialogflowAgent.

getRemoteDialogflowAgentOrBuilder()

  public 
  
 Agent 
 . 
 RemoteDialogflowAgentOrBuilder 
  
 getRemoteDialogflowAgentOrBuilder 
 () 
 

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 .

.google.cloud.ces.v1.Agent.RemoteDialogflowAgent remote_dialogflow_agent = 27 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type
Description

getSerializedSize()

  public 
  
 int 
  
 getSerializedSize 
 () 
 
Returns
Type
Description
int
Overrides

getTools(int index)

  public 
  
 String 
  
 getTools 
 ( 
 int 
  
 index 
 ) 
 

Optional. List of available tools for the agent. Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool}

repeated string tools = 7 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name
Description
index
int

The index of the element to return.

Returns
Type
Description

The tools at the given index.

getToolsBytes(int index)

  public 
  
 ByteString 
  
 getToolsBytes 
 ( 
 int 
  
 index 
 ) 
 

Optional. List of available tools for the agent. Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool}

repeated string tools = 7 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name
Description
index
int

The index of the value to return.

Returns
Type
Description

The bytes of the tools at the given index.

getToolsCount()

  public 
  
 int 
  
 getToolsCount 
 () 
 

Optional. List of available tools for the agent. Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool}

repeated string tools = 7 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type
Description
int

The count of tools.

getToolsList()

  public 
  
 ProtocolStringList 
  
 getToolsList 
 () 
 

Optional. List of available tools for the agent. Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool}

repeated string tools = 7 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type
Description

A list containing the tools.

getToolsets(int index)

  public 
  
 Agent 
 . 
 AgentToolset 
  
 getToolsets 
 ( 
 int 
  
 index 
 ) 
 

Optional. List of toolsets for the agent.

repeated .google.cloud.ces.v1.Agent.AgentToolset toolsets = 28 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name
Description
index
int
Returns
Type
Description

getToolsetsCount()

  public 
  
 int 
  
 getToolsetsCount 
 () 
 

Optional. List of toolsets for the agent.

repeated .google.cloud.ces.v1.Agent.AgentToolset toolsets = 28 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type
Description
int

getToolsetsList()

  public 
  
 List<Agent 
 . 
 AgentToolset 
>  
 getToolsetsList 
 () 
 

Optional. List of toolsets for the agent.

repeated .google.cloud.ces.v1.Agent.AgentToolset toolsets = 28 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type
Description

getToolsetsOrBuilder(int index)

  public 
  
 Agent 
 . 
 AgentToolsetOrBuilder 
  
 getToolsetsOrBuilder 
 ( 
 int 
  
 index 
 ) 
 

Optional. List of toolsets for the agent.

repeated .google.cloud.ces.v1.Agent.AgentToolset toolsets = 28 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name
Description
index
int
Returns
Type
Description

getToolsetsOrBuilderList()

  public 
  
 List 
< ? 
  
 extends 
  
 Agent 
 . 
 AgentToolsetOrBuilder 
>  
 getToolsetsOrBuilderList 
 () 
 

Optional. List of toolsets for the agent.

repeated .google.cloud.ces.v1.Agent.AgentToolset toolsets = 28 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type
Description
List < ? extends com.google.cloud.ces.v1.Agent.AgentToolsetOrBuilder >

getTransferRules(int index)

  public 
  
 TransferRule 
  
 getTransferRules 
 ( 
 int 
  
 index 
 ) 
 

Optional. Agent transfer rules. If multiple rules match, the first one in the list will be used.

repeated .google.cloud.ces.v1.TransferRule transfer_rules = 30 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name
Description
index
int
Returns
Type
Description

getTransferRulesCount()

  public 
  
 int 
  
 getTransferRulesCount 
 () 
 

Optional. Agent transfer rules. If multiple rules match, the first one in the list will be used.

repeated .google.cloud.ces.v1.TransferRule transfer_rules = 30 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type
Description
int

getTransferRulesList()

  public 
  
 List<TransferRule> 
  
 getTransferRulesList 
 () 
 

Optional. Agent transfer rules. If multiple rules match, the first one in the list will be used.

repeated .google.cloud.ces.v1.TransferRule transfer_rules = 30 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type
Description

getTransferRulesOrBuilder(int index)

  public 
  
 TransferRuleOrBuilder 
  
 getTransferRulesOrBuilder 
 ( 
 int 
  
 index 
 ) 
 

Optional. Agent transfer rules. If multiple rules match, the first one in the list will be used.

repeated .google.cloud.ces.v1.TransferRule transfer_rules = 30 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name
Description
index
int
Returns
Type
Description

getTransferRulesOrBuilderList()

  public 
  
 List 
< ? 
  
 extends 
  
 TransferRuleOrBuilder 
>  
 getTransferRulesOrBuilderList 
 () 
 

Optional. Agent transfer rules. If multiple rules match, the first one in the list will be used.

repeated .google.cloud.ces.v1.TransferRule transfer_rules = 30 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type
Description
List < ? extends com.google.cloud.ces.v1.TransferRuleOrBuilder >

getUpdateTime()

  public 
  
 Timestamp 
  
 getUpdateTime 
 () 
 

Output only. Timestamp when the agent was last updated.

.google.protobuf.Timestamp update_time = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type
Description

The updateTime.

getUpdateTimeOrBuilder()

  public 
  
 TimestampOrBuilder 
  
 getUpdateTimeOrBuilder 
 () 
 

Output only. Timestamp when the agent was last updated.

.google.protobuf.Timestamp update_time = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type
Description

hasCreateTime()

  public 
  
 boolean 
  
 hasCreateTime 
 () 
 

Output only. Timestamp when the agent was created.

.google.protobuf.Timestamp create_time = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type
Description

Whether the createTime field is set.

hasLlmAgent()

  public 
  
 boolean 
  
 hasLlmAgent 
 () 
 

Optional. The default agent type.

.google.cloud.ces.v1.Agent.LlmAgent llm_agent = 26 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type
Description

Whether the llmAgent field is set.

hasModelSettings()

  public 
  
 boolean 
  
 hasModelSettings 
 () 
 

Optional. Configurations for the LLM model.

.google.cloud.ces.v1.ModelSettings model_settings = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type
Description

Whether the modelSettings field is set.

hasRemoteDialogflowAgent()

  public 
  
 boolean 
  
 hasRemoteDialogflowAgent 
 () 
 

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 .

.google.cloud.ces.v1.Agent.RemoteDialogflowAgent remote_dialogflow_agent = 27 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type
Description

Whether the remoteDialogflowAgent field is set.

hasUpdateTime()

  public 
  
 boolean 
  
 hasUpdateTime 
 () 
 

Output only. Timestamp when the agent was last updated.

.google.protobuf.Timestamp update_time = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type
Description

Whether the updateTime field is set.

hashCode()

  public 
  
 int 
  
 hashCode 
 () 
 
Returns
Type
Description
int
Overrides

internalGetFieldAccessorTable()

  protected 
  
 GeneratedMessage 
 . 
 FieldAccessorTable 
  
 internalGetFieldAccessorTable 
 () 
 
Returns
Type
Description
Overrides

isInitialized()

  public 
  
 final 
  
 boolean 
  
 isInitialized 
 () 
 
Returns
Type
Description
Overrides

newBuilderForType()

  public 
  
 Agent 
 . 
 Builder 
  
 newBuilderForType 
 () 
 
Returns
Type
Description

newBuilderForType(AbstractMessage.BuilderParent parent)

  protected 
  
 Agent 
 . 
 Builder 
  
 newBuilderForType 
 ( 
 AbstractMessage 
 . 
 BuilderParent 
  
 parent 
 ) 
 
Parameter
Name
Description
parent
Returns
Type
Description
Overrides

toBuilder()

  public 
  
 Agent 
 . 
 Builder 
  
 toBuilder 
 () 
 
Returns
Type
Description

writeTo(CodedOutputStream output)

  public 
  
 void 
  
 writeTo 
 ( 
 CodedOutputStream 
  
 output 
 ) 
 
Parameter
Name
Description
Overrides
Exceptions
Type
Description
Create a Mobile Website
View Site in Mobile | Classic
Share by: