Constructor Detail

Method Detail

• maxNumResults

   final FileSearchTool.FileSearch.Builder maxNumResults(Long maxNumResults)

  The maximum number of results the file search tool should output. The default is 20 for gpt-4* models and 5 for gpt-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.

• maxNumResults

   final FileSearchTool.FileSearch.Builder maxNumResults(JsonField<Long> maxNumResults)

  Sets Builder.maxNumResults to an arbitrary JSON value.

  You should usually call Builder.maxNumResults with a well-typed Long value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• rankingOptions

   final FileSearchTool.FileSearch.Builder rankingOptions(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.

• rankingOptions

   final FileSearchTool.FileSearch.Builder rankingOptions(JsonField<FileSearchTool.FileSearch.RankingOptions> rankingOptions)

  Sets Builder.rankingOptions to an arbitrary JSON value.

  You should usually call Builder.rankingOptions with a well-typed RankingOptions value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• additionalProperties

   final FileSearchTool.FileSearch.Builder additionalProperties(Map<String, JsonValue> additionalProperties)

• putAdditionalProperty

   final FileSearchTool.FileSearch.Builder putAdditionalProperty(String key, JsonValue value)

• putAllAdditionalProperties

   final FileSearchTool.FileSearch.Builder putAllAdditionalProperties(Map<String, JsonValue> additionalProperties)

• removeAdditionalProperty

   final FileSearchTool.FileSearch.Builder removeAdditionalProperty(String key)

• removeAllAdditionalProperties

   final FileSearchTool.FileSearch.Builder removeAllAdditionalProperties(Set<String> keys)

• build

   final FileSearchTool.FileSearch build()

  Returns an immutable instance of FileSearch.

  Further updates to this Builder will not mutate the returned instance.