llm4s-docs/org.llm4s/org.llm4s.javaapi/JCompletion

JCompletion

org.llm4s.javaapi.JCompletion

See theJCompletion companion object

final class JCompletion

One model reply with what came with it, as JLlmClient.completion returns it: the text, the model that answered, the tool calls it asked for, the tokens it used and its estimated cost.

JCompletion reply = client.completion("What is 2+2?").get();
System.out.println(reply.model() + ": " + reply.content());
reply.usage().ifPresent(u -> System.out.println(u.promptTokens() + " in, " + u.completionTokens() + " out"));
reply.estimatedCost().ifPresent(cost -> System.out.println("$" + cost.toPlainString()));
reply.toolCalls().forEach(c -> System.out.println(c.name() + " " + c.argumentsJson()));

A value: two are equal when every field is. toString prints the full text, as the Scala Completion does, so mind what you log. Not Serializable.

Value parameters

content: the reply's text; empty, never null, when the model only asked for tool calls
estimatedCost: the estimated cost of the call in USD, or empty when it is not known (the provider reported no usage, or the model has no known pricing). The same figure an agent turn adds to its JUsageSummary.totalCost.
id: the provider's id for this reply
model: the model that answered, as the provider names it - which may be more specific than the one configured
thinking: the reasoning text the model reported, or empty when there was none
toolCalls: the tool calls the model asked for, in order, as the agent's JMessage.toolCalls lists them; empty when it asked for none. Unmodifiable.
usage: the tokens the call used, or empty when the provider did not report them

Attributes

Companion: object
Graph
Supertypes: class Object

trait Matchable

class Any

Members list

Value members

Concrete methods

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

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

Returns a string representation of the object.

The default representation is platform dependent.

Attributes

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

Concrete fields

In this article

Generated with