@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).
| Modifier and Type | Class and Description |
|---|---|
static class |
FunctionDefinition.Builder |
ToolDefinition.TypeEXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME| Constructor and Description |
|---|
FunctionDefinition(String name,
String description,
Object parameters)
Deprecated.
|
| Modifier and Type | Method and 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.
|
markPropertyAsExplicitlySet, wasPropertyExplicitlySet@Deprecated public FunctionDefinition(String name, String description, Object parameters)
public static FunctionDefinition.Builder builder()
Create a new builder.
public FunctionDefinition.Builder toBuilder()
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.
public String getDescription()
A description of what the function does, used by the model to choose when and how to call the function.
public Object getParameters()
The parameters the functions accepts, described as a JSON Schema object. Omitting parameters defines a function with an empty parameter list.
public String toString()
toString in class ToolDefinitionpublic String toString(boolean includeByteArrayContents)
Return a string representation of the object.
toString in class ToolDefinitionincludeByteArrayContents - true to include the full contents of byte arrayspublic boolean equals(Object o)
equals in class ToolDefinitionpublic int hashCode()
hashCode in class ToolDefinitionCopyright © 2016–2025. All rights reserved.