Package com.oracle.bmc.generativeaiagent.model

Class AgentEndpointSummary.Builder

java.lang.Object

com.oracle.bmc.generativeaiagent.model.AgentEndpointSummary.Builder

Enclosing class:

AgentEndpointSummary

public static class AgentEndpointSummary.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
AgentEndpointSummary.Builder	agentId(String agentId)	The OCID of the agent that this AgentEndpoint is associated with.
AgentEndpointSummary	build()
AgentEndpointSummary.Builder	compartmentId(String compartmentId)	The OCID of the compartment.
AgentEndpointSummary.Builder	contentModerationConfig(ContentModerationConfig contentModerationConfig)
AgentEndpointSummary.Builder	copy(AgentEndpointSummary model)
AgentEndpointSummary.Builder	definedTags(Map<String,Map<String,Object>> definedTags)	Defined tags for this resource.
AgentEndpointSummary.Builder	description(String description)	An optional description of the endpoint.
AgentEndpointSummary.Builder	displayName(String displayName)	A user-friendly name.
AgentEndpointSummary.Builder	freeformTags(Map<String,String> freeformTags)	Free-form tags for this resource.
AgentEndpointSummary.Builder	guardrailConfig(GuardrailConfig guardrailConfig)
AgentEndpointSummary.Builder	humanInputConfig(HumanInputConfig humanInputConfig)
AgentEndpointSummary.Builder	id(String id)	The OCID of the AgentEndpoint.
AgentEndpointSummary.Builder	lifecycleDetails(String lifecycleDetails)	A message that describes the current state of the endpoint in more detail.
AgentEndpointSummary.Builder	lifecycleState(AgentEndpoint.LifecycleState lifecycleState)	The current state of the endpoint.
AgentEndpointSummary.Builder	metadata(Map<String,String> metadata)	Key-value pairs to allow additional configurations.
AgentEndpointSummary.Builder	outputConfig(OutputConfig outputConfig)
AgentEndpointSummary.Builder	sessionConfig(SessionConfig sessionConfig)
AgentEndpointSummary.Builder	shouldEnableCitation(Boolean shouldEnableCitation)	Whether to show citations in the chat result.
AgentEndpointSummary.Builder	shouldEnableMultiLanguage(Boolean shouldEnableMultiLanguage)	Whether to enable multi-language for chat.
AgentEndpointSummary.Builder	shouldEnableSession(Boolean shouldEnableSession)	Whether or not to enable Session-based chat.
AgentEndpointSummary.Builder	shouldEnableTrace(Boolean shouldEnableTrace)	Whether to show traces in the chat result.
AgentEndpointSummary.Builder	systemTags(Map<String,Map<String,Object>> systemTags)	System tags for this resource.
AgentEndpointSummary.Builder	timeCreated(Date timeCreated)	The date and time the endpoint was created, in the format defined by RFC 3339.
AgentEndpointSummary.Builder	timeUpdated(Date timeUpdated)	The date and time the AgentEndpoint was updated, in the format defined by RFC 3339.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

id

public AgentEndpointSummary.Builder id(String id)

The OCID of the AgentEndpoint.

Parameters:

id - the value to set

Returns:

this builder

displayName

public AgentEndpointSummary.Builder displayName(String displayName)

A user-friendly name.

Does not have to be unique, and it’s changeable.

Parameters:

displayName - the value to set

Returns:

this builder

description

public AgentEndpointSummary.Builder description(String description)

An optional description of the endpoint.

Parameters:

description - the value to set

Returns:

this builder

compartmentId

public AgentEndpointSummary.Builder compartmentId(String compartmentId)

The OCID of the compartment.

Parameters:

compartmentId - the value to set

Returns:

this builder

agentId

public AgentEndpointSummary.Builder agentId(String agentId)

The OCID of the agent that this AgentEndpoint is associated with.

Parameters:

agentId - the value to set

Returns:

this builder

contentModerationConfig

public AgentEndpointSummary.Builder contentModerationConfig(ContentModerationConfig contentModerationConfig)

guardrailConfig

public AgentEndpointSummary.Builder guardrailConfig(GuardrailConfig guardrailConfig)

metadata

public AgentEndpointSummary.Builder metadata(Map<String,String> metadata)

Key-value pairs to allow additional configurations.

Parameters:

metadata - the value to set

Returns:

this builder

humanInputConfig

public AgentEndpointSummary.Builder humanInputConfig(HumanInputConfig humanInputConfig)

outputConfig

public AgentEndpointSummary.Builder outputConfig(OutputConfig outputConfig)

shouldEnableTrace

public AgentEndpointSummary.Builder shouldEnableTrace(Boolean shouldEnableTrace)

Whether to show traces in the chat result.

Parameters:

shouldEnableTrace - the value to set

Returns:

this builder

shouldEnableCitation

public AgentEndpointSummary.Builder shouldEnableCitation(Boolean shouldEnableCitation)

Whether to show citations in the chat result.

Parameters:

shouldEnableCitation - the value to set

Returns:

this builder

shouldEnableSession

public AgentEndpointSummary.Builder shouldEnableSession(Boolean shouldEnableSession)

Whether or not to enable Session-based chat.

Parameters:

shouldEnableSession - the value to set

Returns:

this builder

shouldEnableMultiLanguage

public AgentEndpointSummary.Builder shouldEnableMultiLanguage(Boolean shouldEnableMultiLanguage)

Whether to enable multi-language for chat.

Parameters:

shouldEnableMultiLanguage - the value to set

Returns:

this builder

sessionConfig

public AgentEndpointSummary.Builder sessionConfig(SessionConfig sessionConfig)

timeCreated

public AgentEndpointSummary.Builder timeCreated(Date timeCreated)

The date and time the endpoint was created, in the format defined by RFC 3339.

Example: 2016-08-25T21:10:29.600Z

Parameters:

timeCreated - the value to set

Returns:

this builder

timeUpdated

public AgentEndpointSummary.Builder timeUpdated(Date timeUpdated)

The date and time the AgentEndpoint was updated, in the format defined by RFC 3339.

Example: 2016-08-25T21:10:29.600Z

Parameters:

timeUpdated - the value to set

Returns:

this builder

lifecycleState

public AgentEndpointSummary.Builder lifecycleState(AgentEndpoint.LifecycleState lifecycleState)

The current state of the endpoint.

Parameters:

lifecycleState - the value to set

Returns:

this builder

lifecycleDetails

public AgentEndpointSummary.Builder lifecycleDetails(String lifecycleDetails)

A message that describes the current state of the endpoint in more detail.

For example, can be used to provide actionable information for a resource in the Failed state.

Parameters:

lifecycleDetails - the value to set

Returns:

this builder

freeformTags

public AgentEndpointSummary.Builder freeformTags(Map<String,String> freeformTags)

Free-form tags for this resource.

Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

Example: {"Department": "Finance"}

Parameters:

freeformTags - the value to set

Returns:

this builder

definedTags

public AgentEndpointSummary.Builder definedTags(Map<String,Map<String,Object>> definedTags)

Defined tags for this resource.

Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {"Operations": {"CostCenter": "42"}}

Parameters:

definedTags - the value to set

Returns:

this builder

systemTags

public AgentEndpointSummary.Builder systemTags(Map<String,Map<String,Object>> systemTags)

System tags for this resource.

Each key is predefined and scoped to a namespace.

Example: {"orcl-cloud": {"free-tier-retained": "true"}}

Parameters:

systemTags - the value to set

Returns:

this builder

build

public AgentEndpointSummary build()

copy

public AgentEndpointSummary.Builder copy(AgentEndpointSummary model)