All Implemented Interfaces:

com.openai.core.Params
```
public final class VectorStoreSearchParams
 implements Params
                    
```
Search a vector store for relevant chunks based on a query and file attributes filter.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`VectorStoreSearchParams.Body`
`public final class`	`VectorStoreSearchParams.Builder`	A builder for VectorStoreSearchParams.
`public final class`	`VectorStoreSearchParams.Query`	A query string for a search
`public final class`	`VectorStoreSearchParams.Filters`	A filter to apply based on file attributes.
`public final class`	`VectorStoreSearchParams.RankingOptions`	Ranking options for search.

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final String`	`vectorStoreId()`
`final VectorStoreSearchParams.Query`	`query()`	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>`	`_additionalBodyProperties()`
`final Headers`	`_additionalHeaders()`
`final QueryParams`	`_additionalQueryParams()`
`final String`	`_pathParam(Integer index)`
`Headers`	`_headers()`	The full set of headers in the parameters, including both fixed and additional headers.
`QueryParams`	`_queryParams()`	The full set of query params in the parameters, including both fixed and additional query params.
`final VectorStoreSearchParams.Builder`	`toBuilder()`
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`
`String`	`toString()`
`final static VectorStoreSearchParams.Builder`	`builder()`	Returns a mutable builder for constructing an instance of VectorStoreSearchParams.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
- Method Detail
  - vectorStoreId
```
 final String vectorStoreId()
```
  - 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.
  - _additionalBodyProperties
```
 final Map<String, JsonValue> _additionalBodyProperties()
```
  - _additionalHeaders
```
 final Headers _additionalHeaders()
```
  - _additionalQueryParams
```
 final QueryParams _additionalQueryParams()
```
  - _pathParam
```
 final String _pathParam(Integer index)
```
  - _headers
```
 Headers _headers()
```
    The full set of headers in the parameters, including both fixed and additional headers.
  - _queryParams
```
 QueryParams _queryParams()
```
    The full set of query params in the parameters, including both fixed and additional query params.
  - toBuilder
```
 final VectorStoreSearchParams.Builder toBuilder()
```
  - equals
```
 Boolean equals(Object other)
```
  - hashCode
```
 Integer hashCode()
```
  - toString
```
 String toString()
```
  - builder
```
 final static VectorStoreSearchParams.Builder builder()
```
    Returns a mutable builder for constructing an instance of VectorStoreSearchParams.
    The following fields are required:
    .vectorStoreId() .query()

Class VectorStoreSearchParams

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

vectorStoreId

query

filters

maxNumResults

rankingOptions

rewriteQuery

_query

_filters

_maxNumResults

_rankingOptions

_rewriteQuery

_additionalBodyProperties

_additionalHeaders

_additionalQueryParams

_pathParam

_headers

_queryParams

toBuilder

equals

hashCode

toString

builder