Class OpenAiApi.ChatCompletionRequest.ToolChoiceBuilder

java.lang.Object

org.springframework.ai.openai.api.OpenAiApi.ChatCompletionRequest.ToolChoiceBuilder

Enclosing class:

OpenAiApi.ChatCompletionRequest

public static class OpenAiApi.ChatCompletionRequest.ToolChoiceBuilder
extends Object

Helper factory that creates a tool_choice of type 'none', 'auto' or selected function by name.

Author:

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	AUTO	Model can pick between generating a message or calling a function.
static final String	NONE	Model will not call a function and instead generates a message

Constructor Summary

Constructors

Constructor	Description
ToolChoiceBuilder()

Method Summary

Modifier and Type	Method	Description
static Object	function(String functionName)	Specifying a particular function forces the model to call that function.

Methods inherited from class Object

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

Field Details

AUTO

public static final String AUTO

Model can pick between generating a message or calling a function.

See Also:

• Constant Field Values

NONE

public static final String NONE

Model will not call a function and instead generates a message

See Also:

• Constant Field Values

Constructor Details

ToolChoiceBuilder

public ToolChoiceBuilder()

Method Details

function

public static Object function(String functionName)

Specifying a particular function forces the model to call that function.