Index

A B C D E F H I J L M N O P Q R S T U W X
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

Answer - Interface in xyz.tcheeric.jev

An answer from the evaluator, typed to match the question that produced it.

Answer.Choice - Record Class in xyz.tcheeric.jev

Answer.Noul - Record Class in xyz.tcheeric.jev

Answer.Score - Record Class in xyz.tcheeric.jev

A rating against the question's ordered levels.

answers() - Method in record class xyz.tcheeric.jev.Evaluation

Returns the value of the answers record component.

apiErrorType() - Method in exception class xyz.tcheeric.jev.JevApiException

apiMessage() - Method in exception class xyz.tcheeric.jev.JevApiException

apiToken() - Method in record class xyz.tcheeric.jev.JevConfig

Returns the value of the apiToken record component.

B

backoffFor(int, double) - Method in record class xyz.tcheeric.jev.RetryPolicy

The wait before the attempt numbered attempt (1 means the wait after the first failure).

baseUri() - Method in record class xyz.tcheeric.jev.JevConfig

Returns the value of the baseUri record component.

C

choice(String) - Method in record class xyz.tcheeric.jev.Evaluation

Choice(String, Object, List<String>) - Constructor for record class xyz.tcheeric.jev.Question.Choice

Options that need no description beyond their names.

Choice(String, Object, Map<String, ?>) - Constructor for record class xyz.tcheeric.jev.Question.Choice

Creates an instance of a Choice record class.

Choice(String, Map<String, Double>, String, double) - Constructor for record class xyz.tcheeric.jev.Answer.Choice

Creates an instance of a Choice record class.

chosen() - Method in record class xyz.tcheeric.jev.Answer.Choice

Returns the value of the chosen record component.

close() - Method in class xyz.tcheeric.jev.JevClient

Idempotent, and guarded by a ReentrantLock rather than a synchronized block, which would pin the carrier thread of a virtual thread mid-request.

confidence() - Method in record class xyz.tcheeric.jev.Answer.Choice

Returns the value of the confidence record component.

confidence() - Method in record class xyz.tcheeric.jev.Answer.Score

Returns the value of the confidence record component.

criteria() - Method in record class xyz.tcheeric.jev.Question.Choice

Returns the value of the criteria record component.

D

decodeError(int, String, HttpHeaders) - Method in class xyz.tcheeric.jev.JevWireCodec

Pulls the API's own words out of an error response.

decodeModels(String) - Method in class xyz.tcheeric.jev.JevWireCodec

decodeResponse(String) - Method in class xyz.tcheeric.jev.JevWireCodec

DEFAULT_BASE_URI - Static variable in record class xyz.tcheeric.jev.JevConfig

DEFAULT_MODEL - Static variable in record class xyz.tcheeric.jev.JevConfig

A pinned, versioned model.

DEFAULT_REQUEST_TIMEOUT - Static variable in record class xyz.tcheeric.jev.JevConfig

defaults() - Static method in record class xyz.tcheeric.jev.RetryPolicy

description() - Method in record class xyz.tcheeric.jev.ModelCard

Returns the value of the description record component.

distribution() - Method in record class xyz.tcheeric.jev.Answer.Choice

Returns the value of the distribution record component.

distribution() - Method in record class xyz.tcheeric.jev.Answer.Score

Returns the value of the distribution record component.

E

encodeRequest(String, String, List<Question>) - Method in class xyz.tcheeric.jev.JevWireCodec

equals(Object) - Method in record class xyz.tcheeric.jev.Answer.Choice

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class xyz.tcheeric.jev.Answer.Noul

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class xyz.tcheeric.jev.Answer.Score

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class xyz.tcheeric.jev.Evaluation

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class xyz.tcheeric.jev.JevConfig

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class xyz.tcheeric.jev.ModelCard

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class xyz.tcheeric.jev.Question.Choice

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class xyz.tcheeric.jev.Question.Noul

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class xyz.tcheeric.jev.Question.Score

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class xyz.tcheeric.jev.RetryPolicy

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class xyz.tcheeric.jev.Usage

