Class Guardrails.Builder
java.lang.Object
org.opensearch.client.util.ObjectBuilderBase
org.opensearch.client.opensearch.ml.Guardrails.Builder
- All Implemented Interfaces:
CopyableBuilder<Guardrails.Builder,,Guardrails> MutableBuilder<Guardrails.Builder,,Guardrails> ObjectBuilder<Guardrails>
- Enclosing class:
Guardrails
public static class Guardrails.Builder
extends ObjectBuilderBase
implements CopyableBuilder<Guardrails.Builder,Guardrails>
Builder for
Guardrails.-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbuild()Builds aGuardrails.copy()Create a new builderCopyableBuilderthat is a copy of this one.final Guardrails.BuilderAPI name:index_namefinal Guardrails.BuilderAPI name:input_guardrailfinal Guardrails.BuilderAPI name:input_guardrailfinal Guardrails.BuilderThe model ID.final Guardrails.BuilderAPI name:output_guardrailfinal Guardrails.BuilderAPI name:output_guardrailfinal Guardrails.BuilderThe regex used for input/output validation.final Guardrails.BuilderThe regex used for input/output validation.final Guardrails.BuilderresponseFilter(String value) The response filter.final Guardrails.BuilderresponseValidationRegex(String value) The response validation regex.final Guardrails.BuildersourceFields(String value, String... values) API name:source_fieldsfinal Guardrails.BuildersourceFields(List<String> list) API name:source_fieldsfinal Guardrails.BuilderAPI name:stop_wordsfinal Guardrails.BuilderAPI name:stop_wordsfinal Guardrails.BuilderThe guardrails type.Methods inherited from class org.opensearch.client.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAllMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.opensearch.client.util.MutableBuilder
applyMutation
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
copy
Description copied from interface:CopyableBuilderCreate a new builderCopyableBuilderthat is a copy of this one.- Specified by:
copyin interfaceCopyableBuilder<Guardrails.Builder,Guardrails> - Returns:
- a new builder instance.
-
indexName
API name:index_name -
inputGuardrail
API name:input_guardrail -
inputGuardrail
@Nonnull public final Guardrails.Builder inputGuardrail(Function<GuardrailsInputOutput.Builder, ObjectBuilder<GuardrailsInputOutput>> fn) API name:input_guardrail -
modelId
The model ID.API name:
model_id -
outputGuardrail
API name:output_guardrail -
outputGuardrail
@Nonnull public final Guardrails.Builder outputGuardrail(Function<GuardrailsInputOutput.Builder, ObjectBuilder<GuardrailsInputOutput>> fn) API name:output_guardrail -
regex
The regex used for input/output validation.API name:
regexAdds all elements of
maptoregex. -
regex
The regex used for input/output validation.API name:
regexAdds an entry to
regex. -
responseFilter
The response filter.API name:
response_filter -
responseValidationRegex
The response validation regex.API name:
response_validation_regex -
sourceFields
API name:source_fieldsAdds all elements of
listtosourceFields. -
sourceFields
API name:source_fieldsAdds one or more values to
sourceFields. -
stopWords
API name:stop_wordsAdds all elements of
listtostopWords. -
stopWords
API name:stop_wordsAdds one or more values to
stopWords. -
type
The guardrails type.API name:
type -
build
Builds aGuardrails.- Specified by:
buildin interfaceObjectBuilder<Guardrails>- Throws:
NullPointerException- if some of the required fields are null.
-