AssistantsNamedToolChoice class abstract

Specifies a tool the model should use. Use to force the model to call a specific tool.

Available extensions
Annotations
  • @freezed

Constructors

AssistantsNamedToolChoice({required AssistantsToolType type, @JsonKey.new(includeIfNull: false) AssistantsFunctionCallOption? function})
Factory constructor for AssistantsNamedToolChoice
const
factory
AssistantsNamedToolChoice.fromJson(Map<String, dynamic> json)
Object construction from a JSON representation
factory

Properties

copyWith → $AssistantsNamedToolChoiceCopyWith<AssistantsNamedToolChoice>
Create a copy of AssistantsNamedToolChoice with the given fields replaced by the non-null parameter values.
no setterinherited
function → AssistantsFunctionCallOption?
No Description
no setterinherited
hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
type → AssistantsToolType
The type of the tool. If type is function, the function name must be set
no setterinherited

Methods

map<TResult extends Object?>(TResult $default(_AssistantsNamedToolChoice value)) → TResult

Available on AssistantsNamedToolChoice, provided by the AssistantsNamedToolChoicePatterns extension

A switch-like method, using callbacks.
mapOrNull<TResult extends Object?>(TResult? $default(_AssistantsNamedToolChoice value)?) → TResult?

Available on AssistantsNamedToolChoice, provided by the AssistantsNamedToolChoicePatterns extension

A variant of map that fallback to returning null.
maybeMap<TResult extends Object?>(TResult $default(_AssistantsNamedToolChoice value)?, {required TResult orElse()}) → TResult

Available on AssistantsNamedToolChoice, provided by the AssistantsNamedToolChoicePatterns extension

A variant of map that fallback to returning orElse.
maybeWhen<TResult extends Object?>(TResult $default(AssistantsToolType type, AssistantsFunctionCallOption? function)?, {required TResult orElse()}) → TResult

Available on AssistantsNamedToolChoice, provided by the AssistantsNamedToolChoicePatterns extension

A variant of when that fallback to an orElse callback.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() → Map<String, dynamic>
Serializes this AssistantsNamedToolChoice 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
when<TResult extends Object?>(TResult $default(AssistantsToolType type, AssistantsFunctionCallOption? function)) → TResult

Available on AssistantsNamedToolChoice, provided by the AssistantsNamedToolChoicePatterns extension

A switch-like method, using callbacks.
whenOrNull<TResult extends Object?>(TResult? $default(AssistantsToolType type, AssistantsFunctionCallOption? function)?) → TResult?

Available on AssistantsNamedToolChoice, provided by the AssistantsNamedToolChoicePatterns extension

A variant of when that fallback to returning null

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Constants

propertyNames → const List<String>
List of all property names of schema