Package co.elastic.clients.elasticsearch.inference

Class Reasoning.Builder

java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<Reasoning.Builder>
co.elastic.clients.elasticsearch.inference.Reasoning.Builder
All Implemented Interfaces:
WithJson<Reasoning.Builder>, ObjectBuilder<Reasoning>
Enclosing class:
Reasoning
public static class Reasoning.Builder extends WithJsonObjectBuilderBase<Reasoning.Builder> implements ObjectBuilder<Reasoning>
Builder for Reasoning.

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • effort

      public final Reasoning.Builder effort(@Nullable ReasoningEffort value)
      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

      public final Reasoning.Builder enabled(@Nullable Boolean value)
      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

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

      API name: exclude

    • summary

      public final Reasoning.Builder summary(@Nullable ReasoningSummary value)
      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

    • self

      protected Reasoning.Builder self()
      Specified by:
      self in class WithJsonObjectBuilderBase<Reasoning.Builder>

    • build

      public Reasoning build()
      Builds a Reasoning.
      Specified by:
      build in interface ObjectBuilder<Reasoning>
      Throws:
      NullPointerException - if some of the required fields are null.