Module org.elasticsearch.server

Package org.elasticsearch.inference.completion

Class Reasoning

java.lang.Object

org.elasticsearch.inference.completion.Reasoning

All Implemented Interfaces:

NamedWriteable, Writeable, ToXContent, ToXContentObject

public final class Reasoning
extends Object
implements ToXContentObject, NamedWriteable

This class represents the reasoning configuration for a completion request. It encapsulates various parameters that control the reasoning process.

See Also:

• Reasoning.ReasoningEffort
• Reasoning.ReasoningSummary

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Reasoning.ReasoningEffort	Enum representing the reasoning effort levels.
static enum	Reasoning.ReasoningSummary	Enum representing the reasoning summary levels.

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
static final ConstructingObjectParser<Reasoning,Void>	PARSER

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
Reasoning(StreamInput in)
Reasoning(Reasoning.ReasoningEffort effort, Reasoning.ReasoningSummary summary, Boolean exclude, Boolean enabled)	Constructor returning instance of Reasoning.

Method Summary

Modifier and Type	Method	Description
Reasoning.ReasoningEffort	effort()
Boolean	enabled()
boolean	equals(Object obj)
Boolean	exclude()
String	getWriteableName()	Returns the name of the writeable object
int	hashCode()
Reasoning.ReasoningSummary	summary()
String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

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

NAME

public static final String NAME

See Also:

• Constant Field Values

PARSER

public static final ConstructingObjectParser<Reasoning,Void> PARSER

Constructor Details

Reasoning

public Reasoning(@Nullable
 Reasoning.ReasoningEffort effort,
 @Nullable
 Reasoning.ReasoningSummary summary,
 @Nullable
 Boolean exclude,
 @Nullable
 Boolean enabled)

Constructor returning instance of Reasoning.

Parameters:

effort - The Reasoning.ReasoningEffort level to apply. This is an optional parameter.

summary - The Reasoning.ReasoningSummary level to provide. This is an optional parameter.

exclude - Whether to exclude reasoning from the response. This is an optional parameter.

enabled - Whether to enable reasoning. This is an optional parameter.

Reasoning

public Reasoning(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

getWriteableName

public String getWriteableName()

Description copied from interface: NamedWriteable

Returns the name of the writeable object

Specified by:

getWriteableName in interface NamedWriteable

effort

@Nullable
public Reasoning.ReasoningEffort effort()

summary

@Nullable
public Reasoning.ReasoningSummary summary()

exclude

@Nullable
public Boolean exclude()

enabled

@Nullable
public Boolean enabled()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object