Constructor Detail

Method Detail

• vectorStoreId

   final VectorStoreSearchParams.Builder vectorStoreId(String vectorStoreId)

• vectorStoreId

   final VectorStoreSearchParams.Builder vectorStoreId(Optional<String> vectorStoreId)

  Alias for calling Builder.vectorStoreId with vectorStoreId.orElse(null).

• body

   final VectorStoreSearchParams.Builder body(VectorStoreSearchParams.Body body)

  Sets the entire request body.

  This is generally only useful if you are already constructing the body separately. Otherwise, it's more convenient to use the top-level setters instead:

  • query

  • filters

  • maxNumResults

  • rankingOptions

  • rewriteQuery

  • etc.

• query

   final VectorStoreSearchParams.Builder query(VectorStoreSearchParams.Query query)

  A query string for a search

• query

   final VectorStoreSearchParams.Builder query(JsonField<VectorStoreSearchParams.Query> query)

  Sets Builder.query to an arbitrary JSON value.

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

• query

   final VectorStoreSearchParams.Builder query(String string)

  Alias for calling query with Query.ofString(string).

• queryOfStrings

   final VectorStoreSearchParams.Builder queryOfStrings(List<String> strings)

  Alias for calling query with Query.ofStrings(strings).

• filters

   final VectorStoreSearchParams.Builder filters(VectorStoreSearchParams.Filters filters)

  A filter to apply based on file attributes.

• filters

   final VectorStoreSearchParams.Builder filters(JsonField<VectorStoreSearchParams.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 VectorStoreSearchParams.Builder filters(ComparisonFilter comparisonFilter)

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

• filters

   final VectorStoreSearchParams.Builder filters(CompoundFilter compoundFilter)

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

• maxNumResults

   final VectorStoreSearchParams.Builder maxNumResults(Long maxNumResults)

  The maximum number of results to return. This number should be between 1 and 50 inclusive.

• maxNumResults

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

  Ranking options for search.

• rankingOptions

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

• rewriteQuery

   final VectorStoreSearchParams.Builder rewriteQuery(Boolean rewriteQuery)

  Whether to rewrite the natural language query for vector search.

• rewriteQuery

   final VectorStoreSearchParams.Builder rewriteQuery(JsonField<Boolean> rewriteQuery)

  Sets Builder.rewriteQuery to an arbitrary JSON value.

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

• additionalBodyProperties

   final VectorStoreSearchParams.Builder additionalBodyProperties(Map<String, JsonValue> additionalBodyProperties)

• putAdditionalBodyProperty

   final VectorStoreSearchParams.Builder putAdditionalBodyProperty(String key, JsonValue value)

• putAllAdditionalBodyProperties

   final VectorStoreSearchParams.Builder putAllAdditionalBodyProperties(Map<String, JsonValue> additionalBodyProperties)

• removeAdditionalBodyProperty

   final VectorStoreSearchParams.Builder removeAdditionalBodyProperty(String key)

• removeAllAdditionalBodyProperties

   final VectorStoreSearchParams.Builder removeAllAdditionalBodyProperties(Set<String> keys)

• additionalHeaders

   final VectorStoreSearchParams.Builder additionalHeaders(Headers additionalHeaders)

• additionalHeaders

   final VectorStoreSearchParams.Builder additionalHeaders(Map<String, Iterable<String>> additionalHeaders)

• putAdditionalHeader

   final VectorStoreSearchParams.Builder putAdditionalHeader(String name, String value)

• putAdditionalHeaders

   final VectorStoreSearchParams.Builder putAdditionalHeaders(String name, Iterable<String> values)

• putAllAdditionalHeaders

   final VectorStoreSearchParams.Builder putAllAdditionalHeaders(Headers additionalHeaders)

• putAllAdditionalHeaders

   final VectorStoreSearchParams.Builder putAllAdditionalHeaders(Map<String, Iterable<String>> additionalHeaders)

• replaceAdditionalHeaders

   final VectorStoreSearchParams.Builder replaceAdditionalHeaders(String name, String value)

• replaceAdditionalHeaders

   final VectorStoreSearchParams.Builder replaceAdditionalHeaders(String name, Iterable<String> values)

• replaceAllAdditionalHeaders

   final VectorStoreSearchParams.Builder replaceAllAdditionalHeaders(Headers additionalHeaders)

• replaceAllAdditionalHeaders

   final VectorStoreSearchParams.Builder replaceAllAdditionalHeaders(Map<String, Iterable<String>> additionalHeaders)

• removeAdditionalHeaders

   final VectorStoreSearchParams.Builder removeAdditionalHeaders(String name)

• removeAllAdditionalHeaders

   final VectorStoreSearchParams.Builder removeAllAdditionalHeaders(Set<String> names)

• additionalQueryParams

   final VectorStoreSearchParams.Builder additionalQueryParams(QueryParams additionalQueryParams)

• additionalQueryParams

   final VectorStoreSearchParams.Builder additionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)

• putAdditionalQueryParam

   final VectorStoreSearchParams.Builder putAdditionalQueryParam(String key, String value)

• putAdditionalQueryParams

   final VectorStoreSearchParams.Builder putAdditionalQueryParams(String key, Iterable<String> values)

• putAllAdditionalQueryParams

   final VectorStoreSearchParams.Builder putAllAdditionalQueryParams(QueryParams additionalQueryParams)

• putAllAdditionalQueryParams

   final VectorStoreSearchParams.Builder putAllAdditionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)

• replaceAdditionalQueryParams

   final VectorStoreSearchParams.Builder replaceAdditionalQueryParams(String key, String value)

• replaceAdditionalQueryParams

   final VectorStoreSearchParams.Builder replaceAdditionalQueryParams(String key, Iterable<String> values)

• replaceAllAdditionalQueryParams

   final VectorStoreSearchParams.Builder replaceAllAdditionalQueryParams(QueryParams additionalQueryParams)

• replaceAllAdditionalQueryParams

   final VectorStoreSearchParams.Builder replaceAllAdditionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)

• removeAdditionalQueryParams

   final VectorStoreSearchParams.Builder removeAdditionalQueryParams(String key)

• removeAllAdditionalQueryParams

   final VectorStoreSearchParams.Builder removeAllAdditionalQueryParams(Set<String> keys)

• build

   final VectorStoreSearchParams build()

  Returns an immutable instance of VectorStoreSearchParams.

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

  The following fields are required:

  .query()