Package dev.langchain4j.model.openai

Class OpenAiModerationModel

java.lang.Object

dev.langchain4j.model.openai.OpenAiModerationModel

All Implemented Interfaces:

ModerationModel

public class OpenAiModerationModel
extends Object
implements ModerationModel

Represents an OpenAI moderation model, such as text-moderation-latest.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OpenAiModerationModel.OpenAiModerationModelBuilder

Constructor Summary

Constructors

Constructor	Description
OpenAiModerationModel(String baseUrl, String apiKey, String organizationId, String modelName, Duration timeout, Integer maxRetries, Proxy proxy, Boolean logRequests, Boolean logResponses, Map<String,String> customHeaders)

Method Summary

Modifier and Type	Method	Description
static OpenAiModerationModel.OpenAiModerationModelBuilder	builder()
String	modelName()
Response<Moderation>	moderate(String text)	Moderates the given text.
Response<Moderation>	moderate(List<ChatMessage> messages)	Moderates the given list of chat messages.
static OpenAiModerationModel	withApiKey(String apiKey)	Deprecated, for removal: This API element is subject to removal in a future version. Please use builder() instead, and explicitly set the model name and, if necessary, other parameters.

Methods inherited from class java.lang.Object

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

Methods inherited from interface dev.langchain4j.model.moderation.ModerationModel

moderate, moderate, moderate

Constructor Details

OpenAiModerationModel

public OpenAiModerationModel(String baseUrl,
 String apiKey,
 String organizationId,
 String modelName,
 Duration timeout,
 Integer maxRetries,
 Proxy proxy,
 Boolean logRequests,
 Boolean logResponses,
 Map<String,String> customHeaders)

Method Details

modelName

public String modelName()

moderate

public Response<Moderation> moderate(String text)

Description copied from interface: ModerationModel

Moderates the given text.

Specified by:

moderate in interface ModerationModel

Parameters:

text - the text to moderate.

Returns:

the moderation Response.

moderate

public Response<Moderation> moderate(List<ChatMessage> messages)

Description copied from interface: ModerationModel

Moderates the given list of chat messages.

Specified by:

moderate in interface ModerationModel

Parameters:

messages - the list of chat messages to moderate.

Returns:

the moderation Response.

withApiKey

@Deprecated(forRemoval=true)
public static OpenAiModerationModel withApiKey(String apiKey)

Deprecated, for removal: This API element is subject to removal in a future version.

Please use builder() instead, and explicitly set the model name and, if necessary, other parameters. The default value for the model name will be removed in future releases!

builder

public static OpenAiModerationModel.OpenAiModerationModelBuilder builder()