Package org.opensearch.ml.common.conversation

Class Interaction

java.lang.Object

org.opensearch.ml.common.conversation.Interaction

All Implemented Interfaces:

org.opensearch.core.common.io.stream.Writeable, org.opensearch.core.xcontent.ToXContent, org.opensearch.core.xcontent.ToXContentObject

public class Interaction
extends Object
implements org.opensearch.core.common.io.stream.Writeable, org.opensearch.core.xcontent.ToXContentObject

Class for dealing with Interactions

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Interaction.InteractionBuilder

Nested classes/interfaces inherited from interface org.opensearch.core.xcontent.ToXContent

org.opensearch.core.xcontent.ToXContent.DelegatingMapParams, org.opensearch.core.xcontent.ToXContent.MapParams, org.opensearch.core.xcontent.ToXContent.Params

Nested classes/interfaces inherited from interface org.opensearch.core.common.io.stream.Writeable

org.opensearch.core.common.io.stream.Writeable.Reader<V>, org.opensearch.core.common.io.stream.Writeable.WriteableRegistry, org.opensearch.core.common.io.stream.Writeable.Writer<V>

Field Summary

Fields inherited from interface org.opensearch.core.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
Interaction(String id, Instant createTime, String conversationId, String input, String promptTemplate, String response, String origin, Map<String,String> additionalInfo)
Interaction(String id, Instant createTime, String conversationId, String input, String promptTemplate, String response, String origin, Map<String,String> additionalInfo, String parentInteractionId, Integer traceNum)

Method Summary

Modifier and Type	Method	Description
static Interaction.InteractionBuilder	builder()
boolean	equals(Object other)
static Interaction	fromMap(String id, Map<String,Object> fields)	Creates an Interaction object from a map of fields in the OS index
static Interaction	fromSearchHit(org.opensearch.search.SearchHit hit)	Creates an Interaction object from a search hit
static Interaction	fromStream(org.opensearch.core.common.io.stream.StreamInput in)	Creates a new Interaction object from a stream
Map<String,String>	getAdditionalInfo()
String	getConversationId()
Instant	getCreateTime()
String	getId()
String	getInput()
String	getOrigin()
String	getParentInteractionId()
String	getPromptTemplate()
String	getResponse()
Integer	getTraceNum()
Interaction.InteractionBuilder	toBuilder()
String	toString()
org.opensearch.core.xcontent.XContentBuilder	toXContent(org.opensearch.core.xcontent.XContentBuilder builder, org.opensearch.core.xcontent.ToXContent.Params params)
void	writeTo(org.opensearch.core.common.io.stream.StreamOutput out)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.core.xcontent.ToXContentObject

isFragment

Constructor Details

Interaction

public Interaction(String id,
 Instant createTime,
 String conversationId,
 String input,
 String promptTemplate,
 String response,
 String origin,
 Map<String,String> additionalInfo)

Interaction

public Interaction(String id,
 Instant createTime,
 String conversationId,
 String input,
 String promptTemplate,
 String response,
 String origin,
 Map<String,String> additionalInfo,
 String parentInteractionId,
 Integer traceNum)

Method Details

fromMap

public static Interaction fromMap(String id,
 Map<String,Object> fields)

Creates an Interaction object from a map of fields in the OS index

Parameters:

id - the Interaction id

fields - the field mapping from the OS document

Returns:

a new Interaction object representing the OS document

fromSearchHit

public static Interaction fromSearchHit(org.opensearch.search.SearchHit hit)

Creates an Interaction object from a search hit

Parameters:

hit - the search hit from the interactions index

Returns:

a new Interaction object representing the search hit

fromStream

public static Interaction fromStream(org.opensearch.core.common.io.stream.StreamInput in)
                              throws IOException

Creates a new Interaction object from a stream

Parameters:

in - stream to read from; assumes Interactions.writeTo was called on it

Returns:

a new Interaction

Throws:

IOException - if can't read or the stream isn't pointing to an intraction or something

writeTo

public void writeTo(org.opensearch.core.common.io.stream.StreamOutput out)
             throws IOException

Specified by:

writeTo in interface org.opensearch.core.common.io.stream.Writeable

Throws:

IOException

toXContent

public org.opensearch.core.xcontent.XContentBuilder toXContent(org.opensearch.core.xcontent.XContentBuilder builder,
 org.opensearch.core.xcontent.ToXContent.Params params)
                                                        throws IOException

Specified by:

toXContent in interface org.opensearch.core.xcontent.ToXContent

Throws:

IOException

equals

public boolean equals(Object other)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

builder

public static Interaction.InteractionBuilder builder()

toBuilder

public Interaction.InteractionBuilder toBuilder()

getId

public String getId()

getCreateTime

public Instant getCreateTime()

getConversationId

public String getConversationId()

getInput

public String getInput()

getPromptTemplate

public String getPromptTemplate()

getResponse

public String getResponse()

getOrigin

public String getOrigin()

getAdditionalInfo

public Map<String,String> getAdditionalInfo()

getParentInteractionId

public String getParentInteractionId()

getTraceNum

public Integer getTraceNum()