Class FileSearchTool.FileSearch
-
- All Implemented Interfaces:
public final class FileSearchTool.FileSearchOverrides for the file search tool.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classFileSearchTool.FileSearch.BuilderA builder for FileSearch.
public final classFileSearchTool.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.
-
Method Summary
Modifier and Type Method Description final Optional<Long>maxNumResults()The maximum number of results the file search tool should output. final Optional<FileSearchTool.FileSearch.RankingOptions>rankingOptions()The ranking options for the file search. final JsonField<Long>_maxNumResults()Returns the raw JSON value of maxNumResults. final JsonField<FileSearchTool.FileSearch.RankingOptions>_rankingOptions()Returns the raw JSON value of rankingOptions. final Map<String, JsonValue>_additionalProperties()final FileSearchTool.FileSearch.BuildertoBuilder()final FileSearchTool.FileSearchvalidate()final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static FileSearchTool.FileSearch.Builderbuilder()Returns a mutable builder for constructing an instance of FileSearch. -
-
Method Detail
-
maxNumResults
final Optional<Long> maxNumResults()
The maximum number of results the file search tool should output. The default is 20 for
gpt-4*models and 5 forgpt-3.5-turbo. This number should be between 1 and 50 inclusive.Note that the file search tool may output fewer than
max_num_resultsresults. See the file search tool documentation for more information.
-
rankingOptions
final Optional<FileSearchTool.FileSearch.RankingOptions> rankingOptions()
The 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.
-
_maxNumResults
final JsonField<Long> _maxNumResults()
Returns the raw JSON value of maxNumResults.
Unlike maxNumResults, this method doesn't throw if the JSON field has an unexpected type.
-
_rankingOptions
final JsonField<FileSearchTool.FileSearch.RankingOptions> _rankingOptions()
Returns the raw JSON value of rankingOptions.
Unlike rankingOptions, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final FileSearchTool.FileSearch.Builder toBuilder()
-
validate
final FileSearchTool.FileSearch validate()
-
builder
final static FileSearchTool.FileSearch.Builder builder()
Returns a mutable builder for constructing an instance of FileSearch.
-
-
-
-