Constructor Detail

Method Detail

• type

   final FileSearchTool.Builder type(JsonValue type)

  Sets the field to an arbitrary JSON value.

  It is usually unnecessary to call this method because the field defaults to the following:

  JsonValue.from("file_search")

  This method is primarily for setting the field to an undocumented or not yet supported value.

• 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)

  Sets Builder.vectorStoreIds to an arbitrary JSON value.

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

• addVectorStoreId

   final FileSearchTool.Builder addVectorStoreId(String vectorStoreId)

  Adds a single String to vectorStoreIds.

• 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)

  Sets Builder.filters to an arbitrary JSON value.

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

• filters

   final FileSearchTool.Builder filters(ComparisonFilter comparisonFilter)

  Alias for calling filters with Filters.ofComparisonFilter(comparisonFilter).

• filters

   final FileSearchTool.Builder filters(CompoundFilter compoundFilter)

  Alias for calling filters with Filters.ofCompoundFilter(compoundFilter).

• 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)

  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.Builder rankingOptions(FileSearchTool.RankingOptions rankingOptions)

  Ranking options for search.

• rankingOptions

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

  Returns an immutable instance of FileSearchTool.

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

  The following fields are required:

  .vectorStoreIds()