Package com.oracle.bmc.generativeaiagent.model

Class CreateAgentEndpointDetails.Builder

java.lang.Object

com.oracle.bmc.generativeaiagent.model.CreateAgentEndpointDetails.Builder

Enclosing class:

CreateAgentEndpointDetails

public static class CreateAgentEndpointDetails.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CreateAgentEndpointDetails.Builder	agentId(String agentId)	The OCID of the agent that this endpoint is associated with.
CreateAgentEndpointDetails	build()
CreateAgentEndpointDetails.Builder	compartmentId(String compartmentId)	The OCID of the compartment to create the endpoint in.
CreateAgentEndpointDetails.Builder	contentModerationConfig(ContentModerationConfig contentModerationConfig)
CreateAgentEndpointDetails.Builder	copy(CreateAgentEndpointDetails model)
CreateAgentEndpointDetails.Builder	definedTags(Map<String,Map<String,Object>> definedTags)	Defined tags for this resource.
CreateAgentEndpointDetails.Builder	description(String description)	An optional description of the endpoint.
CreateAgentEndpointDetails.Builder	displayName(String displayName)	A user-friendly name.
CreateAgentEndpointDetails.Builder	freeformTags(Map<String,String> freeformTags)	Free-form tags for this resource.
CreateAgentEndpointDetails.Builder	guardrailConfig(GuardrailConfig guardrailConfig)
CreateAgentEndpointDetails.Builder	humanInputConfig(HumanInputConfig humanInputConfig)
CreateAgentEndpointDetails.Builder	metadata(Map<String,String> metadata)	Key-value pairs to allow additional configurations.
CreateAgentEndpointDetails.Builder	outputConfig(OutputConfig outputConfig)
CreateAgentEndpointDetails.Builder	sessionConfig(SessionConfig sessionConfig)
CreateAgentEndpointDetails.Builder	shouldEnableCitation(Boolean shouldEnableCitation)	Whether to show citations in the chat result.
CreateAgentEndpointDetails.Builder	shouldEnableMultiLanguage(Boolean shouldEnableMultiLanguage)	Whether to enable multi-language for chat.
CreateAgentEndpointDetails.Builder	shouldEnableSession(Boolean shouldEnableSession)	Whether or not to enable Session-based chat.
CreateAgentEndpointDetails.Builder	shouldEnableTrace(Boolean shouldEnableTrace)	Whether to show traces in the chat result.

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

displayName

public CreateAgentEndpointDetails.Builder displayName(String displayName)

A user-friendly name.

Does not have to be unique, and it’s changeable. Avoid entering confidential information.

Parameters:

displayName - the value to set

Returns:

this builder

description

public CreateAgentEndpointDetails.Builder description(String description)

An optional description of the endpoint.

Parameters:

description - the value to set

Returns:

this builder

agentId

public CreateAgentEndpointDetails.Builder agentId(String agentId)

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

Parameters:

agentId - the value to set

Returns:

this builder

contentModerationConfig

public CreateAgentEndpointDetails.Builder contentModerationConfig(ContentModerationConfig contentModerationConfig)

guardrailConfig

public CreateAgentEndpointDetails.Builder guardrailConfig(GuardrailConfig guardrailConfig)

metadata

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

Key-value pairs to allow additional configurations.

Parameters:

metadata - the value to set

Returns:

this builder

humanInputConfig

public CreateAgentEndpointDetails.Builder humanInputConfig(HumanInputConfig humanInputConfig)

outputConfig

public CreateAgentEndpointDetails.Builder outputConfig(OutputConfig outputConfig)

shouldEnableTrace

public CreateAgentEndpointDetails.Builder shouldEnableTrace(Boolean shouldEnableTrace)

Whether to show traces in the chat result.

Parameters:

shouldEnableTrace - the value to set

Returns:

this builder

shouldEnableCitation

public CreateAgentEndpointDetails.Builder shouldEnableCitation(Boolean shouldEnableCitation)

Whether to show citations in the chat result.

Parameters:

shouldEnableCitation - the value to set

Returns:

this builder

shouldEnableSession

public CreateAgentEndpointDetails.Builder shouldEnableSession(Boolean shouldEnableSession)

Whether or not to enable Session-based chat.

Parameters:

shouldEnableSession - the value to set

Returns:

this builder

shouldEnableMultiLanguage

public CreateAgentEndpointDetails.Builder shouldEnableMultiLanguage(Boolean shouldEnableMultiLanguage)

Whether to enable multi-language for chat.

Parameters:

shouldEnableMultiLanguage - the value to set

Returns:

this builder

sessionConfig

public CreateAgentEndpointDetails.Builder sessionConfig(SessionConfig sessionConfig)

compartmentId

public CreateAgentEndpointDetails.Builder compartmentId(String compartmentId)

The OCID of the compartment to create the endpoint in.

Parameters:

compartmentId - the value to set

Returns:

this builder

freeformTags

public CreateAgentEndpointDetails.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 CreateAgentEndpointDetails.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

build

public CreateAgentEndpointDetails build()

copy

public CreateAgentEndpointDetails.Builder copy(CreateAgentEndpointDetails model)