Package co.elastic.clients.elasticsearch.inference

Class Reasoning

java.lang.Object
co.elastic.clients.elasticsearch.inference.Reasoning
All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable public class Reasoning extends Object implements JsonpSerializable
The reasoning configuration to use for the completion request. Currently supported only for elastic provider.
See Also:

  • Field Details

  • Method Details

    • of

      public static Reasoning of(Function<Reasoning.Builder,ObjectBuilder<Reasoning>> fn)

    • effort

      @Nullable public final ReasoningEffort effort()
      The level of effort the model should put into reasoning. This is a hint that guides the model in how much effort to put into reasoning, with xhigh being the most effort and none being no effort.

      API name: effort

    • enabled

      @Nullable public final Boolean enabled()
      Whether to enable reasoning with default settings. This is a shortcut for enabling reasoning without having to specify the other parameters. If enabled is set to true, then reasoning at the medium effort level is enabled. Ignored if effort is specified, in which case that parameter will control the reasoning process instead.

      API name: enabled

    • exclude

      @Nullable public final Boolean exclude()
      Whether to exclude reasoning information from the response. If true, the response will not include any reasoning details.

      API name: exclude

    • summary

      @Nullable public final ReasoningSummary summary()
      The level of detail included in the reasoning summary returned in the response. This is a hint on how much detail to include in the summary of the reasoning that is returned in the response, with auto being the default level of detail, concise being less detail, and detailed being more detail.

      API name: summary

    • serialize

      public void serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
      Serialize this object to JSON.
      Specified by:
      serialize in interface JsonpSerializable

    • serializeInternal

      protected void serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • rebuild

      public Reasoning.Builder rebuild()
      Returns:
      New Reasoning.Builder initialized with field values of this instance

    • setupReasoningDeserializer

      protected static void setupReasoningDeserializer(ObjectDeserializer<Reasoning.Builder> op)