Package org.opensearch.client.opensearch.ml

Class Parameters.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.ml.Parameters.Builder

All Implemented Interfaces:

CopyableBuilder<Parameters.Builder,Parameters>, MutableBuilder<Parameters.Builder,Parameters>, ObjectBuilder<Parameters>

Enclosing class:

Parameters

public static class Parameters.Builder
extends ObjectBuilderBase
implements CopyableBuilder<Parameters.Builder,Parameters>

Builder for Parameters.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
Parameters	build()	Builds a Parameters.
Parameters.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final Parameters.Builder	inputs(String value)	API name: inputs
final Parameters.Builder	llmInterface(String value)	API name: _llm_interface
final Parameters.Builder	messages(Function<Messages.Builder,ObjectBuilder<Messages>> fn)	API name: messages
final Parameters.Builder	messages(List<Messages> list)	API name: messages
final Parameters.Builder	messages(Messages value, Messages... values)	API name: messages
final Parameters.Builder	metadata(String key, JsonData value)	Adds an entry to metadata.
final Parameters.Builder	metadata(Map<String,JsonData> map)	Adds all elements of map to metadata.
final Parameters.Builder	question(String value)	API name: question

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

_checkSingleUse, _listAdd, _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 Details

Builder

public Builder()

Method Details

copy

@Nonnull
public Parameters.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<Parameters.Builder,Parameters>

Returns:

a new builder instance.

inputs

@Nonnull
public final Parameters.Builder inputs(@Nullable
 String value)

API name: inputs

llmInterface

@Nonnull
public final Parameters.Builder llmInterface(@Nullable
 String value)

API name: _llm_interface

messages

@Nonnull
public final Parameters.Builder messages(List<Messages> list)

API name: messages

Adds all elements of list to messages.

messages

@Nonnull
public final Parameters.Builder messages(Messages value,
 Messages... values)

API name: messages

Adds one or more values to messages.

messages

@Nonnull
public final Parameters.Builder messages(Function<Messages.Builder,ObjectBuilder<Messages>> fn)

API name: messages

Adds a value to messages using a builder lambda.

metadata

@Nonnull
public final Parameters.Builder metadata(Map<String,JsonData> map)

Adds all elements of map to metadata.

metadata

@Nonnull
public final Parameters.Builder metadata(String key,
 JsonData value)

Adds an entry to metadata.

question

@Nonnull
public final Parameters.Builder question(@Nullable
 String value)

API name: question

build

@Nonnull
public Parameters build()

Builds a Parameters.

Specified by:

build in interface ObjectBuilder<Parameters>

Throws:

NullPointerException - if some of the required fields are null.