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 -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final JsonpDeserializer<Guardrails> Json deserializer forGuardrails -
Method Summary
Modifier and TypeMethodDescriptionstatic Guardrails.Builderbuilder()booleaninthashCode()final StringAPI name:index_namefinal GuardrailsInputOutputAPI name:input_guardrailfinal StringmodelId()The model ID.static Guardrailsfinal GuardrailsInputOutputAPI name:output_guardrailregex()The regex used for input/output validation.final StringThe response filter.final StringThe response validation regex.voidserialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper) Serialize this object to JSON.protected voidserializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper) protected static voidAPI name:source_fieldsAPI name:stop_wordsCreate a new builderToCopyableBuilderthat is initialised with the current state of this object.final Stringtype()API name:typeMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.opensearch.client.json.PlainJsonSerializable
toJsonStringMethods inherited from interface org.opensearch.client.util.ToCopyableBuilder
copy
-
Field Details
-
_DESERIALIZER
Json deserializer forGuardrails
-
-
Method Details
-
of
-
indexName
API name:index_name -
inputGuardrail
API name:input_guardrail -
modelId
The model ID.API name:
model_id -
outputGuardrail
API name:output_guardrail -
regex
The regex used for input/output validation.API name:
regex -
responseFilter
The response filter.API name:
response_filter -
responseValidationRegex
The response validation regex.API name:
response_validation_regex -
sourceFields
API name:source_fields -
stopWords
API name:stop_words -
type
API name:type -
serialize
Serialize this object to JSON.- Specified by:
serializein interfaceJsonpSerializable
-
serializeInternal
-
toBuilder
Description copied from interface:ToCopyableBuilderCreate a new builderToCopyableBuilderthat is initialised with the current state of this object.- Specified by:
toBuilderin interfaceToCopyableBuilder<Guardrails.Builder,Guardrails> - Returns:
- a new builder instance.
-
builder
-
setupGuardrailsDeserializer
-
hashCode
public int hashCode() -
equals
-