Package com.openai.models.responses
Class FileSearchTool.Builder
-
- All Implemented Interfaces:
public final class FileSearchTool.BuilderA builder for FileSearchTool.
-
-
Method Summary
Modifier and Type Method Description final FileSearchTool.Buildertype(JsonValue type)The type of the file search tool. final FileSearchTool.BuildervectorStoreIds(List<String> vectorStoreIds)The IDs of the vector stores to search. final FileSearchTool.BuildervectorStoreIds(JsonField<List<String>> vectorStoreIds)The IDs of the vector stores to search. final FileSearchTool.BuilderaddVectorStoreId(String vectorStoreId)The IDs of the vector stores to search. final FileSearchTool.Builderfilters(FileSearchTool.Filters filters)A filter to apply based on file attributes. final FileSearchTool.Builderfilters(JsonField<FileSearchTool.Filters> filters)A filter to apply based on file attributes. final FileSearchTool.Builderfilters(ComparisonFilter comparisonFilter)A filter used to compare a specified attribute key to a given value using a defined comparison operation. final FileSearchTool.Builderfilters(CompoundFilter compoundFilter)Combine multiple filters using andoror.final FileSearchTool.BuildermaxNumResults(Long maxNumResults)The maximum number of results to return. final FileSearchTool.BuildermaxNumResults(JsonField<Long> maxNumResults)The maximum number of results to return. final FileSearchTool.BuilderrankingOptions(FileSearchTool.RankingOptions rankingOptions)Ranking options for search. final FileSearchTool.BuilderrankingOptions(JsonField<FileSearchTool.RankingOptions> rankingOptions)Ranking options for search. final FileSearchTool.BuilderadditionalProperties(Map<String, JsonValue> additionalProperties)final FileSearchTool.BuilderputAdditionalProperty(String key, JsonValue value)final FileSearchTool.BuilderputAllAdditionalProperties(Map<String, JsonValue> additionalProperties)final FileSearchTool.BuilderremoveAdditionalProperty(String key)final FileSearchTool.BuilderremoveAllAdditionalProperties(Set<String> keys)final FileSearchToolbuild()-
-
Method Detail
-
type
final FileSearchTool.Builder type(JsonValue type)
The type of the file search tool. Always
file_search.
-
vectorStoreIds
final FileSearchTool.Builder vectorStoreIds(List<String> vectorStoreIds)
The IDs of the vector stores to search.
-
vectorStoreIds
final FileSearchTool.Builder vectorStoreIds(JsonField<List<String>> vectorStoreIds)
The IDs of the vector stores to search.
-
addVectorStoreId
final FileSearchTool.Builder addVectorStoreId(String vectorStoreId)
The IDs of the vector stores to search.
-
filters
final FileSearchTool.Builder filters(FileSearchTool.Filters filters)
A filter to apply based on file attributes.
-
filters
final FileSearchTool.Builder filters(JsonField<FileSearchTool.Filters> filters)
A filter to apply based on file attributes.
-
filters
final FileSearchTool.Builder filters(ComparisonFilter comparisonFilter)
A filter used to compare a specified attribute key to a given value using a defined comparison operation.
-
filters
final FileSearchTool.Builder filters(CompoundFilter compoundFilter)
Combine multiple filters using
andoror.
-
maxNumResults
final FileSearchTool.Builder maxNumResults(Long maxNumResults)
The maximum number of results to return. This number should be between 1 and 50 inclusive.
-
maxNumResults
final FileSearchTool.Builder maxNumResults(JsonField<Long> maxNumResults)
The maximum number of results to return. This number should be between 1 and 50 inclusive.
-
rankingOptions
final FileSearchTool.Builder rankingOptions(FileSearchTool.RankingOptions rankingOptions)
Ranking options for search.
-
rankingOptions
final FileSearchTool.Builder rankingOptions(JsonField<FileSearchTool.RankingOptions> rankingOptions)
Ranking options for search.
-
additionalProperties
final FileSearchTool.Builder additionalProperties(Map<String, JsonValue> additionalProperties)
-
putAdditionalProperty
final FileSearchTool.Builder putAdditionalProperty(String key, JsonValue value)
-
putAllAdditionalProperties
final FileSearchTool.Builder putAllAdditionalProperties(Map<String, JsonValue> additionalProperties)
-
removeAdditionalProperty
final FileSearchTool.Builder removeAdditionalProperty(String key)
-
removeAllAdditionalProperties
final FileSearchTool.Builder removeAllAdditionalProperties(Set<String> keys)
-
build
final FileSearchTool build()
-
-
-
-