Package org.opensearch.client.opensearch.ml

Class CreateMessageRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.ml.CreateMessageRequest

All Implemented Interfaces:

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

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

Create a message.

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.opensearch.client.opensearch._types.RequestBase

RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<CreateMessageRequest>	_DESERIALIZER	Json deserializer for CreateMessageRequest
static final Endpoint<CreateMessageRequest,CreateMessageResponse,ErrorResponse>	_ENDPOINT	Endpoint "ml.create_message".

Method Summary

Modifier and Type	Method	Description
final Map<String,JsonData>	additionalInfo()	API name: additional_info
static CreateMessageRequest.Builder	builder()
boolean	equals(Object o)
int	hashCode()
final String	input()	The question in the message.
final String	memoryId()	Required - API name: memory_id
static CreateMessageRequest	of(Function<CreateMessageRequest.Builder,ObjectBuilder<CreateMessageRequest>> fn)
final String	origin()	The system name that generated the response.
final String	promptTemplate()	The prompt template.
final String	response()	The answer to the 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	setupCreateMessageRequestDeserializer(ObjectDeserializer<CreateMessageRequest.Builder> op)
CreateMessageRequest.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Methods inherited from class org.opensearch.client.opensearch._types.RequestBase

applyQueryParameters, errorTrace, human

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<CreateMessageRequest> _DESERIALIZER

Json deserializer for CreateMessageRequest

_ENDPOINT

public static final Endpoint<CreateMessageRequest,CreateMessageResponse,ErrorResponse> _ENDPOINT

Endpoint "ml.create_message".

Method Details

of

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

additionalInfo

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

API name: additional_info

input

@Nullable
public final String input()

The question in the message.

API name: input

memoryId

@Nonnull
public final String memoryId()

Required - API name: memory_id

origin

@Nullable
public final String origin()

The system name that generated the response.

API name: origin

promptTemplate

@Nullable
public final String promptTemplate()

The prompt template.

API name: prompt_template

response

@Nullable
public final String response()

The answer to the question.

API name: response

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

Returns:

a new builder instance.

builder

@Nonnull
public static CreateMessageRequest.Builder builder()

setupCreateMessageRequestDeserializer

protected static void setupCreateMessageRequestDeserializer(ObjectDeserializer<CreateMessageRequest.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object