Index
All Classes and Interfaces|All Packages|Constant Field Values
C
- call() - Method in class edu.uky.cs.nil.tt.Client
- call() - Method in class edu.uky.cs.nil.tt.ClientFactory
- Client - Class in edu.uky.cs.nil.tt
-
A client connects to a
serverto find a partner and play arolein a storytellingsession. - Client(String) - Constructor for class edu.uky.cs.nil.tt.Client
-
Constructs a client with a given name, which has no preference for its role, world, or partner, reading the password and API key from the environment, and using the default network settings.
- Client(String, String, Role) - Constructor for class edu.uky.cs.nil.tt.Client
-
Constructs a client with a name, role, and world name, which has no preference for a partner, reading the password and API key from the environment, and using the default network settings.
- Client(String, String, Role, String) - Constructor for class edu.uky.cs.nil.tt.Client
-
Constructs a client with the given session preferences, reading the password and API key from the environment, and reading the network URL and port from the environment or using default values if they are not provided.
- Client(String, String, String, Role, String, String, String, int) - Constructor for class edu.uky.cs.nil.tt.Client
-
Constructs a client with the given session preferences, password, API key, and network details.
- ClientFactory - Class in edu.uky.cs.nil.tt
-
A client factory continuously creates
clientsto connect to aserverand is useful for deploying automated agents. - ClientFactory() - Constructor for class edu.uky.cs.nil.tt.ClientFactory
-
Creates a new client factory with no upper limit on the number of clients that may run simultaneously.
- ClientFactory(int) - Constructor for class edu.uky.cs.nil.tt.ClientFactory
-
Creates a new client factory with an upper limit on the number of clients that it will create simultaneously.
- close() - Method in class edu.uky.cs.nil.tt.Client
- close() - Method in class edu.uky.cs.nil.tt.ClientFactory
- complete(String...) - Method in class edu.uky.cs.nil.tt.ExternalAPI
-
Queries the external text completion API to generate text which is a fitting continuation of a series of messages.
- COMPLETE_IN_TOKENS_LIMIT - Static variable in class edu.uky.cs.nil.tt.ExternalAPI
-
The maximum number of input tokens that can be used by the text completion API during this client's session
- COMPLETE_OUT_TOKENS_LIMIT - Static variable in class edu.uky.cs.nil.tt.ExternalAPI
-
The maximum number of output tokens that can be used by the text completion API during this client's session
- connect(String, int) - Method in class edu.uky.cs.nil.tt.Client
-
Establishes a secure socket to the server based on this client's network configuration.
- create() - Method in class edu.uky.cs.nil.tt.ClientFactory
-
This method creates and returns a new client of the type produced by this factory.
D
- DEFAULT_PORT - Static variable in class edu.uky.cs.nil.tt.Client
-
The default network port the client will attempt to connect to if one is not explicitly provided in the constructor
- DEFAULT_URL - Static variable in class edu.uky.cs.nil.tt.Client
-
The default URL the client will attempt to connect to if one is not explicitly provided in the constructor
E
- edu.uky.cs.nil.tt - package edu.uky.cs.nil.tt
-
This library provides the abstract classes
ClientandClientFactoryfor implementing Tandem Tales agents in Java. - embed(String) - Method in class edu.uky.cs.nil.tt.ExternalAPI
-
Queries the external text embedding API to convert a string into a high-dimensional numeric vector.
- EMBED_TOKENS_LIMIT - Static variable in class edu.uky.cs.nil.tt.ExternalAPI
-
The maximum number of tokens that can be used by the text embedding API during this client's session
- ENVIRONMENT_VARIABLE_API_KEY - Static variable in class edu.uky.cs.nil.tt.Client
-
The name of the environment variable where the client expects to find the API key used to authenticate with the service that provides functions which require special external resources or computation.
- ENVIRONMENT_VARIABLE_PASSWORD - Static variable in class edu.uky.cs.nil.tt.Client
-
The name of the environment variable where the client expects to find the password this agent will use, unless the password is explicitly set by the agent's constructor.
- ENVIRONMENT_VARIABLE_PORT - Static variable in class edu.uky.cs.nil.tt.Client
-
The name of the environment variable where the client expects to find the network port to which it should connect, unless the port is explicitly set by the agent's constructor.
- ENVIRONMENT_VARIABLE_URL - Static variable in class edu.uky.cs.nil.tt.Client
-
The name of the environment variable where the client expects to find the network URL to which it should connect, unless the URL is explicitly set by the agent's constructor.
- external - Variable in class edu.uky.cs.nil.tt.Client
-
The external API used for text embedding and completion
- ExternalAPI - Class in edu.uky.cs.nil.tt
-
The external API is how a
clientcontacts remote services to perform computations the client cannot perform on its own. - ExternalAPI(String) - Constructor for class edu.uky.cs.nil.tt.ExternalAPI
-
Constructs an interface to the external API using an API key.
- ExternalAPI.ReasoningEffort - Enum Class in edu.uky.cs.nil.tt
-
Represents the different levels of effort that can be used by a reasoning model during
text completion.
G
- getChoices() - Method in class edu.uky.cs.nil.tt.Client
-
If it is currently this client's turn to act, this method returns the list of
turnsthey can take next. - getCompleteInTokensRemaining() - Method in class edu.uky.cs.nil.tt.ExternalAPI
-
Returns the number of input tokens that can be used for
text completionbeforethe limitis exceeded. - getCompleteInTokensUsed() - Method in class edu.uky.cs.nil.tt.ExternalAPI
-
Returns the number of input tokens used for
text completionso far during this session. - getCompleteMaxOutTokens() - Method in class edu.uky.cs.nil.tt.ExternalAPI
-
Returns the maximum number of output tokens that can be used when reasoning and generating a single response during
text completion. - getCompleteMinP() - Method in class edu.uky.cs.nil.tt.ExternalAPI
-
Returns the min p setting used during
text completion. - getCompleteOutTokensRemaining() - Method in class edu.uky.cs.nil.tt.ExternalAPI
-
Returns the number of output tokens that can be used for
text completionbeforethe limitis exceeded. - getCompleteOutTokensUsed() - Method in class edu.uky.cs.nil.tt.ExternalAPI
-
Returns the number of output tokens used for
text completionso far during this session. - getCompleteReasoningEffort() - Method in class edu.uky.cs.nil.tt.ExternalAPI
-
Returns the
level of reasoning effortthetext completionmodel will use when generating its response. - getCompleteTemperature() - Method in class edu.uky.cs.nil.tt.ExternalAPI
-
Returns the temperature used during
text completion. - getCompleteTopK() - Method in class edu.uky.cs.nil.tt.ExternalAPI
-
Returns the top k setting used during
text completion. - getCompleteTopP() - Method in class edu.uky.cs.nil.tt.ExternalAPI
-
Returns the top p setting used during
text completion. - getEmbedDimensions() - Method in class edu.uky.cs.nil.tt.ExternalAPI
-
Returns the number of dimensions that will be used when
embedding a string(i.e. the length of the vector returned byExternalAPI.embed(String)). - getEmbedTokensRemaining() - Method in class edu.uky.cs.nil.tt.ExternalAPI
-
Returns the number of tokens that can be used for
text embeddingbeforethe limitis exceeded. - getEmbedTokensUsed() - Method in class edu.uky.cs.nil.tt.ExternalAPI
-
Returns the number of tokens used for
text embeddingso far during this session. - getHistory() - Method in class edu.uky.cs.nil.tt.Client
-
Returns the list of all
turnsthat have been taken so far in this client's session that this client has observed. - getName() - Method in class edu.uky.cs.nil.tt.Client
-
Returns the client's name.
- getPartner() - Method in class edu.uky.cs.nil.tt.Client
-
Returns the name of the partner this client wants to play with.
- getRole() - Method in class edu.uky.cs.nil.tt.Client
-
Returns the role this client wants to play or is currently playing in its session.
- getSession() - Method in class edu.uky.cs.nil.tt.Client
-
Returns the ID of this client's session.
- getState() - Method in class edu.uky.cs.nil.tt.Client
-
Returns the current
stateof the story world. - getWorld() - Method in class edu.uky.cs.nil.tt.Client
-
Returns the
story worldin which this client's session is taking place. - getWorldName() - Method in class edu.uky.cs.nil.tt.Client
-
Returns the name of the story world this client will play in or is currently playing in.
H
- hasKey() - Method in class edu.uky.cs.nil.tt.ExternalAPI
-
Returns true if this interface to the external API has a key that can be used to authenticate with the external service.
- HIGH - Enum constant in enum class edu.uky.cs.nil.tt.ExternalAPI.ReasoningEffort
-
High reasoning effort
L
- LOW - Enum constant in enum class edu.uky.cs.nil.tt.ExternalAPI.ReasoningEffort
-
Lowest level of reasoning effort
M
- MAX - Enum constant in enum class edu.uky.cs.nil.tt.ExternalAPI.ReasoningEffort
-
Highest level of reasoning effort
- maxClients - Variable in class edu.uky.cs.nil.tt.ClientFactory
-
The maximum number of
clientsthat this factory will create to run simultaneously
N
- NONE - Enum constant in enum class edu.uky.cs.nil.tt.ExternalAPI.ReasoningEffort
-
Do not perform reasoning
O
- onChoice(Status) - Method in class edu.uky.cs.nil.tt.Client
-
This method is called each time it is this client's turn to make a choice in the story.
- onClose() - Method in class edu.uky.cs.nil.tt.Client
-
This method is called once if the client was
closed, if it was interrupted, or if the socket was disconnected. - onClose() - Method in class edu.uky.cs.nil.tt.ClientFactory
-
This method is called once after this factory stops creating new clients and has begun shutting down.
- onConnect(Connect) - Method in class edu.uky.cs.nil.tt.Client
-
This method is called after the client connects to the server and the server sends the list of available worlds and agents.
- onDisconnect() - Method in class edu.uky.cs.nil.tt.Client
-
If the client ever established its connection to the server, this method is called once right before the
Client.call()method returns or throws an exception. - onEnd(Ending) - Method in class edu.uky.cs.nil.tt.Client
-
This method is called once if the story reaches one of its
pre-defined endings. - onError(String) - Method in class edu.uky.cs.nil.tt.Client
-
This method is called if the server reports an
errorto this client. - onStart() - Method in class edu.uky.cs.nil.tt.ClientFactory
-
This method is called once when this factory begins running.
- onStart(World, Role, State) - Method in class edu.uky.cs.nil.tt.Client
-
This method is called once when the client's session starts.
- onStop() - Method in class edu.uky.cs.nil.tt.ClientFactory
-
This method is called once at the end of this factory's shutdown process after all clients have stopped running.
- onStop(String) - Method in class edu.uky.cs.nil.tt.Client
-
This method is called once when the client's session ends.
- onUpdate(Status) - Method in class edu.uky.cs.nil.tt.Client
-
This method is called each time the story world changes as a result of a turn the client observes.
- onWarning(String) - Method in class edu.uky.cs.nil.tt.Client
-
This method is called if this client encounters a problem which does not immediately require it to close but which may cause problems.
R
- receive() - Method in class edu.uky.cs.nil.tt.Client
-
This method blocks until the client receives a message from the server and then returns that message.
- receive(Class) - Method in class edu.uky.cs.nil.tt.Client
-
This method blocks until the client receives a message of a given type from the server.
S
- send(Message) - Method in class edu.uky.cs.nil.tt.Client
-
This method sends a message to the server.
- setCompleteMaxOutTokens(Integer) - Method in class edu.uky.cs.nil.tt.ExternalAPI
-
Sets the maximum number of output tokens that can be used when reasoning and generating a single response during
text completion. - setCompleteMinP(Float) - Method in class edu.uky.cs.nil.tt.ExternalAPI
-
Sets the min p setting used during
text completion. - setCompleteReasoningEffort(ExternalAPI.ReasoningEffort) - Method in class edu.uky.cs.nil.tt.ExternalAPI
-
Sets the
level of reasoning effortthetext completionmodel will use when generating its response. - setCompleteTemperature(Float) - Method in class edu.uky.cs.nil.tt.ExternalAPI
-
Sets the temperature to be used during
text completion. - setCompleteTopK(Integer) - Method in class edu.uky.cs.nil.tt.ExternalAPI
-
Sets the top k setting used during
text completion. - setCompleteTopP(Float) - Method in class edu.uky.cs.nil.tt.ExternalAPI
-
Sets the top p setting used during
text completion. - setEmbedDimensions(Integer) - Method in class edu.uky.cs.nil.tt.ExternalAPI
-
Sets the number of dimensions that will be used when
embedding a string(i.e. the length of the vector returned byExternalAPI.embed(String)). - setName(String) - Method in class edu.uky.cs.nil.tt.Client
-
Sets the name this client will use.
- setPartner(String) - Method in class edu.uky.cs.nil.tt.Client
-
Sets the name of the partner this client wants to play in its session.
- setPassword(String) - Method in class edu.uky.cs.nil.tt.Client
-
Sets the password this client will use.
- setRole(Role) - Method in class edu.uky.cs.nil.tt.Client
-
Sets the role this client wants to play in its session.
- setWorldName(String) - Method in class edu.uky.cs.nil.tt.Client
-
Sets the name of the story world this client wants to play in.
T
- toString() - Method in class edu.uky.cs.nil.tt.Client
- toString() - Method in class edu.uky.cs.nil.tt.ClientFactory
V
- valueOf(String) - Static method in enum class edu.uky.cs.nil.tt.ExternalAPI.ReasoningEffort
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class edu.uky.cs.nil.tt.ExternalAPI.ReasoningEffort
-
Returns an array containing the constants of this enum class, in the order they are declared.
All Classes and Interfaces|All Packages|Constant Field Values