Package org.opensearch.client.opensearch.ml

Class Guardrails

java.lang.Object

org.opensearch.client.opensearch.ml.Guardrails

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable, ToCopyableBuilder<Guardrails.Builder,Guardrails>

@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public class Guardrails
extends Object
implements PlainJsonSerializable, ToCopyableBuilder<Guardrails.Builder,Guardrails>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Guardrails.Builder	Builder for Guardrails.

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<Guardrails>	_DESERIALIZER	Json deserializer for Guardrails

Method Summary

Modifier and Type	Method	Description
static Guardrails.Builder	builder()
boolean	equals(Object o)
int	hashCode()
final String	indexName()	API name: index_name
final GuardrailsInputOutput	inputGuardrail()	API name: input_guardrail
final String	modelId()	The model ID.
static Guardrails	of(Function<Guardrails.Builder,ObjectBuilder<Guardrails>> fn)
final GuardrailsInputOutput	outputGuardrail()	API name: output_guardrail
final Map<String,JsonData>	regex()	The regex used for input/output validation.
final String	responseFilter()	The response filter.
final String	responseValidationRegex()	The response validation regex.
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupGuardrailsDeserializer(ObjectDeserializer<Guardrails.Builder> op)
final List<String>	sourceFields()	API name: source_fields
final List<String>	stopWords()	API name: stop_words
Guardrails.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.
final String	type()	The guardrails type.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.json.PlainJsonSerializable

toJsonString

Methods inherited from interface org.opensearch.client.util.ToCopyableBuilder

copy

Field Details

_DESERIALIZER

public static final JsonpDeserializer<Guardrails> _DESERIALIZER

Json deserializer for Guardrails

Method Details

of

public static Guardrails of(Function<Guardrails.Builder,ObjectBuilder<Guardrails>> fn)

indexName

@Nullable
public final String indexName()

API name: index_name

inputGuardrail

@Nullable
public final GuardrailsInputOutput inputGuardrail()

API name: input_guardrail

modelId

@Nullable
public final String modelId()

The model ID.

API name: model_id

outputGuardrail

@Nullable
public final GuardrailsInputOutput outputGuardrail()

API name: output_guardrail

regex

@Nonnull
public final Map<String,JsonData> regex()

The regex used for input/output validation.

API name: regex

responseFilter

@Nullable
public final String responseFilter()

The response filter.

API name: response_filter

responseValidationRegex

@Nullable
public final String responseValidationRegex()

The response validation regex.

API name: response_validation_regex

sourceFields

@Nonnull
public final List<String> sourceFields()

API name: source_fields

stopWords

@Nonnull
public final List<String> stopWords()

API name: stop_words

type

@Nullable
public final String type()

The guardrails type.

API name: type

serialize

public void serialize(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

Serialize this object to JSON.

Specified by:

serialize in interface JsonpSerializable

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

toBuilder

@Nonnull
public Guardrails.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<Guardrails.Builder,Guardrails>

Returns:

a new builder instance.

builder

@Nonnull
public static Guardrails.Builder builder()

setupGuardrailsDeserializer

protected static void setupGuardrailsDeserializer(ObjectDeserializer<Guardrails.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object