Indicates whether some other object is "equal to" this one.

evaluate(String, List<Question>) - Method in class xyz.tcheeric.jev.JevClient

Asks every question about one state in one request and returns the answers by name.

evaluate(String, Question...) - Method in class xyz.tcheeric.jev.JevClient

Evaluation - Record Class in xyz.tcheeric.jev

The answers to one fan-out of questions, keyed by the names the caller gave them, together with what the evaluation cost.

Evaluation(String, Map<String, Answer>, Usage) - Constructor for record class xyz.tcheeric.jev.Evaluation

Creates an instance of a Evaluation record class.

F

failureType() - Method in exception class xyz.tcheeric.jev.JevException

H

hashCode() - Method in record class xyz.tcheeric.jev.Answer.Choice

Returns a hash code value for this object.

hashCode() - Method in record class xyz.tcheeric.jev.Answer.Noul

Returns a hash code value for this object.

hashCode() - Method in record class xyz.tcheeric.jev.Answer.Score

Returns a hash code value for this object.

hashCode() - Method in record class xyz.tcheeric.jev.Evaluation

Returns a hash code value for this object.

hashCode() - Method in record class xyz.tcheeric.jev.JevConfig

Returns a hash code value for this object.

hashCode() - Method in record class xyz.tcheeric.jev.ModelCard

Returns a hash code value for this object.

hashCode() - Method in record class xyz.tcheeric.jev.Question.Choice

Returns a hash code value for this object.

hashCode() - Method in record class xyz.tcheeric.jev.Question.Noul

Returns a hash code value for this object.

hashCode() - Method in record class xyz.tcheeric.jev.Question.Score

Returns a hash code value for this object.

hashCode() - Method in record class xyz.tcheeric.jev.RetryPolicy

Returns a hash code value for this object.

hashCode() - Method in record class xyz.tcheeric.jev.Usage

Returns a hash code value for this object.

I

initialBackoff() - Method in record class xyz.tcheeric.jev.RetryPolicy

Returns the value of the initialBackoff record component.

inputTokens() - Method in record class xyz.tcheeric.jev.Usage

Returns the value of the inputTokens record component.

instructions() - Method in record class xyz.tcheeric.jev.Question.Choice

Returns the value of the instructions record component.

instructions() - Method in interface xyz.tcheeric.jev.Question

instructions() - Method in record class xyz.tcheeric.jev.Question.Noul

Returns the value of the instructions record component.

instructions() - Method in record class xyz.tcheeric.jev.Question.Score

Returns the value of the instructions record component.

J

JevApiException - Exception Class in xyz.tcheeric.jev

An error the API itself reported, carrying the HTTP status and what the API said, so a caller can tell a rejected token from a rejected question without reading prose.

JevClient - Class in xyz.tcheeric.jev

The one entry point into the evaluator.

JevClient(JevConfig) - Constructor for class xyz.tcheeric.jev.JevClient

JevClient(JevConfig, JevWireCodec) - Constructor for class xyz.tcheeric.jev.JevClient

Takes the codec explicitly so that a corrected wire format can be supplied without touching this class.

JevConfig - Record Class in xyz.tcheeric.jev

Everything the client needs that is not a question: where the evaluator lives, which model answers, how long to wait, and how hard to retry.

JevConfig(URI, String, String, Duration, RetryPolicy) - Constructor for record class xyz.tcheeric.jev.JevConfig

Creates an instance of a JevConfig record class.

JevException - Exception Class in xyz.tcheeric.jev

Every failure this library raises, unchecked, carrying the operation that failed and the kind of failure so a caller can branch on the kind without parsing a message.

JevException(String, String, String) - Constructor for exception class xyz.tcheeric.jev.JevException

JevException(String, String, String, Throwable) - Constructor for exception class xyz.tcheeric.jev.JevException

JevWireCodec - Class in xyz.tcheeric.jev

The single seam between this library's records and the evaluator's HTTP surface: paths, JSON field names and the headers that carry meaning.

