Package org.apache.beam.sdk.ml.inference.openai

Class OpenAIModelParameters

java.lang.Object

org.apache.beam.sdk.ml.inference.openai.OpenAIModelParameters

All Implemented Interfaces:

Serializable, BaseModelParameters

public class OpenAIModelParameters
extends Object
implements BaseModelParameters

Configuration parameters required for OpenAI model inference.

This class encapsulates all configuration needed to initialize and communicate with OpenAI's API, including authentication credentials, model selection, and inference instructions.

Example Usage

 OpenAIModelParameters params = OpenAIModelParameters.builder()
     .apiKey("sk-...")
     .modelName("gpt-4")
     .instructionPrompt("Translate the following text to French:")
     .build();
 

See Also:

• OpenAIModelHandler
• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OpenAIModelParameters.Builder

Method Summary

Modifier and Type	Method	Description
static OpenAIModelParameters.Builder	builder()
String	getApiKey()
String	getInstructionPrompt()
String	getModelName()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

getApiKey

public String getApiKey()

getModelName

public String getModelName()

getInstructionPrompt

public String getInstructionPrompt()

builder

public static OpenAIModelParameters.Builder builder()