Class VaultSearchParams
-
- All Implemented Interfaces:
-
dev.case.api.core.Params
public final class VaultSearchParams implements Params
Search across vault documents using multiple methods including hybrid vector + graph search, GraphRAG global search, entity-based search, and fast similarity search. Returns relevant documents and contextual answers based on the search method.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classVaultSearchParams.BuilderA builder for VaultSearchParams.
public final classVaultSearchParams.Bodypublic final classVaultSearchParams.FiltersFilters to narrow search results to specific documents
public final classVaultSearchParams.MethodSearch method: 'global' for comprehensive questions, 'entity' for specific entities, 'fast' for quick similarity search, 'hybrid' for combined approach
-
Method Summary
Modifier and Type Method Description final Optional<String>id()final Stringquery()Search query or question to find relevant documents final Optional<VaultSearchParams.Filters>filters()Filters to narrow search results to specific documents final Optional<VaultSearchParams.Method>method()Search method: 'global' for comprehensive questions, 'entity' for specific entities, 'fast' for quick similarity search, 'hybrid' for combined approach final Optional<Long>topK()Maximum number of results to return final JsonField<String>_query()Returns the raw JSON value of query. final JsonField<VaultSearchParams.Filters>_filters()Returns the raw JSON value of filters. final JsonField<VaultSearchParams.Method>_method()Returns the raw JSON value of method. final JsonField<Long>_topK()Returns the raw JSON value of topK. final Map<String, JsonValue>_additionalBodyProperties()final Headers_additionalHeaders()Additional headers to send with the request. final QueryParams_additionalQueryParams()Additional query param to send with the request. final VaultSearchParams.BuildertoBuilder()final VaultSearchParams.Body_body()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. Booleanequals(Object other)IntegerhashCode()StringtoString()final static VaultSearchParams.Builderbuilder()Returns a mutable builder for constructing an instance of VaultSearchParams. -
-
Method Detail
-
filters
final Optional<VaultSearchParams.Filters> filters()
Filters to narrow search results to specific documents
-
method
final Optional<VaultSearchParams.Method> method()
Search method: 'global' for comprehensive questions, 'entity' for specific entities, 'fast' for quick similarity search, 'hybrid' for combined approach
-
_query
final JsonField<String> _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<VaultSearchParams.Filters> _filters()
Returns the raw JSON value of filters.
Unlike filters, this method doesn't throw if the JSON field has an unexpected type.
-
_method
final JsonField<VaultSearchParams.Method> _method()
Returns the raw JSON value of method.
Unlike method, this method doesn't throw if the JSON field has an unexpected type.
-
_topK
final JsonField<Long> _topK()
Returns the raw JSON value of topK.
Unlike topK, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalBodyProperties
final Map<String, JsonValue> _additionalBodyProperties()
-
_additionalHeaders
final Headers _additionalHeaders()
Additional headers to send with the request.
-
_additionalQueryParams
final QueryParams _additionalQueryParams()
Additional query param to send with the request.
-
toBuilder
final VaultSearchParams.Builder toBuilder()
-
_body
final VaultSearchParams.Body _body()
-
_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.
-
builder
final static VaultSearchParams.Builder builder()
Returns a mutable builder for constructing an instance of VaultSearchParams.
The following fields are required:
.query()
-
-
-
-