Class FileSearchTool.RankingOptions
-
- All Implemented Interfaces:
public final class FileSearchTool.RankingOptionsRanking options for search.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classFileSearchTool.RankingOptions.BuilderA builder for RankingOptions.
public final classFileSearchTool.RankingOptions.HybridSearchWeights that control how reciprocal rank fusion balances semantic embedding matches versus sparse keyword matches when hybrid search is enabled.
public final classFileSearchTool.RankingOptions.RankerThe ranker to use for the file search.
-
Method Summary
Modifier and Type Method Description final Optional<FileSearchTool.RankingOptions.HybridSearch>hybridSearch()Weights that control how reciprocal rank fusion balances semantic embedding matches versus sparse keyword matches when hybrid search is enabled. final Optional<FileSearchTool.RankingOptions.Ranker>ranker()The ranker to use for the file search. final Optional<Double>scoreThreshold()The score threshold for the file search, a number between 0 and 1. final JsonField<FileSearchTool.RankingOptions.HybridSearch>_hybridSearch()Returns the raw JSON value of hybridSearch. final JsonField<FileSearchTool.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 FileSearchTool.RankingOptions.BuildertoBuilder()final FileSearchTool.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.RankingOptions.Builderbuilder()Returns a mutable builder for constructing an instance of RankingOptions. -
-
Method Detail
-
hybridSearch
final Optional<FileSearchTool.RankingOptions.HybridSearch> hybridSearch()
Weights that control how reciprocal rank fusion balances semantic embedding matches versus sparse keyword matches when hybrid search is enabled.
-
ranker
final Optional<FileSearchTool.RankingOptions.Ranker> ranker()
The ranker to use for the file search.
-
scoreThreshold
final Optional<Double> scoreThreshold()
The score threshold for the file search, a number between 0 and 1. Numbers closer to 1 will attempt to return only the most relevant results, but may return fewer results.
-
_hybridSearch
final JsonField<FileSearchTool.RankingOptions.HybridSearch> _hybridSearch()
Returns the raw JSON value of hybridSearch.
Unlike hybridSearch, this method doesn't throw if the JSON field has an unexpected type.
-
_ranker
final JsonField<FileSearchTool.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 FileSearchTool.RankingOptions.Builder toBuilder()
-
validate
final FileSearchTool.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.RankingOptions.Builder builder()
Returns a mutable builder for constructing an instance of RankingOptions.
-
-
-
-