Class FileSearchToolCall.FileSearch.RankingOptions
-
- All Implemented Interfaces:
public final class FileSearchToolCall.FileSearch.RankingOptionsThe ranking options for the file search.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classFileSearchToolCall.FileSearch.RankingOptions.BuilderA builder for RankingOptions.
public final classFileSearchToolCall.FileSearch.RankingOptions.RankerThe ranker to use for the file search. If not specified will use the
autoranker.
-
Method Summary
Modifier and Type Method Description final FileSearchToolCall.FileSearch.RankingOptions.Rankerranker()The ranker to use for the file search. final DoublescoreThreshold()The score threshold for the file search. final JsonField<FileSearchToolCall.FileSearch.RankingOptions.Ranker>_ranker()Returns the raw JSON value of ranker. final JsonField<Double>_scoreThreshold()Returns the raw JSON value of scoreThreshold. final Map<String, JsonValue>_additionalProperties()final FileSearchToolCall.FileSearch.RankingOptions.BuildertoBuilder()final FileSearchToolCall.FileSearch.RankingOptionsvalidate()Validates that the types of all values in this object match their expected types recursively. final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static FileSearchToolCall.FileSearch.RankingOptions.Builderbuilder()Returns a mutable builder for constructing an instance of RankingOptions. -
-
Method Detail
-
ranker
final FileSearchToolCall.FileSearch.RankingOptions.Ranker ranker()
The ranker to use for the file search. If not specified will use the
autoranker.
-
scoreThreshold
final Double scoreThreshold()
The score threshold for the file search. All values must be a floating point number between 0 and 1.
-
_ranker
final JsonField<FileSearchToolCall.FileSearch.RankingOptions.Ranker> _ranker()
Returns the raw JSON value of ranker.
Unlike ranker, this method doesn't throw if the JSON field has an unexpected type.
-
_scoreThreshold
final JsonField<Double> _scoreThreshold()
Returns the raw JSON value of scoreThreshold.
Unlike scoreThreshold, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final FileSearchToolCall.FileSearch.RankingOptions.Builder toBuilder()
-
validate
final FileSearchToolCall.FileSearch.RankingOptions validate()
Validates that the types of all values in this object match their expected types recursively.
This method is not forwards compatible with new types from the API for existing fields.
-
builder
final static FileSearchToolCall.FileSearch.RankingOptions.Builder builder()
Returns a mutable builder for constructing an instance of RankingOptions.
The following fields are required:
.ranker() .scoreThreshold()
-
-
-
-