Class OpenAiDecisionModel

java.lang.Object

dev.langchain4j.model.openai.OpenAiDecisionModel

All Implemented Interfaces:

DecisionModel

@Experimental
public class OpenAiDecisionModel
extends Object
implements DecisionModel

A DecisionModel backed by the OpenAI Decisions API (POST /v1/decisions), which answers yes/no, choice and scale questions about a text or image input with probabilities.

DecisionModel model = OpenAiDecisionModel.builder()
        .apiKey(System.getenv("OPENAI_API_KEY"))
        .modelName(OpenAiDecisionModelName.GPT_6_LUNA)
        .build();

The input can be text, a Map (sent as JSON text), or a list of TextContents and ImageContents. Images must be inline (base64 data or data URLs): images referenced by URL are not supported by the API. The image detail levels LOW, HIGH and AUTO are supported.

The API can refuse to answer a single question, for example because it goes against the usage policies of OpenAI: the answer to that question is then a RefusalAnswer.

Since:

1.22.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OpenAiDecisionModel.OpenAiDecisionModelBuilder

Constructor Summary

Constructors

Constructor	Description
OpenAiDecisionModel(OpenAiDecisionModel.OpenAiDecisionModelBuilder builder)

Method Summary

Modifier and Type	Method	Description
static OpenAiDecisionModel.OpenAiDecisionModelBuilder	builder()
DecisionRequestParameters	defaultRequestParameters()	The model's default per-call parameters, applied to every request and overridden by any parameters set on the request itself.
DecisionResponse	doDecide(DecisionRequest request)	The provider hook behind DecisionModel.decide(DecisionRequest).
CompletableFuture<DecisionResponse>	doDecideAsync(DecisionRequest request)	The provider hook behind DecisionModel.decideAsync(DecisionRequest).
List<DecisionModelListener>	listeners()	The listeners notified of every request, response and error of this model.
ModelProvider	provider()	The provider of this model.

Methods inherited from class Object

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

Methods inherited from interface DecisionModel

decide, decideAsync, modelName

Constructor Details

OpenAiDecisionModel

public OpenAiDecisionModel(OpenAiDecisionModel.OpenAiDecisionModelBuilder builder)

Method Details

doDecide

public DecisionResponse doDecide(DecisionRequest request)

Description copied from interface: DecisionModel

The provider hook behind DecisionModel.decide(DecisionRequest).

Specified by:

doDecide in interface DecisionModel

Parameters:

request - the request, with the default parameters already applied.

Returns:

one answer per question, keyed by question name.

doDecideAsync

public CompletableFuture<DecisionResponse> doDecideAsync(DecisionRequest request)

Description copied from interface: DecisionModel

The provider hook behind DecisionModel.decideAsync(DecisionRequest). The default returns a failed future: a model that is not genuinely asynchronous does not pretend to be.

Specified by:

doDecideAsync in interface DecisionModel

Parameters:

request - the request, with the default parameters already applied.

Returns:

a CompletableFuture of the answers, keyed by question name.

defaultRequestParameters

public DecisionRequestParameters defaultRequestParameters()

Description copied from interface: DecisionModel

The model's default per-call parameters, applied to every request and overridden by any parameters set on the request itself. The default is DecisionRequestParameters.EMPTY.

Specified by:

defaultRequestParameters in interface DecisionModel

listeners

public List<DecisionModelListener> listeners()

Description copied from interface: DecisionModel

The listeners notified of every request, response and error of this model.

Specified by:

listeners in interface DecisionModel

provider

public ModelProvider provider()

Description copied from interface: DecisionModel

The provider of this model.

Specified by:

provider in interface DecisionModel

builder

public static OpenAiDecisionModel.OpenAiDecisionModelBuilder builder()