Module org.elasticsearch.xcore

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

Record Class QuestionAnsweringInferenceResults.TopAnswerEntry

java.lang.Object

java.lang.Record

org.elasticsearch.xpack.core.ml.inference.results.QuestionAnsweringInferenceResults.TopAnswerEntry

All Implemented Interfaces:

Writeable, ToXContent, ToXContentObject

Enclosing class:

QuestionAnsweringInferenceResults

public static record QuestionAnsweringInferenceResults.TopAnswerEntry(String answer, double score, int startOffset, int endOffset)
extends Record
implements Writeable, ToXContentObject

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 ParseField	ANSWER
static final String	NAME
static final ParseField	SCORE

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
TopAnswerEntry(String answer, double score, int startOffset, int endOffset)	Creates an instance of a TopAnswerEntry record class.

Method Summary

Modifier and Type	Method	Description
String	answer()	Returns the value of the answer record component.
Map<String,Object>	asValueMap()
int	endOffset()	Returns the value of the endOffset record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
static QuestionAnsweringInferenceResults.TopAnswerEntry	fromStream(StreamInput in)
static QuestionAnsweringInferenceResults.TopAnswerEntry	fromXContent(XContentParser parser)
final int	hashCode()	Returns a hash code value for this object.
double	score()	Returns the value of the score record component.
int	startOffset()	Returns the value of the startOffset record component.
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.ToXContentObject

isFragment

Field Details

ANSWER

public static final ParseField ANSWER

SCORE

public static final ParseField SCORE

NAME

public static final String NAME

See Also:

• Constant Field Values

Constructor Details

TopAnswerEntry

public TopAnswerEntry(String answer,
 double score,
 int startOffset,
 int endOffset)

Creates an instance of a TopAnswerEntry record class.

Parameters:

answer - the value for the answer record component

score - the value for the score record component

startOffset - the value for the startOffset record component

endOffset - the value for the endOffset record component

Method Details

fromStream

public static QuestionAnsweringInferenceResults.TopAnswerEntry fromStream(StreamInput in)
                                                                   throws IOException

Throws:

IOException

fromXContent

public static QuestionAnsweringInferenceResults.TopAnswerEntry fromXContent(XContentParser parser)
                                                                     throws IOException

Throws:

IOException

asValueMap

public Map<String,Object> asValueMap()

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Throws:

IOException

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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.

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.

answer

public String answer()

Returns the value of the answer record component.

Returns:

the value of the answer record component

score

public double score()

Returns the value of the score record component.

Returns:

the value of the score record component

startOffset

public int startOffset()

Returns the value of the startOffset record component.

Returns:

the value of the startOffset record component

endOffset

public int endOffset()

Returns the value of the endOffset record component.

Returns:

the value of the endOffset record component