Package com.oracle.bmc.generativeaiagent.model

Class Function

java.lang.Object

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

com.oracle.bmc.generativeaiagent.model.Function

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

Details of Function for Function calling tool.
Note: Objects should always be created or deserialized using the Function.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 Function.Builder, which maintain a set of all explicitly set fields called Function.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	Function.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
Function(String name, String description, Map<String,String> parameters)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static Function.Builder	builder()	Create a new builder.
boolean	equals(Object o)
String	getDescription()	A description of the function.
String	getName()	The name of the function to invoke.
Map<String,String>	getParameters()	The parameters the function accepts, defined using a JSON Schema object.
int	hashCode()
Function.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

Function

@Deprecated
@ConstructorProperties({"name","description","parameters"})
public Function(String name,
                String description,
                Map<String,String> parameters)

Deprecated.

Method Detail

builder

public static Function.Builder builder()

Create a new builder.

toBuilder

public Function.Builder toBuilder()

getName

public String getName()

The name of the function to invoke.

Returns:

the value

getDescription

public String getDescription()

A description of the function.

Returns:

the value

getParameters

public Map<String,String> getParameters()

The parameters the function accepts, defined using a JSON Schema object.

Refer to the guide for examples and the JSON Schema documentation for details on the format.

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