PredictOptions (Mindee Java Helper Library 4.37.0 API)

java.lang.Object
- com.mindee.PredictOptions

public final class PredictOptions
extends Object

Parameters for making predict API calls.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class PredictOptions.PredictOptionsBuilder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static PredictOptions.PredictOptionsBuilder`	`builder()`
`boolean`	`equals(Object o)`
`Boolean`	`getAllWords()`	Whether to include the full text for each page.
`Boolean`	`getCropper()`	Whether to include cropper results for each page.
`Boolean`	`getFullText()`	Whether to include the full text data for async APIs.
`Boolean`	`getRag()`	If set, will enable Retrieval-Augmented Generation.
`String`	`getWorkflowId()`	If set, will enqueue to a workflow queue instead of a product's endpoint.
`int`	`hashCode()`
`String`	`toString()`

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

- Method Detail
  - builder
```
public static PredictOptions.PredictOptionsBuilder builder()
```
  - getAllWords
```
public Boolean getAllWords()
```
    Whether to include the full text for each page. This performs a full OCR operation on the server and will increase response time.
  - getCropper
```
public Boolean getCropper()
```
    Whether to include cropper results for each page. This performs a cropping operation on the server and will increase response time.
  - getFullText
```
public Boolean getFullText()
```
    Whether to include the full text data for async APIs. This performs a full OCR operation on the server and will increase response time and payload size.
  - getWorkflowId
```
public String getWorkflowId()
```
    If set, will enqueue to a workflow queue instead of a product's endpoint.
  - getRag
```
public Boolean getRag()
```
    If set, will enable Retrieval-Augmented Generation. Only works if a valid workflowId is set.
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object