Module org.elasticsearch.xcore

Package org.elasticsearch.xpack.core.inference.results

Record Class ChatCompletionResults.Result

java.lang.Object

java.lang.Record

org.elasticsearch.xpack.core.inference.results.ChatCompletionResults.Result

All Implemented Interfaces:

NamedWriteable, Writeable, InferenceResults, ToXContent, ToXContentFragment

Enclosing class:

ChatCompletionResults

public static record ChatCompletionResults.Result(String content)
extends Record
implements InferenceResults, Writeable

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

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

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	RESULT

Fields inherited from interface org.elasticsearch.inference.InferenceResults

MODEL_ID_RESULTS_FIELD

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
Result(String content)	Creates an instance of a Result record class.
Result(StreamInput in)

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	asMap()
Map<String,Object>	asMap(String outputField)
String	content()	Returns the value of the content record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
String	getResultsField()
String	getWriteableName()
final int	hashCode()	Returns a hash code value for this object.
Object	predictedValue()
final String	toString()	Returns a string representation of this record class.
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.xcontent.ToXContentFragment

isFragment

Field Details

RESULT

public static final String RESULT

See Also:

• Constant Field Values

Constructor Details

Result

public Result(StreamInput in)
       throws IOException

Throws:

IOException

Result

public Result(String content)

Creates an instance of a Result record class.

Parameters:

content - the value for the content record component

Method Details

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Throws:

IOException

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
 ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException

getResultsField

public String getResultsField()

Specified by:

getResultsField in interface InferenceResults

asMap

public Map<String,Object> asMap()

Specified by:

asMap in interface InferenceResults

asMap

public Map<String,Object> asMap(String outputField)

Specified by:

asMap in interface InferenceResults

predictedValue

public Object predictedValue()

Specified by:

predictedValue in interface InferenceResults

getWriteableName

public String getWriteableName()

Specified by:

getWriteableName in interface NamedWriteable

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

content

public String content()

Returns the value of the content record component.

Returns:

the value of the content record component