Class FileSearchTool.FileSearch.RankingOptions
-
- All Implemented Interfaces:
public final class FileSearchTool.FileSearch.RankingOptionsThe ranking options for the file search. If not specified, the file search tool will use the
autoranker and a score_threshold of 0.See the file search tool documentation for more information.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classFileSearchTool.FileSearch.RankingOptions.BuilderA builder for RankingOptions.
public final classFileSearchTool.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 DoublescoreThreshold()The score threshold for the file search. final Optional<FileSearchTool.FileSearch.RankingOptions.Ranker>ranker()The ranker to use for the file search. final JsonField<Double>_scoreThreshold()Returns the raw JSON value of scoreThreshold. final JsonField<FileSearchTool.FileSearch.RankingOptions.Ranker>_ranker()Returns the raw JSON value of ranker. final Map<String, JsonValue>_additionalProperties()final FileSearchTool.FileSearch.RankingOptions.BuildertoBuilder()final FileSearchTool.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 FileSearchTool.FileSearch.RankingOptions.Builderbuilder()Returns a mutable builder for constructing an instance of RankingOptions. -
-
Method Detail
-
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 Optional<FileSearchTool.FileSearch.RankingOptions.Ranker> ranker()
The ranker to use for the file search. If not specified will use the
autoranker.
-
_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.
-
_ranker
final JsonField<FileSearchTool.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.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final FileSearchTool.FileSearch.RankingOptions.Builder toBuilder()
-
validate
final FileSearchTool.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 FileSearchTool.FileSearch.RankingOptions.Builder builder()
Returns a mutable builder for constructing an instance of RankingOptions.
The following fields are required:
.scoreThreshold()
-
-
-
-