Class VectorStoreSearchParams.Body
-
- All Implemented Interfaces:
public final class VectorStoreSearchParams.Body
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classVectorStoreSearchParams.Body.BuilderA builder for Body.
-
Method Summary
Modifier and Type Method Description final VectorStoreSearchParams.Queryquery()A query string for a search final Optional<VectorStoreSearchParams.Filters>filters()A filter to apply based on file attributes. final Optional<Long>maxNumResults()The maximum number of results to return. final Optional<VectorStoreSearchParams.RankingOptions>rankingOptions()Ranking options for search. final Optional<Boolean>rewriteQuery()Whether to rewrite the natural language query for vector search. final JsonField<VectorStoreSearchParams.Query>_query()Returns the raw JSON value of query. final JsonField<VectorStoreSearchParams.Filters>_filters()Returns the raw JSON value of filters. final JsonField<Long>_maxNumResults()Returns the raw JSON value of maxNumResults. final JsonField<VectorStoreSearchParams.RankingOptions>_rankingOptions()Returns the raw JSON value of rankingOptions. final JsonField<Boolean>_rewriteQuery()Returns the raw JSON value of rewriteQuery. final Map<String, JsonValue>_additionalProperties()final VectorStoreSearchParams.Body.BuildertoBuilder()final VectorStoreSearchParams.Bodyvalidate()Validates that the types of all values in this object match their expected types recursively. final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static VectorStoreSearchParams.Body.Builderbuilder()Returns a mutable builder for constructing an instance of Body. -
-
Method Detail
-
query
final VectorStoreSearchParams.Query query()
A query string for a search
-
filters
final Optional<VectorStoreSearchParams.Filters> filters()
A filter to apply based on file attributes.
-
maxNumResults
final Optional<Long> maxNumResults()
The maximum number of results to return. This number should be between 1 and 50 inclusive.
-
rankingOptions
final Optional<VectorStoreSearchParams.RankingOptions> rankingOptions()
Ranking options for search.
-
rewriteQuery
final Optional<Boolean> rewriteQuery()
Whether to rewrite the natural language query for vector search.
-
_query
final JsonField<VectorStoreSearchParams.Query> _query()
Returns the raw JSON value of query.
Unlike query, this method doesn't throw if the JSON field has an unexpected type.
-
_filters
final JsonField<VectorStoreSearchParams.Filters> _filters()
Returns the raw JSON value of filters.
Unlike filters, this method doesn't throw if the JSON field has an unexpected type.
-
_maxNumResults
final JsonField<Long> _maxNumResults()
Returns the raw JSON value of maxNumResults.
Unlike maxNumResults, this method doesn't throw if the JSON field has an unexpected type.
-
_rankingOptions
final JsonField<VectorStoreSearchParams.RankingOptions> _rankingOptions()
Returns the raw JSON value of rankingOptions.
Unlike rankingOptions, this method doesn't throw if the JSON field has an unexpected type.
-
_rewriteQuery
final JsonField<Boolean> _rewriteQuery()
Returns the raw JSON value of rewriteQuery.
Unlike rewriteQuery, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final VectorStoreSearchParams.Body.Builder toBuilder()
-
validate
final VectorStoreSearchParams.Body validate()
Validates that the types of all values in this object match their expected types recursively.
This method is not forwards compatible with new types from the API for existing fields.
-
builder
final static VectorStoreSearchParams.Body.Builder builder()
Returns a mutable builder for constructing an instance of Body.
The following fields are required:
.query()
-
-
-
-