Module org.elasticsearch.server

Package org.elasticsearch.inference.completion

Class ReasoningDetail.TextReasoningDetail

java.lang.Object

org.elasticsearch.inference.completion.ReasoningDetail

org.elasticsearch.inference.completion.ReasoningDetail.TextReasoningDetail

All Implemented Interfaces:

NamedWriteable, Writeable, ChunkedToXContent, ChunkedToXContentObject, ToXContent, ToXContentObject

Enclosing class:

ReasoningDetail

public static final class ReasoningDetail.TextReasoningDetail
extends ReasoningDetail

This class represents a reasoning detail, which may contain the reasoning in text form and/or a signature for the reasoning. At least one of the two fields (text and signature) must be present for this type of reasoning detail.

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.inference.completion.ReasoningDetail

ReasoningDetail.EncryptedReasoningDetail, ReasoningDetail.ReasoningDetailType, ReasoningDetail.SummaryReasoningDetail, ReasoningDetail.TextReasoningDetail

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	NAME

Fields inherited from class org.elasticsearch.inference.completion.ReasoningDetail

REQUEST_PARSER, RESPONSE_PARSER

Fields inherited from interface org.elasticsearch.common.xcontent.ChunkedToXContent

EMPTY

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
TextReasoningDetail(String format, String id, Long index, String text, String signature)
TextReasoningDetail(StreamInput in)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
String	getWriteableName()	Returns the name of the writeable object
int	hashCode()
String	signature()
String	text()
String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
Iterator<? extends ToXContent>	toXContentChunked(ToXContent.Params params)	Create an iterator of ToXContent chunks for a REST response.
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class org.elasticsearch.inference.completion.ReasoningDetail

format, id, index, isFragment

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.common.xcontent.ChunkedToXContent

toXContentChunked, toXContentChunkedV8

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

Constructor Details

TextReasoningDetail

public TextReasoningDetail(@Nullable
 String format,
 @Nullable
 String id,
 @Nullable
 Long index,
 @Nullable
 String text,
 @Nullable
 String signature)

TextReasoningDetail

public TextReasoningDetail(StreamInput in)
                    throws IOException

Throws:

IOException

Method Details

text

public String text()

signature

public String signature()

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class ReasoningDetail

Throws:

IOException

toXContent

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

Specified by:

toXContent in interface ToXContent

Overrides:

toXContent in class ReasoningDetail

Throws:

IOException

toXContentChunked

public Iterator<? extends ToXContent> toXContentChunked(ToXContent.Params params)

Description copied from interface: ChunkedToXContent

Create an iterator of ToXContent chunks for a REST response. Each chunk is serialized with the same XContentBuilder and ToXContent.Params, which is also the same as the ToXContent.Params passed as the params argument. For best results, all chunks should be O(1) size. The last chunk in the iterator must always yield at least one byte of output. See also ChunkedToXContentHelper for some handy utilities.

Note that chunked response bodies cannot send deprecation warning headers once transmission has started, so implementations must check for deprecated feature use before returning.

Specified by:

toXContentChunked in interface ChunkedToXContent

Overrides:

toXContentChunked in class ReasoningDetail

Returns:

iterator over chunks of ToXContent

getWriteableName

public String getWriteableName()

Description copied from interface: NamedWriteable

Returns the name of the writeable object

equals

public boolean equals(Object o)

Overrides:

equals in class ReasoningDetail

hashCode

public int hashCode()

Overrides:

hashCode in class ReasoningDetail

toString

public String toString()

Overrides:

toString in class Object