Package com.microsoft.semantickernel.aiservices.openai.chatcompletion

Class OpenAIFunctionToolCall

java.lang.Object

com.microsoft.semantickernel.aiservices.openai.chatcompletion.OpenAIFunctionToolCall

public class OpenAIFunctionToolCall
extends Object

Represents a call to a function in the OpenAI tool.

Constructor Summary

Constructors

Constructor	Description
OpenAIFunctionToolCall(String id, String pluginName, String functionName, KernelFunctionArguments arguments)	Creates a new instance of the OpenAIFunctionToolCall class.

Method Summary

Modifier and Type	Method	Description
KernelFunctionArguments	getArguments()	Gets a name/value collection of the arguments to the function, if any.
String	getFunctionName()	Gets the name of the function.
String	getId()	Gets the ID of the tool call.
String	getPluginName()	Gets the name of the plugin with which this function is associated, if any.

Methods inherited from class java.lang.Object

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

Constructor Detail

OpenAIFunctionToolCall

public OpenAIFunctionToolCall(@Nullable
                              String id,
                              @Nullable
                              String pluginName,
                              String functionName,
                              @Nullable
                              KernelFunctionArguments arguments)

Creates a new instance of the OpenAIFunctionToolCall class.

Parameters:

id - The ID of the tool call.

pluginName - The name of the plugin with which this function is associated, if any.

functionName - The name of the function.

arguments - A name/value collection of the arguments to the function, if any.

Method Detail

getId

@Nullable
public String getId()

Gets the ID of the tool call.

Returns:

The ID of the tool call.

getPluginName

@Nullable
public String getPluginName()

Gets the name of the plugin with which this function is associated, if any.

Returns:

The name of the plugin with which this function is associated, if any.

getFunctionName

public String getFunctionName()

Gets the name of the function.

Returns:

The name of the function.

getArguments

@Nullable
public KernelFunctionArguments getArguments()

Gets a name/value collection of the arguments to the function, if any.

Returns:

A name/value collection of the arguments to the function, if any.