JevWireCodec() - Constructor for class xyz.tcheeric.jev.JevWireCodec

jitterFactor() - Method in record class xyz.tcheeric.jev.RetryPolicy

Returns the value of the jitterFactor record component.

L

legend() - Method in record class xyz.tcheeric.jev.Answer.Score

Returns the value of the legend record component.

levels() - Method in record class xyz.tcheeric.jev.Question.Score

Returns the value of the levels record component.

M

MAX_LEVELS - Static variable in record class xyz.tcheeric.jev.Question.Score

MAX_OPTIONS - Static variable in record class xyz.tcheeric.jev.Question.Choice

The API's own ceiling, checked here so an oversized question fails before a round trip.

maxAttempts() - Method in record class xyz.tcheeric.jev.RetryPolicy

Returns the value of the maxAttempts record component.

maxBackoff() - Method in record class xyz.tcheeric.jev.RetryPolicy

Returns the value of the maxBackoff record component.

MIN_LEVELS - Static variable in record class xyz.tcheeric.jev.Question.Score

model() - Method in record class xyz.tcheeric.jev.Evaluation

Returns the value of the model record component.

model() - Method in record class xyz.tcheeric.jev.JevConfig

Returns the value of the model record component.

ModelCard - Record Class in xyz.tcheeric.jev

One entry of the evaluator's model list, as GET /v1/models reports it.

ModelCard(String, String, String) - Constructor for record class xyz.tcheeric.jev.ModelCard

Creates an instance of a ModelCard record class.

models() - Method in class xyz.tcheeric.jev.JevClient

The model names the account may send.

modelsPath() - Method in class xyz.tcheeric.jev.JevWireCodec

multiplier() - Method in record class xyz.tcheeric.jev.RetryPolicy

Returns the value of the multiplier record component.

N

name() - Method in record class xyz.tcheeric.jev.Answer.Choice

Returns the value of the name record component.

name() - Method in interface xyz.tcheeric.jev.Answer

name() - Method in record class xyz.tcheeric.jev.Answer.Noul

Returns the value of the name record component.

name() - Method in record class xyz.tcheeric.jev.Answer.Score

Returns the value of the name record component.

name() - Method in record class xyz.tcheeric.jev.ModelCard

Returns the value of the name record component.

name() - Method in record class xyz.tcheeric.jev.Question.Choice

Returns the value of the name record component.

name() - Method in interface xyz.tcheeric.jev.Question

name() - Method in record class xyz.tcheeric.jev.Question.Noul

Returns the value of the name record component.

name() - Method in record class xyz.tcheeric.jev.Question.Score

Returns the value of the name record component.

nextWait(int, double, Optional<Duration>) - Method in record class xyz.tcheeric.jev.RetryPolicy

The wait before the next attempt when the evaluator may have said how long to wait, or empty when the caller should stop retrying.

noul(String) - Method in record class xyz.tcheeric.jev.Evaluation

Noul(String, double) - Constructor for record class xyz.tcheeric.jev.Answer.Noul

Creates an instance of a Noul record class.

Noul(String, Object) - Constructor for record class xyz.tcheeric.jev.Question.Noul

Noul(String, Object, Object, Object) - Constructor for record class xyz.tcheeric.jev.Question.Noul

Creates an instance of a Noul record class.

O

of(String) - Static method in record class xyz.tcheeric.jev.JevConfig

The public evaluator at JevConfig.DEFAULT_BASE_URI.

of(URI, String) - Static method in record class xyz.tcheeric.jev.JevConfig

operation() - Method in exception class xyz.tcheeric.jev.JevException

outputTokens() - Method in record class xyz.tcheeric.jev.Usage

Returns the value of the outputTokens record component.

P

path() - Method in class xyz.tcheeric.jev.JevWireCodec

The path appended to the configured base URI for an evaluation.

probability() - Method in record class xyz.tcheeric.jev.Answer.Noul

Returns the value of the probability record component.

Q

Question - Interface in xyz.tcheeric.jev

A question put to the evaluator about a state.

Question.Choice - Record Class in xyz.tcheeric.jev

