Package com.azure.ai.openai.models

Class ChatCompletionsToolSelection

java.lang.Object

com.azure.ai.openai.models.ChatCompletionsToolSelection

public final class ChatCompletionsToolSelection
extends Object

Represents the tool selection for chat completions. The input can be either an enum value from ChatCompletionsToolSelectionPreset or a named tool selection passed in the form of ChatCompletionsNamedToolSelection.

Constructor Summary

Constructors

Constructor	Description
ChatCompletionsToolSelection(ChatCompletionsNamedToolSelection namedToolSelection)	Creates a ChatCompletionsToolSelection with the provided named tool selection.
ChatCompletionsToolSelection(ChatCompletionsToolSelectionPreset preset)	Creates a ChatCompletionsToolSelection with the provided preset.

Method Summary

Modifier and Type	Method	Description
static ChatCompletionsToolSelection	fromBinaryData(com.azure.core.util.BinaryData chatCompletionsToolSelectionJson)	Converts a JSON string to a ChatCompletionsToolSelection.
ChatCompletionsNamedToolSelection	getNamedToolSelection()	Gets the named tool selection.
ChatCompletionsToolSelectionPreset	getPreset()	Gets the preset tool selection.

Methods inherited from class java.lang.Object

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

Constructor Details

ChatCompletionsToolSelection

public ChatCompletionsToolSelection(ChatCompletionsToolSelectionPreset preset)

Creates a ChatCompletionsToolSelection with the provided preset.

Parameters:

preset - The preset tool selection.

ChatCompletionsToolSelection

public ChatCompletionsToolSelection(ChatCompletionsNamedToolSelection namedToolSelection)

Creates a ChatCompletionsToolSelection with the provided named tool selection.

Parameters:

namedToolSelection - The named tool selection.

Method Details

getPreset

public ChatCompletionsToolSelectionPreset getPreset()

Gets the preset tool selection.

Returns:

The preset tool selection.

getNamedToolSelection

public ChatCompletionsNamedToolSelection getNamedToolSelection()

Gets the named tool selection.

Returns:

The named tool selection.

fromBinaryData

public static ChatCompletionsToolSelection fromBinaryData(com.azure.core.util.BinaryData chatCompletionsToolSelectionJson)

Converts a JSON string to a ChatCompletionsToolSelection.

Parameters:

chatCompletionsToolSelectionJson - The JSON string representing the chat completions tool selection.

Returns:

The ChatCompletionsToolSelection represented by the provided JSON string.

Throws:

IllegalArgumentException - If the provided JSON string does not match the expected format.