Class BoostListExtractParams
-
- All Implemented Interfaces:
-
dev.case.api.core.Params
public final class BoostListExtractParams implements Params
Extracts a categorized word boost list from vault documents or raw text using LLM entity extraction. The resulting list can be passed as
word_boostto the transcription endpoint for improved accuracy.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classBoostListExtractParams.BuilderA builder for BoostListExtractParams.
public final classBoostListExtractParams.Bodypublic final classBoostListExtractParams.Category
-
Method Summary
Modifier and Type Method Description final Optional<List<BoostListExtractParams.Category>>categories()Optional filter for entity categories to extract final Optional<List<String>>objectIds()Object IDs of documents to extract entities from (PDFs, text files) final Optional<String>text()Raw text input for entity extraction (alternative to vault documents) final Optional<String>vaultId()Vault ID containing the source documents (use with object_ids) final JsonField<List<BoostListExtractParams.Category>>_categories()Returns the raw JSON value of categories. final JsonField<List<String>>_objectIds()Returns the raw JSON value of objectIds. final JsonField<String>_text()Returns the raw JSON value of text. final JsonField<String>_vaultId()Returns the raw JSON value of vaultId. 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 BoostListExtractParams.BuildertoBuilder()final BoostListExtractParams.Body_body()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 BoostListExtractParamsnone()final static BoostListExtractParams.Builderbuilder()Returns a mutable builder for constructing an instance of BoostListExtractParams. -
-
Method Detail
-
categories
final Optional<List<BoostListExtractParams.Category>> categories()
Optional filter for entity categories to extract
-
objectIds
final Optional<List<String>> objectIds()
Object IDs of documents to extract entities from (PDFs, text files)
-
text
final Optional<String> text()
Raw text input for entity extraction (alternative to vault documents)
-
vaultId
final Optional<String> vaultId()
Vault ID containing the source documents (use with object_ids)
-
_categories
final JsonField<List<BoostListExtractParams.Category>> _categories()
Returns the raw JSON value of categories.
Unlike categories, this method doesn't throw if the JSON field has an unexpected type.
-
_objectIds
final JsonField<List<String>> _objectIds()
Returns the raw JSON value of objectIds.
Unlike objectIds, this method doesn't throw if the JSON field has an unexpected type.
-
_text
final JsonField<String> _text()
Returns the raw JSON value of text.
Unlike text, this method doesn't throw if the JSON field has an unexpected type.
-
_vaultId
final JsonField<String> _vaultId()
Returns the raw JSON value of vaultId.
Unlike vaultId, 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 BoostListExtractParams.Builder toBuilder()
-
_body
final BoostListExtractParams.Body _body()
-
_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.
-
none
final static BoostListExtractParams none()
-
builder
final static BoostListExtractParams.Builder builder()
Returns a mutable builder for constructing an instance of BoostListExtractParams.
-
-
-
-