public final class Agent extends GeneratedMessage implements AgentOrBuilderAn 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
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage > AgentImplements
AgentOrBuilderStatic 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 |
Agent |
|
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
newBuilder()
public static Agent.Builder newBuilder()| Returns | |
|---|---|
| Type | Description |
Agent.Builder |
|
newBuilder(Agent prototype)
public static Agent.Builder newBuilder(Agent prototype)| Parameter | |
|---|---|
| Name | Description |
prototype |
Agent |
| Returns | |
|---|---|
| Type | Description |
Agent.Builder |
|
parseDelimitedFrom(InputStream input)
public static Agent parseDelimitedFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
InputStream |
| Returns | |
|---|---|
| Type | Description |
Agent |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Agent parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Agent |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(byte[] data)
public static Agent parseFrom(byte[] data)| Parameter | |
|---|---|
| Name | Description |
data |
byte[] |
| Returns | |
|---|---|
| Type | Description |
Agent |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Agent parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
byte[] |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Agent |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteString data)
public static Agent parseFrom(ByteString data)| Parameter | |
|---|---|
| Name | Description |
data |
ByteString |
| Returns | |
|---|---|
| Type | Description |
Agent |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Agent parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
ByteString |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Agent |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(CodedInputStream input)
public static Agent parseFrom(CodedInputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
CodedInputStream |
| Returns | |
|---|---|
| Type | Description |
Agent |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Agent parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Agent |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(InputStream input)
public static Agent parseFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
InputStream |
| Returns | |
|---|---|
| Type | Description |
Agent |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Agent parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Agent |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(ByteBuffer data)
public static Agent parseFrom(ByteBuffer data)| Parameter | |
|---|---|
| Name | Description |
data |
ByteBuffer |
| Returns | |
|---|---|
| Type | Description |
Agent |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Agent parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
ByteBuffer |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Agent |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parser()
public static Parser<Agent> parser()| Returns | |
|---|---|
| Type | Description |
Parser<Agent> |
|
Methods
equals(Object obj)
public boolean equals(Object obj)| Parameter | |
|---|---|
| Name | Description |
obj |
Object |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
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 |
Callback |
|
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 |
List<Callback> |
|
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 |
CallbackOrBuilder |
|
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 |
Callback |
|
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 |
List<Callback> |
|
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 |
CallbackOrBuilder |
|
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 |
Callback |
|
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 |
List<Callback> |
|
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 |
CallbackOrBuilder |
|
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 |
Agent.AgentTypeCase |
|
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 |
Callback |
|
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 |
List<Callback> |
|
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 |
CallbackOrBuilder |
|
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 |
Callback |
|
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 |
List<Callback> |
|
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 |
CallbackOrBuilder |
|
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 |
Callback |
|
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 |
List<Callback> |
|
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 |
CallbackOrBuilder |
|
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 |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String |
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 |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString |
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 |
ProtocolStringList |
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 |
Timestamp |
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 |
TimestampOrBuilder |
|
getDefaultInstanceForType()
public Agent getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
Agent |
|
getDescription()
public String getDescription()Optional. Human-readable description of the agent.
string description = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The description. |
getDescriptionBytes()
public ByteString getDescriptionBytes()Optional. Human-readable description of the agent.
string description = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
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 |
String |
The displayName. |
getDisplayNameBytes()
public ByteString getDisplayNameBytes()Required. Display name of the agent.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
ByteString |
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 |
String |
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 |
ByteString |
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 |
String |
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 |
ByteString |
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 |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String |
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 |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString |
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 |
ProtocolStringList |
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 |
String |
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 |
ByteString |
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 |
Agent.LlmAgent |
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 |
Agent.LlmAgentOrBuilder |
|
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 |
ModelSettings |
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 |
ModelSettingsOrBuilder |
|
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 |
String |
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 |
ByteString |
The bytes for name. |
getParserForType()
public Parser<Agent> getParserForType()| Returns | |
|---|---|
| Type | Description |
Parser<Agent> |
|
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 |
Agent.RemoteDialogflowAgent |
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 |
Agent.RemoteDialogflowAgentOrBuilder |
|
getSerializedSize()
public int getSerializedSize()| Returns | |
|---|---|
| Type | Description |
int |
|
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 |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String |
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 |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString |
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 |
ProtocolStringList |
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 |
Agent.AgentToolset |
|
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 |
List<AgentToolset> |
|
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 |
Agent.AgentToolsetOrBuilder |
|
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 |
TransferRule |
|
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 |
List<TransferRule> |
|
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 |
TransferRuleOrBuilder |
|
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 |
Timestamp |
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 |
TimestampOrBuilder |
|
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 |
boolean |
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 |
boolean |
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 |
boolean |
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 |
boolean |
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 |
boolean |
Whether the updateTime field is set. |
hashCode()
public int hashCode()| Returns | |
|---|---|
| Type | Description |
int |
|
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
newBuilderForType()
public Agent.Builder newBuilderForType()| Returns | |
|---|---|
| Type | Description |
Agent.Builder |
|
newBuilderForType(AbstractMessage.BuilderParent parent)
protected Agent.Builder newBuilderForType(AbstractMessage.BuilderParent parent)| Parameter | |
|---|---|
| Name | Description |
parent |
BuilderParent |
| Returns | |
|---|---|
| Type | Description |
Agent.Builder |
|
toBuilder()
public Agent.Builder toBuilder()| Returns | |
|---|---|
| Type | Description |
Agent.Builder |
|
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)| Parameter | |
|---|---|
| Name | Description |
output |
CodedOutputStream |
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|