Module org.elasticsearch.server

Package org.elasticsearch.inference.completion

Class ReasoningDetail

java.lang.Object

org.elasticsearch.inference.completion.ReasoningDetail

All Implemented Interfaces:

NamedWriteable, Writeable, ChunkedToXContent, ChunkedToXContentObject, ToXContent, ToXContentObject

Direct Known Subclasses:

ReasoningDetail.EncryptedReasoningDetail, ReasoningDetail.SummaryReasoningDetail, ReasoningDetail.TextReasoningDetail

public abstract sealed class ReasoningDetail
extends Object
implements ToXContentObject, ChunkedToXContentObject, NamedWriteable
permits ReasoningDetail.EncryptedReasoningDetail, ReasoningDetail.SummaryReasoningDetail, ReasoningDetail.TextReasoningDetail

This class represents the reasoning detail for a message. It is a sealed class that has three implementations:

• ReasoningDetail.EncryptedReasoningDetail: contains encrypted reasoning data.
• ReasoningDetail.SummaryReasoningDetail: contains a summary of the reasoning.
• ReasoningDetail.TextReasoningDetail: may contain the reasoning in text form and/or a signature for the reasoning.

The type of the reasoning detail is determined by the type field, which is required for all reasoning details. Depending on the value of the type field, different fields are required or optional for the reasoning detail. Used for both request and response Chat Completion objects.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ReasoningDetail.EncryptedReasoningDetail	This class represents a reasoning detail, which contains encrypted reasoning data.
static enum	ReasoningDetail.ReasoningDetailType	The type of the reasoning detail, which determines the required and optional fields for the detail.
static final class	ReasoningDetail.SummaryReasoningDetail	This class represents a reasoning detail, which contains a summary of the reasoning.
static final class	ReasoningDetail.TextReasoningDetail	This class represents a reasoning detail, which may contain the reasoning in text form and/or a signature for the reasoning.

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 ConstructingObjectParser<ReasoningDetail,Void>	REQUEST_PARSER	The request parser does not ignore unknown fields, as we want to enforce strict validation of the reasoning details in the request.
static final ConstructingObjectParser<ReasoningDetail,Void>	RESPONSE_PARSER	The response parser ignores unknown fields to allow flexibility as the provider may add additional fields to the reasoning details, and we don't want to break parsing of the response if that happens.

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

EMPTY

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ReasoningDetail(String format, String id, Long index)
protected	ReasoningDetail(StreamInput in)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
String	format()
int	hashCode()
String	id()
Long	index()
boolean	isFragment()
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 java.lang.Object

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

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

toXContentChunked, toXContentChunkedV8

Methods inherited from interface org.elasticsearch.common.io.stream.NamedWriteable

getWriteableName

Field Details

REQUEST_PARSER

public static final ConstructingObjectParser<ReasoningDetail,Void> REQUEST_PARSER

The request parser does not ignore unknown fields, as we want to enforce strict validation of the reasoning details in the request.

RESPONSE_PARSER

public static final ConstructingObjectParser<ReasoningDetail,Void> RESPONSE_PARSER

The response parser ignores unknown fields to allow flexibility as the provider may add additional fields to the reasoning details, and we don't want to break parsing of the response if that happens. Validation of fields is not enforced for the response parser, as the response is generated by the provider

Constructor Details

ReasoningDetail

protected ReasoningDetail(@Nullable
 String format,
 @Nullable
 String id,
 @Nullable
 Long index)

ReasoningDetail

protected ReasoningDetail(StreamInput in)
                   throws IOException

Throws:

IOException

Method Details

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

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

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

Returns:

iterator over chunks of ToXContent

format

public String format()

id

public String id()

index

public Long index()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

isFragment

public boolean isFragment()

Specified by:

isFragment in interface ChunkedToXContent

Specified by:

isFragment in interface ChunkedToXContentObject

Specified by:

isFragment in interface ToXContent

Specified by:

isFragment in interface ToXContentObject

Returns:

true iff this instance serializes as a fragment. See ToXContentObject for additional details.