Class ToolCall

Namespace

OpenAI

Assembly

OpenAI-DotNet.dll

public sealed class ToolCall

Inheritance

object

ToolCall

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

ToolCall()

public ToolCall()

ToolCall(string, string, JsonNode)

public ToolCall(string toolCallId, string functionName, JsonNode functionArguments = null)

Parameters

toolCallId string

functionName string

functionArguments JsonNode

Properties

Function

[JsonInclude]
[JsonPropertyName("function")]
public Function Function { get; }

Property Value

Function

Id

[JsonInclude]
[JsonPropertyName("id")]
public string Id { get; }

Property Value

string

Index

[JsonInclude]
[JsonPropertyName("index")]
public int? Index { get; }

Property Value

int?

IsFunction

[JsonIgnore]
public bool IsFunction { get; }

Property Value

bool

Type

[JsonInclude]
[JsonPropertyName("type")]
public string Type { get; }

Property Value

string

Methods

AppendFrom(ToolCall)

public void AppendFrom(ToolCall other)

Parameters

other ToolCall

InvokeFunction()

Invokes the function and returns the result as json.

public string InvokeFunction()

Returns

string

The result of the function as json.

Exceptions

InvalidOperationException

If tool is not a function or tool is not registered.

InvokeFunctionAsync(CancellationToken)

Invokes the function and returns the result as json.

public Task<string> InvokeFunctionAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Optional, A token to cancel the request.

Returns

Task<string>

The result of the function as json.

Exceptions

InvalidOperationException

If tool is not a function or tool is not registered.

InvokeFunctionAsync<T>(CancellationToken)

Invokes the function and returns the result.

public Task<T> InvokeFunctionAsync<T>(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Optional, A token to cancel the request.

Returns

Task<T>

The result of the function.

Type Parameters

T

The type to deserialize the result to.

Exceptions

InvalidOperationException

If tool is not a function or tool is not registered.

InvokeFunction<T>()

Invokes the function and returns the result.

public T InvokeFunction<T>()

Returns

T

The result of the function.

Type Parameters

T

The type to deserialize the result to.

Exceptions

InvalidOperationException

If tool is not a function or tool is not registered.