Package org.opensearch.client.opensearch.ml

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

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
Guardrails	build()	Builds a Guardrails.
Guardrails.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
Guardrails.Builder	indexName(java.lang.String value)	API name: index_name
Guardrails.Builder	inputGuardrail(java.util.function.Function<GuardrailsInputOutput.Builder,ObjectBuilder<GuardrailsInputOutput>> fn)	API name: input_guardrail
Guardrails.Builder	inputGuardrail(GuardrailsInputOutput value)	API name: input_guardrail
Guardrails.Builder	modelId(java.lang.String value)	The model ID.
Guardrails.Builder	outputGuardrail(java.util.function.Function<GuardrailsInputOutput.Builder,ObjectBuilder<GuardrailsInputOutput>> fn)	API name: output_guardrail
Guardrails.Builder	outputGuardrail(GuardrailsInputOutput value)	API name: output_guardrail
Guardrails.Builder	regex(java.lang.String key, JsonData value)	The regex used for input/output validation.
Guardrails.Builder	regex(java.util.Map<java.lang.String,JsonData> map)	The regex used for input/output validation.
Guardrails.Builder	responseFilter(java.lang.String value)	The response filter.
Guardrails.Builder	responseValidationRegex(java.lang.String value)	The response validation regex.
Guardrails.Builder	sourceFields(java.lang.String value, java.lang.String... values)	API name: source_fields
Guardrails.Builder	sourceFields(java.util.List<java.lang.String> list)	API name: source_fields
Guardrails.Builder	stopWords(java.lang.String value, java.lang.String... values)	API name: stop_words
Guardrails.Builder	stopWords(java.util.List<java.lang.String> list)	API name: stop_words
Guardrails.Builder	type(java.lang.String value)	The guardrails type.

Methods inherited from class org.opensearch.client.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAdd, _listAddAll, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

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

applyMutation

Constructor Detail

Builder

public Builder()

Method Detail

copy

@Nonnull
public Guardrails.Builder copy()

Description copied from interface: CopyableBuilder

Create a new builder CopyableBuilder that is a copy of this one.

Specified by:

copy in interface CopyableBuilder<Guardrails.Builder,Guardrails>

Returns:

a new builder instance.

indexName

@Nonnull
public final Guardrails.Builder indexName(@Nullable
                                          java.lang.String value)

API name: index_name

inputGuardrail

@Nonnull
public final Guardrails.Builder inputGuardrail(@Nullable
                                               GuardrailsInputOutput value)

API name: input_guardrail

inputGuardrail

@Nonnull
public final Guardrails.Builder inputGuardrail(java.util.function.Function<GuardrailsInputOutput.Builder,ObjectBuilder<GuardrailsInputOutput>> fn)

API name: input_guardrail

modelId

@Nonnull
public final Guardrails.Builder modelId(@Nullable
                                        java.lang.String value)

The model ID.

API name: model_id

outputGuardrail

@Nonnull
public final Guardrails.Builder outputGuardrail(@Nullable
                                                GuardrailsInputOutput value)

API name: output_guardrail

outputGuardrail

@Nonnull
public final Guardrails.Builder outputGuardrail(java.util.function.Function<GuardrailsInputOutput.Builder,ObjectBuilder<GuardrailsInputOutput>> fn)

API name: output_guardrail

regex

@Nonnull
public final Guardrails.Builder regex(java.util.Map<java.lang.String,JsonData> map)

The regex used for input/output validation.

API name: regex

Adds all elements of map to regex.

regex

@Nonnull
public final Guardrails.Builder regex(java.lang.String key,
                                      JsonData value)

The regex used for input/output validation.

API name: regex

Adds an entry to regex.

responseFilter

@Nonnull
public final Guardrails.Builder responseFilter(@Nullable
                                               java.lang.String value)

The response filter.

API name: response_filter

responseValidationRegex

@Nonnull
public final Guardrails.Builder responseValidationRegex(@Nullable
                                                        java.lang.String value)

The response validation regex.

API name: response_validation_regex

sourceFields

@Nonnull
public final Guardrails.Builder sourceFields(java.util.List<java.lang.String> list)

API name: source_fields

Adds all elements of list to sourceFields.

sourceFields

@Nonnull
public final Guardrails.Builder sourceFields(java.lang.String value,
                                             java.lang.String... values)

API name: source_fields

Adds one or more values to sourceFields.

stopWords

@Nonnull
public final Guardrails.Builder stopWords(java.util.List<java.lang.String> list)

API name: stop_words

Adds all elements of list to stopWords.

stopWords

@Nonnull
public final Guardrails.Builder stopWords(java.lang.String value,
                                          java.lang.String... values)

API name: stop_words

Adds one or more values to stopWords.

type

@Nonnull
public final Guardrails.Builder type(@Nullable
                                     java.lang.String value)

The guardrails type.

API name: type

build

@Nonnull
public Guardrails build()

Builds a Guardrails.

Specified by:

build in interface ObjectBuilder<Guardrails>

Throws:

java.lang.NullPointerException - if some of the required fields are null.