Package org.apache.flink.model.openai

Class OpenAIChatModelFunction

java.lang.Object

org.apache.flink.table.functions.UserDefinedFunction

org.apache.flink.table.functions.AsyncTableFunction<org.apache.flink.table.data.RowData>

org.apache.flink.table.functions.AsyncPredictFunction

org.apache.flink.model.openai.AbstractOpenAIModelFunction

org.apache.flink.model.openai.OpenAIChatModelFunction

All Implemented Interfaces:

Serializable, org.apache.flink.table.functions.FunctionDefinition

public class OpenAIChatModelFunction
extends AbstractOpenAIModelFunction

AsyncPredictFunction for OpenAI chat completion task.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static String	ENDPOINT_SUFFIX
static org.apache.flink.configuration.ConfigOption<Long>	MAX_TOKENS
static org.apache.flink.configuration.ConfigOption<String>	STOP
static String	STOP_SEPARATOR
static org.apache.flink.configuration.ConfigOption<String>	SYSTEM_PROMPT
static org.apache.flink.configuration.ConfigOption<Double>	TEMPERATURE
static org.apache.flink.configuration.ConfigOption<Double>	TOP_P

Fields inherited from class org.apache.flink.model.openai.AbstractOpenAIModelFunction

API_KEY, client, ENDPOINT, MODEL

Constructor Summary

Constructors

Constructor	Description
OpenAIChatModelFunction(org.apache.flink.table.factories.ModelProviderFactory.Context factoryContext, org.apache.flink.configuration.ReadableConfig config)

Method Summary

Modifier and Type	Method	Description
CompletableFuture<Collection<org.apache.flink.table.data.RowData>>	asyncPredict(org.apache.flink.table.data.RowData rowData)
protected String	getEndpointSuffix()

Methods inherited from class org.apache.flink.model.openai.AbstractOpenAIModelFunction

close, open, validateSingleColumnSchema

Methods inherited from class org.apache.flink.table.functions.AsyncPredictFunction

eval

Methods inherited from class org.apache.flink.table.functions.AsyncTableFunction

getKind, getTypeInference

Methods inherited from class org.apache.flink.table.functions.UserDefinedFunction

functionIdentifier, 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

Field Detail

ENDPOINT_SUFFIX

public static final String ENDPOINT_SUFFIX

See Also:

Constant Field Values

SYSTEM_PROMPT

public static final org.apache.flink.configuration.ConfigOption<String> SYSTEM_PROMPT

TEMPERATURE

public static final org.apache.flink.configuration.ConfigOption<Double> TEMPERATURE

TOP_P

public static final org.apache.flink.configuration.ConfigOption<Double> TOP_P

STOP_SEPARATOR

public static final String STOP_SEPARATOR

See Also:

Constant Field Values

STOP

public static final org.apache.flink.configuration.ConfigOption<String> STOP

MAX_TOKENS

public static final org.apache.flink.configuration.ConfigOption<Long> MAX_TOKENS

Constructor Detail

OpenAIChatModelFunction

public OpenAIChatModelFunction(org.apache.flink.table.factories.ModelProviderFactory.Context factoryContext,
                               org.apache.flink.configuration.ReadableConfig config)

Method Detail

getEndpointSuffix

protected String getEndpointSuffix()

Specified by:

getEndpointSuffix in class AbstractOpenAIModelFunction

asyncPredict

public CompletableFuture<Collection<org.apache.flink.table.data.RowData>> asyncPredict(org.apache.flink.table.data.RowData rowData)

Specified by:

asyncPredict in class org.apache.flink.table.functions.AsyncPredictFunction