Package bg.codexio.ai.openai.api.sdk.chat

Class ToolStage

java.lang.Object

bg.codexio.ai.openai.api.sdk.chat.ChatConfigurationStage

bg.codexio.ai.openai.api.sdk.chat.ToolStage

public class ToolStage
extends ChatConfigurationStage

Configures tools such as functions.

Field Summary

Fields inherited from class bg.codexio.ai.openai.api.sdk.chat.ChatConfigurationStage

executor, requestBuilder

Method Summary

Modifier and Type	Method	Description
ManualConfigurationStage	and()	Go back
ToolStage	chooseTool(bg.codexio.ai.openai.api.payload.chat.request.ChatTool tool)	Adds a tool and set it as toolChoice.
ToolStage	justAdd(bg.codexio.ai.openai.api.payload.chat.request.ChatTool tool)	Adds a tool.
ToolStage	withTool(bg.codexio.ai.openai.api.payload.chat.request.ChatTool tool, boolean shouldChoose)	Adds a tool and set it as toolChoice if true.

Methods inherited from class java.lang.Object

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

Method Detail

withTool

public ToolStage withTool(bg.codexio.ai.openai.api.payload.chat.request.ChatTool tool,
                          boolean shouldChoose)

Adds a tool and set it as toolChoice if true.

Parameters:

tool - ChatTool such as GetNearbyPlaces.CHOICE

shouldChoose - boolean whether to add it in toolChoice

Returns:

self

chooseTool

public ToolStage chooseTool(bg.codexio.ai.openai.api.payload.chat.request.ChatTool tool)

Adds a tool and set it as toolChoice.

Parameters:

tool - ChatTool such as GetNearbyPlaces.CHOICE

Returns:

self

justAdd

public ToolStage justAdd(bg.codexio.ai.openai.api.payload.chat.request.ChatTool tool)

Adds a tool.

Parameters:

tool - ChatTool such as GetNearbyPlaces.CHOICE

Returns:

self

and

public ManualConfigurationStage and()

Go back

Returns:

ManualConfigurationStage