ChatCompletionTool class

A tool the model may use.

Annotations

• @freezed

Constructors

ChatCompletionTool.new({required ChatCompletionToolType type, required FunctionObject function})

Factory constructor for ChatCompletionTool

const

factory

ChatCompletionTool.fromJson(Map<String, dynamic> json)

Object construction from a JSON representation

factory

Properties

copyWith → $ChatCompletionToolCopyWith<ChatCompletionTool>

Create a copy of ChatCompletionTool with the given fields replaced by the non-null parameter values.

no setter, inherited

function → FunctionObject

A function that the model may call.

no setter, inherited

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

type → ChatCompletionToolType

The type of the tool. Currently, only function is supported.

no setter, inherited

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toJson() → Map<String, dynamic>

Serializes this ChatCompletionTool to a JSON map.

inherited

toMap() → Map<String, dynamic>

Map representation of object (not serialized)

toString() → String

A string representation of this object.

inherited

validateSchema() → String?

Perform validations on the schema property values

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Constants

propertyNames → const List<String>

List of all property names of schema