Package org.springframework.ai.mistralai.api

Record Class MistralAiApi.FunctionTool.Function

java.lang.Object

java.lang.Record

org.springframework.ai.mistralai.api.MistralAiApi.FunctionTool.Function

Record Components:

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

name - 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.

parameters - The parameters the functions accepts, described as a JSON Schema object. To describe a function that accepts no parameters, provide the value {"type": "object", "properties": {}}.

Enclosing class:

MistralAiApi.FunctionTool

public static record MistralAiApi.FunctionTool.Function(String description, String name, Map<String,Object> parameters)
extends Record

Function definition.

Constructor Summary

Constructors

Constructor	Description
Function(String description, String name, String jsonSchema)	Create tool function definition.
Function(String description, String name, Map<String,Object> parameters)	Creates an instance of a Function record class.

Method Summary

Modifier and Type	Method	Description
String	description()	Returns the value of the description record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
String	name()	Returns the value of the name record component.
Map<String,Object>	parameters()	Returns the value of the parameters record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

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

Constructor Details

Function

@ConstructorBinding
public Function(String description,
 String name,
 String jsonSchema)

Create tool function definition.

Parameters:

description - tool function description.

name - tool function name.

jsonSchema - tool function schema as json.

Function

public Function(String description,
 String name,
 Map<String,Object> parameters)

Creates an instance of a Function record class.

Parameters:

description - the value for the description record component

name - the value for the name record component

parameters - the value for the parameters record component

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

description

public String description()

Returns the value of the description record component.

Returns:

the value of the description record component

name

public String name()

Returns the value of the name record component.

Returns:

the value of the name record component

parameters

public Map<String,Object> parameters()

Returns the value of the parameters record component.

Returns:

the value of the parameters record component