Package com.tnsai.annotations

Enum Class Knowledge.Use

java.lang.Object

java.lang.Enum<Knowledge.Use>

com.tnsai.annotations.Knowledge.Use

All Implemented Interfaces:

Serializable, Comparable<Knowledge.Use>, Constable

Enclosing class:

Knowledge

public static enum Knowledge.Use
extends Enum<Knowledge.Use>

How a source's content reaches the model.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
DIRECT	The whole source enters the context.
SEARCH	Ranked retrieval per request, configured by Knowledge.search().
SEQUENTIAL	One unit per request, in order: each call contributes the source's next unit.

Method Summary

Modifier and Type	Method	Description
static Knowledge.Use	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Knowledge.Use[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

SEARCH

public static final Knowledge.Use SEARCH

Ranked retrieval per request, configured by Knowledge.search(). The default when use is unset.

DIRECT

public static final Knowledge.Use DIRECT

The whole source enters the context. Its estimated size, summed over the DIRECT sources in scope, must fit Knowledge.maxTokens() — or, when that is unset, a quarter of the model's input window. A source that does not fit fails; it never falls back to SEARCH.

SEQUENTIAL

public static final Knowledge.Use SEQUENTIAL

One unit per request, in order: each call contributes the source's next unit.

Method Details

values

public static Knowledge.Use[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static Knowledge.Use valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null