llm4s-docs/org.llm4s/org.llm4s.javaapi/JCompletionOptions

JCompletionOptions

org.llm4s.javaapi.JCompletionOptions

See theJCompletionOptions companion object

The options of one completion request, built for Java and Kotlin callers and passed to JLlmClient.complete(Conversation, JCompletionOptions).

JCompletionOptions options = JCompletionOptions.builder()
   .temperature(0.2)
   .maxTokens(512)
   .reasoning(JReasoningEffort.HIGH)
   .build();
LlmResult<String> answer = client.complete(conversation, options);

A setting left unset keeps core's default: temperature 0.7, top-p 1.0, no presence or frequency penalty, and no token limit, reasoning level or thinking budget. A value that may be absent is read as an Optional or OptionalInt, and set either directly or with one, so an empty Optional clears it. No Scala type appears in a signature.

A value: two are equal when every setting is. Tools and response formats are not options here yet.

Attributes

Companion: object
Graph
Supertypes: class Object

trait Matchable

class Any

Members list

Value members

Concrete methods

The explicit thinking-token budget (Anthropic), or empty to derive one from reasoning.

Attributes

Compares the receiver object (this) with the argument object (that) for equivalence.

Any implementation of this method should be an equivalence relation:

It is reflexive: for any instance x of type Any, x.equals(x) should return true.
It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any instances x, y, and z of type Any if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.

If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is usually necessary to override hashCode to ensure that objects which are "equal" (o1.equals(o2) returns true) hash to the same scala.Int. (o1.hashCode.equals(o2.hashCode)).

Value parameters

that: the object to compare against this object for equality.

Attributes

Returns: true if the receiver object is equivalent to the argument; false otherwise.
Definition Classes: Any

The penalty for a token in proportion to how often it has appeared, discouraging repetition.

Attributes

Calculates a hash code value for the object.

The default hashing algorithm is platform dependent.

Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0. However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the equals method.

Attributes

Returns: the hash code value for this object.
Definition Classes: Any

The most tokens the completion may contain, or empty for the provider's default.

Attributes

The penalty for a token that has appeared at all, encouraging new topics.

Attributes

The reasoning level asked for, or empty for none.

Attributes

The sampling temperature: higher is more random. Reasoning models may ignore it.

Attributes

A builder that starts from these options.

Attributes

Returns a string representation of the object.

The default representation is platform dependent.

Attributes

Returns: a string representation of the object.
Definition Classes: Any

Nucleus sampling: only tokens within this cumulative probability are considered.

Attributes

In this article

Generated with