Package com.oracle.bmc.generativeaiinference.model

Class FunctionDefinition

java.lang.Object

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

com.oracle.bmc.generativeaiinference.model.ToolDefinition

com.oracle.bmc.generativeaiinference.model.FunctionDefinition

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20231130")
public final class FunctionDefinition
extends ToolDefinition

A function the model may call.
Note: Objects should always be created or deserialized using the FunctionDefinition.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 FunctionDefinition.Builder, which maintain a set of all explicitly set fields called FunctionDefinition.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	FunctionDefinition.Builder

Nested classes/interfaces inherited from class com.oracle.bmc.generativeaiinference.model.ToolDefinition

ToolDefinition.Type

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
FunctionDefinition(String name, String description, Object parameters)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static FunctionDefinition.Builder	builder()	Create a new builder.
boolean	equals(Object o)
String	getDescription()	A description of what the function does, used by the model to choose when and how to call the function.
String	getName()	The name of the function to be called.
Object	getParameters()	The parameters the functions accepts, described as a JSON Schema object.
int	hashCode()
FunctionDefinition.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

FunctionDefinition

@Deprecated
public FunctionDefinition(String name,
                          String description,
                          Object parameters)

Deprecated.

Method Detail

builder

public static FunctionDefinition.Builder builder()

Create a new builder.

toBuilder

public FunctionDefinition.Builder toBuilder()

getName

public String getName()

The name of the function to be called.

Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.

Returns:

the value

getDescription

public String getDescription()

A description of what the function does, used by the model to choose when and how to call the function.

Returns:

the value

getParameters

public Object getParameters()

The parameters the functions accepts, described as a JSON Schema object.

Omitting parameters defines a function with an empty parameter list.

Returns:

the value

toString

public String toString()

Overrides:

toString in class ToolDefinition

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Overrides:

toString in class ToolDefinition

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class ToolDefinition

hashCode

public int hashCode()

Overrides:

hashCode in class ToolDefinition