Package io.github.stefanbratanov.jvm.openai

Interface Tool

All Known Implementing Classes:

Tool.CodeInterpreterTool, Tool.FileSearchTool, Tool.FunctionTool

public sealed interface Tool
permits Tool.CodeInterpreterTool, Tool.FileSearchTool, Tool.FunctionTool

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final record	Tool.CodeInterpreterTool
static final record	Tool.FileSearchTool
static final record	Tool.FunctionTool

Method Summary

Modifier and Type	Method	Description
static Tool.CodeInterpreterTool	codeInterpreterTool()
static Tool.FileSearchTool	fileSearchTool()
static Tool.FileSearchTool	fileSearchTool(int maxNumResults)
static Tool.FileSearchTool	fileSearchTool(int maxNumResults, Tool.FileSearchTool.FileSearch.RankingOptions rankingOptions)
static Tool.FunctionTool	functionTool(Function function)
String	type()

Method Details

type

String type()

codeInterpreterTool

static Tool.CodeInterpreterTool codeInterpreterTool()

fileSearchTool

static Tool.FileSearchTool fileSearchTool()

fileSearchTool

static Tool.FileSearchTool fileSearchTool(int maxNumResults)

Parameters:

maxNumResults - The maximum number of results the file search tool should output.

fileSearchTool

static Tool.FileSearchTool fileSearchTool(int maxNumResults,
 Tool.FileSearchTool.FileSearch.RankingOptions rankingOptions)

Parameters:

maxNumResults - The maximum number of results the file search tool should output.

rankingOptions - The score threshold for the file search. All values must be a floating point number between 0 and 1.

functionTool

static Tool.FunctionTool functionTool(Function function)