Pick one of a fixed set of options.

Question.Noul - Record Class in xyz.tcheeric.jev

Is this true.

Question.Score - Record Class in xyz.tcheeric.jev

Rate the state against an ordered rubric.

R

releaseDate() - Method in record class xyz.tcheeric.jev.ModelCard

Returns the value of the releaseDate record component.

requestedWait() - Method in exception class xyz.tcheeric.jev.JevApiException

How long the evaluator asked the caller to wait, when it said.

requestId() - Method in exception class xyz.tcheeric.jev.JevApiException

The evaluator's identifier for the failed request, which is what its operators ask for.

requestTimeout() - Method in record class xyz.tcheeric.jev.JevConfig

Returns the value of the requestTimeout record component.

retryable(int) - Static method in record class xyz.tcheeric.jev.RetryPolicy

Whether a status is worth repeating the request for.

retryPolicy() - Method in record class xyz.tcheeric.jev.JevConfig

Returns the value of the retryPolicy record component.

RetryPolicy - Record Class in xyz.tcheeric.jev

How hard, and how politely, to retry.

RetryPolicy(int, Duration, double, Duration, double) - Constructor for record class xyz.tcheeric.jev.RetryPolicy

Creates an instance of a RetryPolicy record class.

S

score() - Method in record class xyz.tcheeric.jev.Answer.Score

Returns the value of the score record component.

score(String) - Method in record class xyz.tcheeric.jev.Evaluation

Score(String, double, Map<Integer, String>, Map<Integer, Double>, double) - Constructor for record class xyz.tcheeric.jev.Answer.Score

Creates an instance of a Score record class.

Score(String, Object, List<?>) - Constructor for record class xyz.tcheeric.jev.Question.Score

Creates an instance of a Score record class.

status() - Method in exception class xyz.tcheeric.jev.JevApiException

T

toString() - Method in record class xyz.tcheeric.jev.Answer.Choice

Returns a string representation of this record class.

toString() - Method in record class xyz.tcheeric.jev.Answer.Noul

Returns a string representation of this record class.

toString() - Method in record class xyz.tcheeric.jev.Answer.Score

Returns a string representation of this record class.

toString() - Method in record class xyz.tcheeric.jev.Evaluation

Returns a string representation of this record class.

toString() - Method in record class xyz.tcheeric.jev.JevConfig

Keeps the token out of logs and crash dumps.

toString() - Method in record class xyz.tcheeric.jev.ModelCard

Returns a string representation of this record class.

toString() - Method in record class xyz.tcheeric.jev.Question.Choice

Returns a string representation of this record class.

toString() - Method in record class xyz.tcheeric.jev.Question.Noul

Returns a string representation of this record class.

toString() - Method in record class xyz.tcheeric.jev.Question.Score

Returns a string representation of this record class.

toString() - Method in record class xyz.tcheeric.jev.RetryPolicy

Returns a string representation of this record class.

toString() - Method in record class xyz.tcheeric.jev.Usage

Returns a string representation of this record class.

U

usage() - Method in record class xyz.tcheeric.jev.Evaluation

Returns the value of the usage record component.

Usage - Record Class in xyz.tcheeric.jev

What the evaluator reports it spent answering.

Usage(long, long) - Constructor for record class xyz.tcheeric.jev.Usage

Creates an instance of a Usage record class.

W

whenFalse() - Method in record class xyz.tcheeric.jev.Question.Noul

Returns the value of the whenFalse record component.

whenTrue() - Method in record class xyz.tcheeric.jev.Question.Noul

Returns the value of the whenTrue record component.

withModel(String) - Method in record class xyz.tcheeric.jev.JevConfig

withRequestTimeout(Duration) - Method in record class xyz.tcheeric.jev.JevConfig

withRetryPolicy(RetryPolicy) - Method in record class xyz.tcheeric.jev.JevConfig

X

xyz.tcheeric.jev - package xyz.tcheeric.jev

A Java client for TypeSafe's Jev evaluator.

A B C D E F H I J L M N O P Q R S T U W X
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form