Class OpenAiApi.FunctionTool

java.lang.Object

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

Enclosing class:

OpenAiApi

public static class OpenAiApi.FunctionTool
extends Object

Represents a tool the model may call. Currently, only functions are supported as a tool.

Author:

Christian Tzolov, Michael Lavelle, Mariusz Bernacki, Thomas Vitale, David Frizelle, Alexandros Pappas, Filip Hrisafov

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OpenAiApi.FunctionTool.Function	Function definition.
static enum	OpenAiApi.FunctionTool.Type	Create a tool of type 'function' and the given function definition.

Constructor Summary

Constructors

Constructor	Description
FunctionTool()
FunctionTool(OpenAiApi.FunctionTool.Function function)	Create a tool of type 'function' and the given function definition.
FunctionTool(OpenAiApi.FunctionTool.Type type, OpenAiApi.FunctionTool.Function function)	Create a tool of type 'function' and the given function definition.

Method Summary

Modifier and Type	Method	Description
OpenAiApi.FunctionTool.Function	getFunction()
OpenAiApi.FunctionTool.Type	getType()
void	setFunction(OpenAiApi.FunctionTool.Function function)
void	setType(OpenAiApi.FunctionTool.Type type)

Methods inherited from class Object

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

Constructor Details

FunctionTool

public FunctionTool()

FunctionTool

public FunctionTool(OpenAiApi.FunctionTool.Type type,
 OpenAiApi.FunctionTool.Function function)

Create a tool of type 'function' and the given function definition.

Parameters:

type - the tool type

function - function definition

FunctionTool

public FunctionTool(OpenAiApi.FunctionTool.Function function)

Create a tool of type 'function' and the given function definition.

Parameters:

function - function definition.

Method Details

getType

public OpenAiApi.FunctionTool.Type getType()

getFunction

public OpenAiApi.FunctionTool.Function getFunction()

setType

public void setType(OpenAiApi.FunctionTool.Type type)

setFunction

public void setFunction(OpenAiApi.FunctionTool.Function function)