Package com.openai.models.responses
Class FileSearchTool.RankingOptions
-
- All Implemented Interfaces:
public final class FileSearchTool.RankingOptions
Ranking options for search.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final class
FileSearchTool.RankingOptions.Builder
A builder for RankingOptions.
public final class
FileSearchTool.RankingOptions.Ranker
The ranker to use for the file search.
-
Method Summary
Modifier and Type Method Description 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.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
validate()
final FileSearchTool.RankingOptions.Builder
toBuilder()
Boolean
equals(Object other)
Integer
hashCode()
String
toString()
final static FileSearchTool.RankingOptions.Builder
builder()
Returns a mutable builder for constructing an instance of RankingOptions. -
-
Method Detail
-
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.
-
_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()
-
validate
final FileSearchTool.RankingOptions validate()
-
toBuilder
final FileSearchTool.RankingOptions.Builder toBuilder()
-
builder
final static FileSearchTool.RankingOptions.Builder builder()
Returns a mutable builder for constructing an instance of RankingOptions.
-
-
-
-