PredictFunction (Flink : Table : Common 2.1.0 API)

java.lang.Object
- org.apache.flink.table.functions.UserDefinedFunction
- - org.apache.flink.table.functions.TableFunction<RowData>
  - - org.apache.flink.table.functions.PredictFunction

All Implemented Interfaces:

Serializable, FunctionDefinition
```
@PublicEvolving
public abstract class PredictFunction
extends TableFunction<RowData>
```
A wrapper class of TableFunction for synchronous model inference.
The output type of this table function is fixed as RowData.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor Description

PredictFunction()

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`eval(Object... args)`	Invoke `predict(org.apache.flink.table.data.RowData)` and handle exceptions.
`abstract Collection<RowData>`	`predict(RowData inputRow)`	Synchronously predict result based on input row.

Methods inherited from class org.apache.flink.table.functions.TableFunction
collect, finish, getKind, getParameterTypes, getResultType, getTypeInference, setCollector

Methods inherited from class org.apache.flink.table.functions.UserDefinedFunction
close, functionIdentifier, open, toString

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

Methods inherited from interface org.apache.flink.table.functions.FunctionDefinition
getRequirements, isDeterministic, supportsConstantFolding

- Constructor Detail
  - PredictFunction
```
public PredictFunction()
```
- Method Detail
  - predict
```
public abstract Collection<RowData> predict(RowData inputRow)
```
    Synchronously predict result based on input row.
    
    Parameters:
    
    inputRow - - A RowData that wraps input for predict function.
    
    Returns:
    
    A collection of predicted results.
  - eval
```
public final void eval(Object... args)
```
    Invoke predict(org.apache.flink.table.data.RowData) and handle exceptions.