RankingOptions 4.7.1 API

All Implemented Interfaces:
```
public final class FileSearchTool.FileSearch.RankingOptions

                    
```
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.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`FileSearchTool.FileSearch.RankingOptions.Builder`	A builder for RankingOptions.
`public final class`	`FileSearchTool.FileSearch.RankingOptions.Ranker`	The ranker to use for the file search. If not specified will use the `auto` ranker.

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final Double`	`scoreThreshold()`	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.Builder`	`toBuilder()`
`final FileSearchTool.FileSearch.RankingOptions`	`validate()`
`final Boolean`	`isValid()`
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`
`String`	`toString()`
`final static FileSearchTool.FileSearch.RankingOptions.Builder`	`builder()`	Returns a mutable builder for constructing an instance of RankingOptions.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
- 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 auto ranker.
  - _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()
```
  - isValid
```
 final Boolean isValid()
```
  - equals
```
 Boolean equals(Object other)
```
  - hashCode
```
 Integer hashCode()
```
  - toString
```
 String toString()
```
  - builder
```
 final static FileSearchTool.FileSearch.RankingOptions.Builder builder()
```
    Returns a mutable builder for constructing an instance of RankingOptions.
    The following fields are required:
    .scoreThreshold()