Class V1DetectParams
-
- All Implemented Interfaces:
-
dev.case.api.core.Params
public final class V1DetectParams implements Params
Analyzes text or vault documents for legal privilege review. Detects attorney-client privilege, work product doctrine, and common interest privilege.
Returns structured review flags with confidence scores and policy-friendly rationale suitable for discovery workflows and privilege logs. This endpoint is an AI-assisted triage tool and does not replace attorney judgment.
Size Limit: Maximum 200,000 characters (larger documents rejected).
Permissions: Requires
chatpermission. When usingdocument_id, also requiresvaultpermission.Note: When analyzing vault documents, results are automatically stored in the document's
privilege_analysismetadata field.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classV1DetectParams.BuilderA builder for V1DetectParams.
public final classV1DetectParams.Bodypublic final classV1DetectParams.Categorypublic final classV1DetectParams.JurisdictionJurisdiction for privilege rules
-
Method Summary
Modifier and Type Method Description final Optional<List<V1DetectParams.Category>>categories()Privilege categories to check. final Optional<String>content()Text content to analyze (required if document_id not provided) final Optional<String>documentId()Vault object ID to analyze (required if content not provided) final Optional<Boolean>includeRationale()Include detailed rationale for each category final Optional<V1DetectParams.Jurisdiction>jurisdiction()Jurisdiction for privilege rules final Optional<String>model()LLM model to use for analysis final Optional<String>vaultId()Vault ID (required when using document_id) final JsonField<List<V1DetectParams.Category>>_categories()Returns the raw JSON value of categories. final JsonField<String>_content()Returns the raw JSON value of content. final JsonField<String>_documentId()Returns the raw JSON value of documentId. final JsonField<Boolean>_includeRationale()Returns the raw JSON value of includeRationale. final JsonField<V1DetectParams.Jurisdiction>_jurisdiction()Returns the raw JSON value of jurisdiction. final JsonField<String>_model()Returns the raw JSON value of model. 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 V1DetectParams.BuildertoBuilder()final V1DetectParams.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 V1DetectParamsnone()final static V1DetectParams.Builderbuilder()Returns a mutable builder for constructing an instance of V1DetectParams. -
-
Method Detail
-
categories
final Optional<List<V1DetectParams.Category>> categories()
Privilege categories to check. Defaults to all: attorney_client, work_product, common_interest
-
content
final Optional<String> content()
Text content to analyze (required if document_id not provided)
-
documentId
final Optional<String> documentId()
Vault object ID to analyze (required if content not provided)
-
includeRationale
final Optional<Boolean> includeRationale()
Include detailed rationale for each category
-
jurisdiction
final Optional<V1DetectParams.Jurisdiction> jurisdiction()
Jurisdiction for privilege rules
-
_categories
final JsonField<List<V1DetectParams.Category>> _categories()
Returns the raw JSON value of categories.
Unlike categories, this method doesn't throw if the JSON field has an unexpected type.
-
_content
final JsonField<String> _content()
Returns the raw JSON value of content.
Unlike content, this method doesn't throw if the JSON field has an unexpected type.
-
_documentId
final JsonField<String> _documentId()
Returns the raw JSON value of documentId.
Unlike documentId, this method doesn't throw if the JSON field has an unexpected type.
-
_includeRationale
final JsonField<Boolean> _includeRationale()
Returns the raw JSON value of includeRationale.
Unlike includeRationale, this method doesn't throw if the JSON field has an unexpected type.
-
_jurisdiction
final JsonField<V1DetectParams.Jurisdiction> _jurisdiction()
Returns the raw JSON value of jurisdiction.
Unlike jurisdiction, this method doesn't throw if the JSON field has an unexpected type.
-
_model
final JsonField<String> _model()
Returns the raw JSON value of model.
Unlike model, 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 V1DetectParams.Builder toBuilder()
-
_body
final V1DetectParams.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 V1DetectParams none()
-
builder
final static V1DetectParams.Builder builder()
Returns a mutable builder for constructing an instance of V1DetectParams.
-
-
-
-