Package com.oracle.bmc.generativeaiagent.model

Class CreateAgentEndpointDetails

java.lang.Object

com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

com.oracle.bmc.generativeaiagent.model.CreateAgentEndpointDetails

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20240531")
public final class CreateAgentEndpointDetails
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

The data to create an endpoint.
Note: Objects should always be created or deserialized using the CreateAgentEndpointDetails.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the CreateAgentEndpointDetails.Builder, which maintain a set of all explicitly set fields called CreateAgentEndpointDetails.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CreateAgentEndpointDetails.Builder

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors

Constructor

Description

CreateAgentEndpointDetails(String displayName, String description, String agentId, ContentModerationConfig contentModerationConfig, GuardrailConfig guardrailConfig, Map<String,String> metadata, HumanInputConfig humanInputConfig, OutputConfig outputConfig, Boolean shouldEnableTrace, Boolean shouldEnableCitation, Boolean shouldEnableSession, Boolean shouldEnableMultiLanguage, SessionConfig sessionConfig, String compartmentId, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags)

Deprecated.

Method Summary

Modifier and Type	Method	Description
static CreateAgentEndpointDetails.Builder	builder()	Create a new builder.
boolean	equals(Object o)
String	getAgentId()	The OCID of the agent that this endpoint is associated with.
String	getCompartmentId()	The OCID of the compartment to create the endpoint in.
ContentModerationConfig	getContentModerationConfig()
Map<String,Map<String,Object>>	getDefinedTags()	Defined tags for this resource.
String	getDescription()	An optional description of the endpoint.
String	getDisplayName()	A user-friendly name.
Map<String,String>	getFreeformTags()	Free-form tags for this resource.
GuardrailConfig	getGuardrailConfig()
HumanInputConfig	getHumanInputConfig()
Map<String,String>	getMetadata()	Key-value pairs to allow additional configurations.
OutputConfig	getOutputConfig()
SessionConfig	getSessionConfig()
Boolean	getShouldEnableCitation()	Whether to show citations in the chat result.
Boolean	getShouldEnableMultiLanguage()	Whether to enable multi-language for chat.
Boolean	getShouldEnableSession()	Whether or not to enable Session-based chat.
Boolean	getShouldEnableTrace()	Whether to show traces in the chat result.
int	hashCode()
CreateAgentEndpointDetails.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents)	Return a string representation of the object.

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateAgentEndpointDetails

@Deprecated
@ConstructorProperties({"displayName","description","agentId","contentModerationConfig","guardrailConfig","metadata","humanInputConfig","outputConfig","shouldEnableTrace","shouldEnableCitation","shouldEnableSession","shouldEnableMultiLanguage","sessionConfig","compartmentId","freeformTags","definedTags"})
public CreateAgentEndpointDetails(String displayName,
                                  String description,
                                  String agentId,
                                  ContentModerationConfig contentModerationConfig,
                                  GuardrailConfig guardrailConfig,
                                  Map<String,String> metadata,
                                  HumanInputConfig humanInputConfig,
                                  OutputConfig outputConfig,
                                  Boolean shouldEnableTrace,
                                  Boolean shouldEnableCitation,
                                  Boolean shouldEnableSession,
                                  Boolean shouldEnableMultiLanguage,
                                  SessionConfig sessionConfig,
                                  String compartmentId,
                                  Map<String,String> freeformTags,
                                  Map<String,Map<String,Object>> definedTags)

Deprecated.

Method Detail

builder

public static CreateAgentEndpointDetails.Builder builder()

Create a new builder.

toBuilder

public CreateAgentEndpointDetails.Builder toBuilder()

getDisplayName

public String getDisplayName()

A user-friendly name.

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

Returns:

the value

getDescription

public String getDescription()

An optional description of the endpoint.

Returns:

the value

getAgentId

public String getAgentId()

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

Returns:

the value

getContentModerationConfig

public ContentModerationConfig getContentModerationConfig()

getGuardrailConfig

public GuardrailConfig getGuardrailConfig()

getMetadata

public Map<String,String> getMetadata()

Key-value pairs to allow additional configurations.

Returns:

the value

getHumanInputConfig

public HumanInputConfig getHumanInputConfig()

getOutputConfig

public OutputConfig getOutputConfig()

getShouldEnableTrace

public Boolean getShouldEnableTrace()

Whether to show traces in the chat result.

Returns:

the value

getShouldEnableCitation

public Boolean getShouldEnableCitation()

Whether to show citations in the chat result.

Returns:

the value

getShouldEnableSession

public Boolean getShouldEnableSession()

Whether or not to enable Session-based chat.

Returns:

the value

getShouldEnableMultiLanguage

public Boolean getShouldEnableMultiLanguage()

Whether to enable multi-language for chat.

Returns:

the value

getSessionConfig

public SessionConfig getSessionConfig()

getCompartmentId

public String getCompartmentId()

The OCID of the compartment to create the endpoint in.

Returns:

the value

getFreeformTags

public Map<String,String> getFreeformTags()

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"}

Returns:

the value

getDefinedTags

public Map<String,Map<String,Object>> getDefinedTags()

Defined tags for this resource.

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

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

Returns:

the value

toString

public String toString()

Overrides:

toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

hashCode

public int hashCode()

Overrides:

hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel