FileSearchRankingOptions class abstract

The ranking options for the file search. If not specified, the file search tool will use the auto ranker and a score_threshold of 0.

See the file search tool documentation for more information.

Available extensions
Annotations
  • @freezed

Constructors

FileSearchRankingOptions.new({@JsonKey(includeIfNull: false, unknownEnumValue: JsonKey.nullForUndefinedEnumValue) FileSearchRanker? ranker, @JsonKey(name: 'score_threshold') required double scoreThreshold})
Factory constructor for FileSearchRankingOptions
const
factory
FileSearchRankingOptions.fromJson(Map<String, dynamic> json)
Object construction from a JSON representation
factory

Properties

copyWith → $FileSearchRankingOptionsCopyWith<FileSearchRankingOptions>
Create a copy of FileSearchRankingOptions with the given fields replaced by the non-null parameter values.
no setterinherited
hashCode → int
The hash code for this object.
no setterinherited
ranker → FileSearchRanker?
The ranker to use for the file search. If not specified will use the auto ranker.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
scoreThreshold → double
The score threshold for the file search. All values must be a floating point number between 0 and 1.
no setterinherited

Methods

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

Available on FileSearchRankingOptions, provided by the FileSearchRankingOptionsPatterns extension

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

Available on FileSearchRankingOptions, provided by the FileSearchRankingOptionsPatterns extension

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

Available on FileSearchRankingOptions, provided by the FileSearchRankingOptionsPatterns extension

A variant of map that fallback to returning orElse.
maybeWhen<TResult extends Object?>(TResult $default(FileSearchRanker? ranker, double scoreThreshold)?, {required TResult orElse()}) → TResult

Available on FileSearchRankingOptions, provided by the FileSearchRankingOptionsPatterns 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 FileSearchRankingOptions 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(FileSearchRanker? ranker, double scoreThreshold)) → TResult

Available on FileSearchRankingOptions, provided by the FileSearchRankingOptionsPatterns extension

A switch-like method, using callbacks.
whenOrNull<TResult extends Object?>(TResult? $default(FileSearchRanker? ranker, double scoreThreshold)?) → TResult?

Available on FileSearchRankingOptions, provided by the FileSearchRankingOptionsPatterns 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
scoreThresholdMaxValue → const double
scoreThresholdMinValue → const double
Validation constants