Class FileSearchTool.FileSearch
-
- All Implemented Interfaces:
public final class FileSearchTool.FileSearch
Overrides for the file search tool.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final class
FileSearchTool.FileSearch.Builder
A builder for FileSearch.
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.
-
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()
The maximum number of results the file search tool should output. final JsonField<FileSearchTool.FileSearch.RankingOptions>
_rankingOptions()
The ranking options for the file search. final Map<String, JsonValue>
_additionalProperties()
final FileSearchTool.FileSearch
validate()
final FileSearchTool.FileSearch.Builder
toBuilder()
Boolean
equals(Object other)
Integer
hashCode()
String
toString()
final static FileSearchTool.FileSearch.Builder
builder()
-
-
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_results
results. 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
auto
ranker and a score_threshold of 0.See the file search tool documentation for more information.
-
_maxNumResults
final JsonField<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_results
results. See the file search tool documentation for more information.
-
_rankingOptions
final JsonField<FileSearchTool.FileSearch.RankingOptions> _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.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
validate
final FileSearchTool.FileSearch validate()
-
toBuilder
final FileSearchTool.FileSearch.Builder toBuilder()
-
builder
final static FileSearchTool.FileSearch.Builder builder()
-
-
-
-