Package org.opensearch.client.opensearch.ml

Class Parameters

java.lang.Object

org.opensearch.client.opensearch.ml.Parameters

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable, ToCopyableBuilder<Parameters.Builder,Parameters>

@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public class Parameters
extends Object
implements PlainJsonSerializable, ToCopyableBuilder<Parameters.Builder,Parameters>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Parameters.Builder	Builder for Parameters.

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<Parameters>	_DESERIALIZER	Json deserializer for Parameters

Method Summary

Modifier and Type	Method	Description
static Parameters.Builder	builder()
boolean	equals(Object o)
int	hashCode()
final String	inputs()	API name: inputs
final String	llmInterface()	API name: _llm_interface
final List<Messages>	messages()	API name: messages
final Map<String,JsonData>	metadata()
static Parameters	of(Function<Parameters.Builder,ObjectBuilder<Parameters>> fn)
final String	question()	API name: question
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupParametersDeserializer(ObjectDeserializer<Parameters.Builder> op)
Parameters.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.json.PlainJsonSerializable

toJsonString

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

copy

Field Details

_DESERIALIZER

public static final JsonpDeserializer<Parameters> _DESERIALIZER

Json deserializer for Parameters

Method Details

of

public static Parameters of(Function<Parameters.Builder,ObjectBuilder<Parameters>> fn)

inputs

@Nullable
public final String inputs()

API name: inputs

llmInterface

@Nullable
public final String llmInterface()

API name: _llm_interface

messages

@Nonnull
public final List<Messages> messages()

API name: messages

metadata

@Nonnull
public final Map<String,JsonData> metadata()

question

@Nullable
public final String question()

API name: question

serialize

public void serialize(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

Serialize this object to JSON.

Specified by:

serialize in interface JsonpSerializable

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

toBuilder

@Nonnull
public Parameters.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<Parameters.Builder,Parameters>

Returns:

a new builder instance.

builder

@Nonnull
public static Parameters.Builder builder()

setupParametersDeserializer

protected static void setupParametersDeserializer(ObjectDeserializer<Parameters.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object