Package org.opensearch.ml.common.model

Class Guardrail

java.lang.Object

org.opensearch.ml.common.model.Guardrail

All Implemented Interfaces:

org.opensearch.core.xcontent.ToXContent, org.opensearch.core.xcontent.ToXContentObject

public class Guardrail
extends Object
implements org.opensearch.core.xcontent.ToXContentObject

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Guardrail.GuardrailBuilder

Nested classes/interfaces inherited from interface org.opensearch.core.xcontent.ToXContent

org.opensearch.core.xcontent.ToXContent.DelegatingMapParams, org.opensearch.core.xcontent.ToXContent.MapParams, org.opensearch.core.xcontent.ToXContent.Params

Field Summary

Fields

Modifier and Type	Field	Description
static final String	REGEX_FIELD
static final String	STOP_WORDS_FIELD

Fields inherited from interface org.opensearch.core.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
Guardrail(List<StopWords> stopWords, String[] regex)
Guardrail(org.opensearch.core.common.io.stream.StreamInput input)

Method Summary

Modifier and Type	Method	Description
static Guardrail.GuardrailBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
String[]	getRegex()
List<StopWords>	getStopWords()
int	hashCode()
static Guardrail	parse(org.opensearch.core.xcontent.XContentParser parser)
Guardrail.GuardrailBuilder	toBuilder()
org.opensearch.core.xcontent.XContentBuilder	toXContent(org.opensearch.core.xcontent.XContentBuilder builder, org.opensearch.core.xcontent.ToXContent.Params params)
void	writeTo(org.opensearch.core.common.io.stream.StreamOutput out)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.core.xcontent.ToXContentObject

isFragment

Field Details

STOP_WORDS_FIELD

public static final String STOP_WORDS_FIELD

See Also:

• Constant Field Values

REGEX_FIELD

public static final String REGEX_FIELD

See Also:

• Constant Field Values

Constructor Details

Guardrail

public Guardrail(List<StopWords> stopWords,
 String[] regex)

Guardrail

public Guardrail(org.opensearch.core.common.io.stream.StreamInput input)
          throws IOException

Throws:

IOException

Method Details

writeTo

public void writeTo(org.opensearch.core.common.io.stream.StreamOutput out)
             throws IOException

Throws:

IOException

toXContent

public org.opensearch.core.xcontent.XContentBuilder toXContent(org.opensearch.core.xcontent.XContentBuilder builder,
 org.opensearch.core.xcontent.ToXContent.Params params)
                                                        throws IOException

Specified by:

toXContent in interface org.opensearch.core.xcontent.ToXContent

Throws:

IOException

parse

public static Guardrail parse(org.opensearch.core.xcontent.XContentParser parser)
                       throws IOException

Throws:

IOException

builder

public static Guardrail.GuardrailBuilder builder()

toBuilder

public Guardrail.GuardrailBuilder toBuilder()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getStopWords

public List<StopWords> getStopWords()

getRegex

public String[] getRegex()