Package org.opensearch.client.opensearch.ml

Class Message.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.ml.Message.Builder

All Implemented Interfaces:

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

Enclosing class:

Message

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

Builder for Message.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final Message.Builder	additionalInfo(String key, JsonData value)	API name: additional_info
final Message.Builder	additionalInfo(Map<String,JsonData> map)	API name: additional_info
Message	build()	Builds a Message.
Message.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final Message.Builder	createTime(String value)	The create time.
final Message.Builder	input(String value)	The question in the message.
final Message.Builder	memoryId(String value)	API name: memory_id
final Message.Builder	messageId(String value)	API name: message_id
final Message.Builder	origin(String value)	The system name that generated the response.
final Message.Builder	parentMessageId(String value)	The parent message ID.
final Message.Builder	promptTemplate(String value)	The prompt template.
final Message.Builder	response(String value)	The answer to the question.
final Message.Builder	traceNumber(Long value)	The trace number.

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 Message.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<Message.Builder,Message>

Returns:

a new builder instance.

additionalInfo

@Nonnull
public final Message.Builder additionalInfo(Map<String,JsonData> map)

API name: additional_info

Adds all elements of map to additionalInfo.

additionalInfo

@Nonnull
public final Message.Builder additionalInfo(String key,
 JsonData value)

API name: additional_info

Adds an entry to additionalInfo.

createTime

@Nonnull
public final Message.Builder createTime(@Nullable
 String value)

The create time.

API name: create_time

input

@Nonnull
public final Message.Builder input(@Nullable
 String value)

The question in the message.

API name: input

memoryId

@Nonnull
public final Message.Builder memoryId(@Nullable
 String value)

API name: memory_id

messageId

@Nonnull
public final Message.Builder messageId(@Nullable
 String value)

API name: message_id

origin

@Nonnull
public final Message.Builder origin(@Nullable
 String value)

The system name that generated the response.

API name: origin

parentMessageId

@Nonnull
public final Message.Builder parentMessageId(@Nullable
 String value)

The parent message ID.

API name: parent_message_id

promptTemplate

@Nonnull
public final Message.Builder promptTemplate(@Nullable
 String value)

The prompt template.

API name: prompt_template

response

@Nonnull
public final Message.Builder response(@Nullable
 String value)

The answer to the question.

API name: response

traceNumber

@Nonnull
public final Message.Builder traceNumber(@Nullable
 Long value)

The trace number.

API name: trace_number

build

@Nonnull
public Message build()

Builds a Message.

Specified by:

build in interface ObjectBuilder<Message>

Throws:

NullPointerException - if some of the required fields are null.