Package org.springframework.ai.openai.api

Class OpenAiApi.FunctionTool.Function

java.lang.Object

org.springframework.ai.openai.api.OpenAiApi.FunctionTool.Function

Enclosing class:

OpenAiApi.FunctionTool

public static class OpenAiApi.FunctionTool.Function
extends Object

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, Boolean strict)	Create tool function definition.

Method Summary

Modifier and Type	Method	Description
String	getDescription()
String	getJsonSchema()
String	getName()
Map<String,Object>	getParameters()
Boolean	getStrict()
void	setDescription(String description)
void	setJsonSchema(String jsonSchema)
void	setName(String name)
void	setParameters(Map<String,Object> parameters)
void	setStrict(Boolean strict)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Function

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

Create tool function definition.

Parameters:

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": {}}.

strict - Whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true.

Function

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.

Method Details

getDescription

public String getDescription()

getName

public String getName()

getParameters

public Map<String,Object> getParameters()

setDescription

public void setDescription(String description)

setName

public void setName(String name)

setParameters

public void setParameters(Map<String,Object> parameters)

getStrict

public Boolean getStrict()

setStrict

public void setStrict(Boolean strict)

getJsonSchema

public String getJsonSchema()

setJsonSchema

public void setJsonSchema(String jsonSchema)