Package com.oracle.bmc.generativeaiinference.model

Class CohereTool

java.lang.Object

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

com.oracle.bmc.generativeaiinference.model.CohereTool

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

A definition of tool (function).
Note: Objects should always be created or deserialized using the CohereTool.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 CohereTool.Builder, which maintain a set of all explicitly set fields called CohereTool.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	CohereTool.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
CohereTool(String name, String description, Map<String,CohereParameterDefinition> parameterDefinitions)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static CohereTool.Builder	builder()	Create a new builder.
boolean	equals(Object o)
String	getDescription()	The description of what the tool does, the model uses the description to choose when and how to call the function.
String	getName()	The name of the tool to be called.
Map<String,CohereParameterDefinition>	getParameterDefinitions()	The input parameters of the tool.
int	hashCode()
CohereTool.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

CohereTool

@Deprecated
@ConstructorProperties({"name","description","parameterDefinitions"})
public CohereTool(String name,
                  String description,
                  Map<String,CohereParameterDefinition> parameterDefinitions)

Deprecated.

Method Detail

builder

public static CohereTool.Builder builder()

Create a new builder.

toBuilder

public CohereTool.Builder toBuilder()

getName

public String getName()

The name of the tool to be called.

Valid names contain only the characters a-z, A-Z, 0-9, _ and must not begin with a digit.

Returns:

the value

getDescription

public String getDescription()

The description of what the tool does, the model uses the description to choose when and how to call the function.

Returns:

the value

getParameterDefinitions

public Map<String,CohereParameterDefinition> getParameterDefinitions()

The input parameters of the tool.

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