All Implemented Interfaces:

dev.case.api.core.Params
```
public final class ObjectGetOcrWordsParams
 implements Params
                    
```
Retrieves word-level OCR bounding box data for a processed PDF document. Each word includes its text, normalized bounding box coordinates (0-1 range), confidence score, and global word index. Use this data to highlight specific text ranges in a PDF viewer based on word indices from search results.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`ObjectGetOcrWordsParams.Builder`	A builder for ObjectGetOcrWordsParams.

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`	`id()`
`final Optional<String>`	`objectId()`
`final Optional<Long>`	`page()`	Filter to a specific page number (1-indexed).
`final Optional<Long>`	`wordEnd()`	Filter to words ending at this index (inclusive).
`final Optional<Long>`	`wordStart()`	Filter to words starting at this index (inclusive).
`final Headers`	`_additionalHeaders()`	Additional headers to send with the request.
`final QueryParams`	`_additionalQueryParams()`	Additional query param to send with the request.
`final ObjectGetOcrWordsParams.Builder`	`toBuilder()`
`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.
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`
`String`	`toString()`
`final static ObjectGetOcrWordsParams.Builder`	`builder()`	Returns a mutable builder for constructing an instance of ObjectGetOcrWordsParams.

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

- Constructor Detail
- Method Detail
  - id
```
 final String id()
```
  - objectId
```
 final Optional<String> objectId()
```
  - page
```
 final Optional<Long> page()
```
    Filter to a specific page number (1-indexed). If omitted, returns all pages.
  - wordEnd
```
 final Optional<Long> wordEnd()
```
    Filter to words ending at this index (inclusive). Useful for retrieving words for a specific chunk.
  - wordStart
```
 final Optional<Long> wordStart()
```
    Filter to words starting at this index (inclusive). Useful for retrieving words for a specific chunk.
  - _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 ObjectGetOcrWordsParams.Builder toBuilder()
```
  - _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.
  - equals
```
 Boolean equals(Object other)
```
  - hashCode
```
 Integer hashCode()
```
  - toString
```
 String toString()
```
  - builder
```
 final static ObjectGetOcrWordsParams.Builder builder()
```
    Returns a mutable builder for constructing an instance of ObjectGetOcrWordsParams.
    The following fields are required:
    .id()

Class ObjectGetOcrWordsParams

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

id

objectId

page

wordEnd

wordStart

_additionalHeaders

_additionalQueryParams

toBuilder

_pathParam

_headers

_queryParams

equals

hashCode

toString

builder