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

Class OpenAIModelParameters.Builder

java.lang.Object

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

Enclosing class:

OpenAIModelParameters

public static class OpenAIModelParameters.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
OpenAIModelParameters.Builder	apiKey(String apiKey)	Sets the OpenAI API key for authentication.
OpenAIModelParameters	build()	Builds the OpenAIModelParameters instance.
OpenAIModelParameters.Builder	instructionPrompt(String prompt)	Sets the instruction prompt for the model.
OpenAIModelParameters.Builder	modelName(String modelName)	Sets the name of the OpenAI model to use.

Methods inherited from class java.lang.Object

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

Method Details

apiKey

public OpenAIModelParameters.Builder apiKey(String apiKey)

Sets the OpenAI API key for authentication.

Parameters:

apiKey - the API key (required)

modelName

public OpenAIModelParameters.Builder modelName(String modelName)

Sets the name of the OpenAI model to use.

Parameters:

modelName - the model name, e.g., "gpt-4" (required)

instructionPrompt

public OpenAIModelParameters.Builder instructionPrompt(String prompt)

Sets the instruction prompt for the model. This prompt provides context or instructions to the model about how to process the input text.

Parameters:

prompt - the instruction text (required)

build

public OpenAIModelParameters build()

Builds the OpenAIModelParameters instance.