Index (picollm 1.2.2 API)

A B C D E F G H I L M P R S T U V
All Classes and Interfaces|All Packages|Serialized Form

A

addHumanRequest(String) - Method in class ai.picovoice.picollm.PicoLLMDialog: Adds a human request to the dialog.
addLLMResponse(String) - Method in class ai.picovoice.picollm.PicoLLMDialog: Adds an LLM response to the dialog.
ai.picovoice.picollm - package ai.picovoice.picollm

B

build() - Method in class ai.picovoice.picollm.GemmaChatDialog.Builder: Builds a new instance of GemmaChatDialog based on the configured settings.
build() - Method in class ai.picovoice.picollm.Llama2ChatDialog.Builder: Builds a new instance of Llama2ChatDialog based on the configured settings.
build() - Method in class ai.picovoice.picollm.Llama3ChatDialog.Builder: Builds a new instance of Llama3ChatDialog based on the configured settings.
build() - Method in class ai.picovoice.picollm.MistralChatDialog.Builder: Builds a new instance of MistralChatDialog based on the configured settings.
build() - Method in class ai.picovoice.picollm.MixtralChatDialog.Builder: Builds a new instance of MixtralChatDialog based on the configured settings.
build() - Method in class ai.picovoice.picollm.Phi2ChatDialog.Builder: Builds a new instance of Phi2ChatDialog based on the configured settings.
build() - Method in class ai.picovoice.picollm.Phi2QADialog.Builder: Builds a new instance of Phi2QADialog based on the configured settings.
build() - Method in class ai.picovoice.picollm.Phi35ChatDialog.Builder: Builds a new instance of Phi35ChatDialog based on the configured settings.
build() - Method in class ai.picovoice.picollm.Phi3ChatDialog.Builder: Builds a new instance of Phi3ChatDialog based on the configured settings.
build() - Method in class ai.picovoice.picollm.PicoLLM.Builder: Builds a new PicoLLM instance using values defined by the builder.
build() - Method in class ai.picovoice.picollm.PicoLLM.DialogBuilder: Constructs a PicoLLMDialog instance based on the configured settings.
build() - Method in class ai.picovoice.picollm.PicoLLMDialog.Builder: Builds a new instance of PicoLLMDialog based on the configured settings.
build() - Method in class ai.picovoice.picollm.PicoLLMGenerateParams.Builder: Constructs a new PicoLLMGenerateParams object.
build(String, String) - Method in class ai.picovoice.picollm.Phi2Dialog.Builder: Builds a new instance of Phi2Dialog based on the configured settings.
Builder() - Constructor for class ai.picovoice.picollm.GemmaChatDialog.Builder
Builder() - Constructor for class ai.picovoice.picollm.Llama2ChatDialog.Builder
Builder() - Constructor for class ai.picovoice.picollm.Llama3ChatDialog.Builder
Builder() - Constructor for class ai.picovoice.picollm.MistralChatDialog.Builder
Builder() - Constructor for class ai.picovoice.picollm.MixtralChatDialog.Builder
Builder() - Constructor for class ai.picovoice.picollm.Phi2ChatDialog.Builder
Builder() - Constructor for class ai.picovoice.picollm.Phi2Dialog.Builder
Builder() - Constructor for class ai.picovoice.picollm.Phi2QADialog.Builder
Builder() - Constructor for class ai.picovoice.picollm.Phi35ChatDialog.Builder
Builder() - Constructor for class ai.picovoice.picollm.Phi3ChatDialog.Builder
Builder() - Constructor for class ai.picovoice.picollm.PicoLLM.Builder
Builder() - Constructor for class ai.picovoice.picollm.PicoLLMDialog.Builder
Builder() - Constructor for class ai.picovoice.picollm.PicoLLMGenerateParams.Builder

C

callback(String) - Method in interface ai.picovoice.picollm.PicoLLMStreamCallback: Callback method invoked when a token has been generated by picoLLM.
COMPLETION_TOKEN_LIMIT_REACHED - Enum constant in enum class ai.picovoice.picollm.PicoLLMCompletion.Endpoint
CompletionToken(PicoLLMCompletion.Token, PicoLLMCompletion.Token[]) - Constructor for class ai.picovoice.picollm.PicoLLMCompletion.CompletionToken: Constructor for the CompletionToken class.

D

delete() - Method in class ai.picovoice.picollm.PicoLLM: Deletes the resources acquired by picoLLM.
DialogBuilder() - Constructor for class ai.picovoice.picollm.PicoLLM.DialogBuilder

E

END_OF_SENTENCE - Enum constant in enum class ai.picovoice.picollm.PicoLLMCompletion.Endpoint

F

forward(int) - Method in class ai.picovoice.picollm.PicoLLM: Performs a single forward pass given a token and returns the logits.

G

GemmaChatDialog - Class in ai.picovoice.picollm: Represents a dialog helper specific for `gemma-2b-it` and `gemma-7b-it` models.
GemmaChatDialog.Builder - Class in ai.picovoice.picollm: Builder class for constructing GemmaChatDialog instances.
generate(String, PicoLLMGenerateParams) - Method in class ai.picovoice.picollm.PicoLLM: Generates completion text and relevant metadata given a text prompt and a set of generation parameters.
getAvailableDevices() - Static method in class ai.picovoice.picollm.PicoLLM: Lists all available devices that picoLLM can use for inference.
getCompletion() - Method in class ai.picovoice.picollm.PicoLLMCompletion: Getter for the completion string.
getCompletionTokenLimit() - Method in class ai.picovoice.picollm.PicoLLMGenerateParams: Gets the maximum number of tokens allowed in the completion.
getCompletionTokens() - Method in class ai.picovoice.picollm.PicoLLMCompletion: Getter for the generated tokens within completion and top alternative tokens.
getCompletionTokens() - Method in class ai.picovoice.picollm.PicoLLMCompletion.Usage: Getter for the number of tokens in the completion.
getContextLength() - Method in class ai.picovoice.picollm.PicoLLM: Getter for model's context length.
getDialogBuilder() - Method in class ai.picovoice.picollm.PicoLLM: Retrieves a new instance of DialogBuilder for constructing dialog objects from the currently loaded picoLLM model.
getEndpoint() - Method in class ai.picovoice.picollm.PicoLLMCompletion: Getter for the reason for ending the generation process.
getFrequencyPenalty() - Method in class ai.picovoice.picollm.PicoLLMGenerateParams: Gets the frequency penalty.
getLogProb() - Method in class ai.picovoice.picollm.PicoLLMCompletion.Token: Getter for the log probability.
getMaxTopChoices() - Static method in class ai.picovoice.picollm.PicoLLM: Retrieves the maximum number of top choices allowed during generation.
getMessage() - Method in exception ai.picovoice.picollm.PicoLLMException
getMessageStack() - Method in exception ai.picovoice.picollm.PicoLLMException
getModel() - Method in class ai.picovoice.picollm.PicoLLM: Getter for model's name.
getNumTopChoices() - Method in class ai.picovoice.picollm.PicoLLMGenerateParams: Gets the number of top choices.
getPresencePenalty() - Method in class ai.picovoice.picollm.PicoLLMGenerateParams: Gets the presence penalty.
getPrompt() - Method in class ai.picovoice.picollm.GemmaChatDialog: Generates a formatted prompt string based on the dialog's content and configured settings.
getPrompt() - Method in class ai.picovoice.picollm.Llama2ChatDialog: Generates a formatted prompt string based on the dialog's content and configured settings.
getPrompt() - Method in class ai.picovoice.picollm.Llama3ChatDialog: Generates a formatted prompt string based on the dialog's content and configured settings.
getPrompt() - Method in class ai.picovoice.picollm.MistralChatDialog: Generates a formatted prompt string based on the dialog's content and configured settings.
getPrompt() - Method in class ai.picovoice.picollm.Phi2Dialog: Generates a prompt string based on the human requests and LLM responses.
getPrompt() - Method in class ai.picovoice.picollm.Phi3ChatDialog: Generates a formatted prompt string based on the dialog's content and configured settings.
getPrompt() - Method in class ai.picovoice.picollm.PicoLLMDialog: Creates a prompt string given parameters passed the constructor and dialog's content.
getPromptTokens() - Method in class ai.picovoice.picollm.PicoLLMCompletion.Usage: Getter for the number of tokens in the prompt.
getSeed() - Method in class ai.picovoice.picollm.PicoLLMGenerateParams: Gets the seed value for the internal random number generator.
getStopPhrases() - Method in class ai.picovoice.picollm.PicoLLMGenerateParams: Gets the phrases that trigger early completion termination.
getStreamCallback() - Method in class ai.picovoice.picollm.PicoLLMGenerateParams: Gets the completion stream callback.
getTemperature() - Method in class ai.picovoice.picollm.PicoLLMGenerateParams: Gets the temperature parameter.
getToken() - Method in class ai.picovoice.picollm.PicoLLMCompletion.CompletionToken: Getter for the token.
getToken() - Method in class ai.picovoice.picollm.PicoLLMCompletion.Token: Getter for the token.
getTopChoices() - Method in class ai.picovoice.picollm.PicoLLMCompletion.CompletionToken: Getter for the top alternative tokens.
getTopP() - Method in class ai.picovoice.picollm.PicoLLMGenerateParams: Gets the top-p parameter.
getUsage() - Method in class ai.picovoice.picollm.PicoLLMCompletion: Getter for usage information.
getVersion() - Static method in class ai.picovoice.picollm.PicoLLM: Retrieves the version of the picoLLM library.

H

history - Variable in class ai.picovoice.picollm.PicoLLMDialog.Builder
history - Variable in class ai.picovoice.picollm.PicoLLMDialog
humanRequests - Variable in class ai.picovoice.picollm.PicoLLMDialog

I

interrupt() - Method in class ai.picovoice.picollm.PicoLLM: Interrupts `.generate()` if generation is in progress.
INTERRUPTED - Enum constant in enum class ai.picovoice.picollm.PicoLLMCompletion.Endpoint

L

Llama2ChatDialog - Class in ai.picovoice.picollm: Represents a dialog helper specific for `llama-2-7b-chat`, `llama-2-13b-chat`, and `llama-2-70b-chat` models.
Llama2ChatDialog.Builder - Class in ai.picovoice.picollm: Builder class for constructing Llama2ChatDialog instances.
Llama3ChatDialog - Class in ai.picovoice.picollm: Represents a dialog helper specific for `llama-3-8b-instruct` and `llama-3-70b-instruct` models.
Llama3ChatDialog.Builder - Class in ai.picovoice.picollm: Builder class for constructing Llama3ChatDialog instances.
llmResponses - Variable in class ai.picovoice.picollm.PicoLLMDialog

M

MistralChatDialog - Class in ai.picovoice.picollm: Represents a dialog helper specific for `mistral-7b-instruct-v0.1` and `mistral-7b-instruct-v0.2` models.
MistralChatDialog.Builder - Class in ai.picovoice.picollm: Builder class for constructing MistralChatDialog instances.
MixtralChatDialog - Class in ai.picovoice.picollm: Represents a dialog helper specific for the `mixtral-8x7b-instruct-v0.1` model.
MixtralChatDialog.Builder - Class in ai.picovoice.picollm: Builder class for constructing MixtralChatDialog instances.

P

Phi2ChatDialog - Class in ai.picovoice.picollm: Represents a dialog helper specific for `phi-2` models in `chat` mode.
Phi2ChatDialog.Builder - Class in ai.picovoice.picollm: Builder class for constructing Phi2ChatDialog instances.
Phi2Dialog - Class in ai.picovoice.picollm: Represents a dialog helper for the 'phi-2' model within PicoLLM.
Phi2Dialog(String, String, Integer, String) - Constructor for class ai.picovoice.picollm.Phi2Dialog: Constructs a Phi2Dialog instance with the specified history, system, human tag, and LLM tag.
Phi2Dialog.Builder - Class in ai.picovoice.picollm: Builder class for constructing Phi2Dialog instances.
Phi2QADialog - Class in ai.picovoice.picollm: Represents a dialog helper specific for `phi-2` models in `qa` mode.
Phi2QADialog.Builder - Class in ai.picovoice.picollm: Builder class for constructing Phi2QADialog instances.
Phi35ChatDialog - Class in ai.picovoice.picollm: Represents a dialog helper specific for the `phi3.5` model.
Phi35ChatDialog.Builder - Class in ai.picovoice.picollm: Builder class for constructing Phi35ChatDialog instances.
Phi3ChatDialog - Class in ai.picovoice.picollm: Represents a dialog helper specific for the `phi3` model.
Phi3ChatDialog.Builder - Class in ai.picovoice.picollm: Builder class for constructing Phi3ChatDialog instances.
PicoLLM - Class in ai.picovoice.picollm: Android binding for picoLLM.
PicoLLM.Builder - Class in ai.picovoice.picollm: Builder class for creating a `PicoLLM` instance.
PicoLLM.DialogBuilder - Class in ai.picovoice.picollm: Builder class for creating a `PicoLLMDialog` instance.
PicoLLMActivationException - Exception in ai.picovoice.picollm
PicoLLMActivationException(String) - Constructor for exception ai.picovoice.picollm.PicoLLMActivationException
PicoLLMActivationException(String, String[]) - Constructor for exception ai.picovoice.picollm.PicoLLMActivationException
PicoLLMActivationException(Throwable) - Constructor for exception ai.picovoice.picollm.PicoLLMActivationException
PicoLLMActivationLimitException - Exception in ai.picovoice.picollm
PicoLLMActivationLimitException(String) - Constructor for exception ai.picovoice.picollm.PicoLLMActivationLimitException
PicoLLMActivationLimitException(String, String[]) - Constructor for exception ai.picovoice.picollm.PicoLLMActivationLimitException
PicoLLMActivationLimitException(Throwable) - Constructor for exception ai.picovoice.picollm.PicoLLMActivationLimitException
PicoLLMActivationRefusedException - Exception in ai.picovoice.picollm
PicoLLMActivationRefusedException(String) - Constructor for exception ai.picovoice.picollm.PicoLLMActivationRefusedException
PicoLLMActivationRefusedException(String, String[]) - Constructor for exception ai.picovoice.picollm.PicoLLMActivationRefusedException
PicoLLMActivationRefusedException(Throwable) - Constructor for exception ai.picovoice.picollm.PicoLLMActivationRefusedException
PicoLLMActivationThrottledException - Exception in ai.picovoice.picollm
PicoLLMActivationThrottledException(String) - Constructor for exception ai.picovoice.picollm.PicoLLMActivationThrottledException
PicoLLMActivationThrottledException(String, String[]) - Constructor for exception ai.picovoice.picollm.PicoLLMActivationThrottledException
PicoLLMActivationThrottledException(Throwable) - Constructor for exception ai.picovoice.picollm.PicoLLMActivationThrottledException
PicoLLMCompletion - Class in ai.picovoice.picollm: Represents a picoLLM completion result.
PicoLLMCompletion(PicoLLMCompletion.Usage, PicoLLMCompletion.Endpoint, PicoLLMCompletion.CompletionToken[], String) - Constructor for class ai.picovoice.picollm.PicoLLMCompletion: Constructor for the PicoLLMCompletion class.
PicoLLMCompletion.CompletionToken - Class in ai.picovoice.picollm: Represents a generated token within completion and top alternative tokens.
PicoLLMCompletion.Endpoint - Enum Class in ai.picovoice.picollm: Represents reasons for ending the generation process.
PicoLLMCompletion.Token - Class in ai.picovoice.picollm: Represents a generated token.
PicoLLMCompletion.Usage - Class in ai.picovoice.picollm: Represents usage information.
PicoLLMDialog - Class in ai.picovoice.picollm: `PicoLLMDialog` is a helper class that stores a chat dialog and formats it according to an instruction-tuned LLM's chat template.
PicoLLMDialog(Integer, String) - Constructor for class ai.picovoice.picollm.PicoLLMDialog: Constructs a new instance of PicoLLMDialog with the specified history and system settings.
PicoLLMDialog.Builder - Class in ai.picovoice.picollm: Builder class for constructing instances of PicoLLMDialog.
PicoLLMException - Exception in ai.picovoice.picollm
PicoLLMException(String) - Constructor for exception ai.picovoice.picollm.PicoLLMException
PicoLLMException(String, String[]) - Constructor for exception ai.picovoice.picollm.PicoLLMException
PicoLLMException(Throwable) - Constructor for exception ai.picovoice.picollm.PicoLLMException
PicoLLMGenerateParams - Class in ai.picovoice.picollm: Class for configuring generation parameters when calling `PicoLLM.generate()`.
PicoLLMGenerateParams(int, String[], int, float, float, float, float, int, PicoLLMStreamCallback) - Constructor for class ai.picovoice.picollm.PicoLLMGenerateParams: Constructor.
PicoLLMGenerateParams.Builder - Class in ai.picovoice.picollm: Builder class for creating a `PicoLLMGenerateParams` instance.
PicoLLMInvalidArgumentException - Exception in ai.picovoice.picollm
PicoLLMInvalidArgumentException(String) - Constructor for exception ai.picovoice.picollm.PicoLLMInvalidArgumentException
PicoLLMInvalidArgumentException(String, String[]) - Constructor for exception ai.picovoice.picollm.PicoLLMInvalidArgumentException
PicoLLMInvalidArgumentException(Throwable) - Constructor for exception ai.picovoice.picollm.PicoLLMInvalidArgumentException
PicoLLMInvalidStateException - Exception in ai.picovoice.picollm
PicoLLMInvalidStateException(String) - Constructor for exception ai.picovoice.picollm.PicoLLMInvalidStateException
PicoLLMInvalidStateException(String, String[]) - Constructor for exception ai.picovoice.picollm.PicoLLMInvalidStateException
PicoLLMInvalidStateException(Throwable) - Constructor for exception ai.picovoice.picollm.PicoLLMInvalidStateException
PicoLLMIOException - Exception in ai.picovoice.picollm
PicoLLMIOException(String) - Constructor for exception ai.picovoice.picollm.PicoLLMIOException
PicoLLMIOException(String, String[]) - Constructor for exception ai.picovoice.picollm.PicoLLMIOException
PicoLLMIOException(Throwable) - Constructor for exception ai.picovoice.picollm.PicoLLMIOException
PicoLLMKeyException - Exception in ai.picovoice.picollm
PicoLLMKeyException(String) - Constructor for exception ai.picovoice.picollm.PicoLLMKeyException
PicoLLMKeyException(String, String[]) - Constructor for exception ai.picovoice.picollm.PicoLLMKeyException
PicoLLMKeyException(Throwable) - Constructor for exception ai.picovoice.picollm.PicoLLMKeyException
PicoLLMMemoryException - Exception in ai.picovoice.picollm
PicoLLMMemoryException(String) - Constructor for exception ai.picovoice.picollm.PicoLLMMemoryException
PicoLLMMemoryException(String, String[]) - Constructor for exception ai.picovoice.picollm.PicoLLMMemoryException
PicoLLMMemoryException(Throwable) - Constructor for exception ai.picovoice.picollm.PicoLLMMemoryException
PicoLLMRuntimeException - Exception in ai.picovoice.picollm
PicoLLMRuntimeException(String) - Constructor for exception ai.picovoice.picollm.PicoLLMRuntimeException
PicoLLMRuntimeException(String, String[]) - Constructor for exception ai.picovoice.picollm.PicoLLMRuntimeException
PicoLLMRuntimeException(Throwable) - Constructor for exception ai.picovoice.picollm.PicoLLMRuntimeException
PicoLLMStopIterationException - Exception in ai.picovoice.picollm
PicoLLMStopIterationException(String) - Constructor for exception ai.picovoice.picollm.PicoLLMStopIterationException
PicoLLMStopIterationException(String, String[]) - Constructor for exception ai.picovoice.picollm.PicoLLMStopIterationException
PicoLLMStopIterationException(Throwable) - Constructor for exception ai.picovoice.picollm.PicoLLMStopIterationException
PicoLLMStreamCallback - Interface in ai.picovoice.picollm: Interface for receiving streaming result callbacks picoLLM's `.generate()` method.

R

reset() - Method in class ai.picovoice.picollm.PicoLLM: Resets the internal state of LLM.

S

setAccessKey(String) - Method in class ai.picovoice.picollm.PicoLLM.Builder: Sets the AccessKey.
setCompletionTokenLimit(Integer) - Method in class ai.picovoice.picollm.PicoLLMGenerateParams.Builder: Sets the maximum number of tokens allowed in the completion.
setCompletionTokenLimit(Integer) - Method in class ai.picovoice.picollm.PicoLLMGenerateParams: Sets the maximum number of tokens allowed in the completion.
setDevice(String) - Method in class ai.picovoice.picollm.PicoLLM.Builder: Sets the device to use for inference.
setFrequencyPenalty(float) - Method in class ai.picovoice.picollm.PicoLLMGenerateParams.Builder: Sets the frequency penalty.
setFrequencyPenalty(float) - Method in class ai.picovoice.picollm.PicoLLMGenerateParams: Sets the frequency penalty.
setHistory(int) - Method in class ai.picovoice.picollm.PicoLLM.DialogBuilder: Sets the history length for the dialog builder.
setHistory(Integer) - Method in class ai.picovoice.picollm.PicoLLMDialog.Builder: Sets the history length for the builder.
setMode(String) - Method in class ai.picovoice.picollm.PicoLLM.DialogBuilder: Sets the mode for the dialog builder.
setModelPath(String) - Method in class ai.picovoice.picollm.PicoLLM.Builder: Sets the model path.
setNumTopChoices(int) - Method in class ai.picovoice.picollm.PicoLLMGenerateParams.Builder: Sets the number of top choices.
setNumTopChoices(int) - Method in class ai.picovoice.picollm.PicoLLMGenerateParams: Sets the number of top choices.
setPresencePenalty(float) - Method in class ai.picovoice.picollm.PicoLLMGenerateParams.Builder: Sets the presence penalty.
setPresencePenalty(float) - Method in class ai.picovoice.picollm.PicoLLMGenerateParams: Sets the presence penalty.
setSdk(String) - Static method in class ai.picovoice.picollm.PicoLLM
setSeed(Integer) - Method in class ai.picovoice.picollm.PicoLLMGenerateParams.Builder: Sets the seed value for the internal random number generator.
setSeed(Integer) - Method in class ai.picovoice.picollm.PicoLLMGenerateParams: Sets the seed value for the internal random number generator.
setStopPhrases(String[]) - Method in class ai.picovoice.picollm.PicoLLMGenerateParams.Builder: Sets the phrases that trigger early completion termination.
setStopPhrases(String[]) - Method in class ai.picovoice.picollm.PicoLLMGenerateParams: Sets the phrases that trigger early completion termination.
setStreamCallback(PicoLLMStreamCallback) - Method in class ai.picovoice.picollm.PicoLLMGenerateParams.Builder: Sets the completion stream callback.
setStreamCallback(PicoLLMStreamCallback) - Method in class ai.picovoice.picollm.PicoLLMGenerateParams: Sets the completion stream callback.
setSystem(String) - Method in class ai.picovoice.picollm.PicoLLM.DialogBuilder: Sets the system instruction for the dialog builder.
setSystem(String) - Method in class ai.picovoice.picollm.PicoLLMDialog.Builder: Sets the system instruction for the builder.
setTemperature(float) - Method in class ai.picovoice.picollm.PicoLLMGenerateParams.Builder: Sets the temperature parameter.
setTemperature(float) - Method in class ai.picovoice.picollm.PicoLLMGenerateParams: Sets the temperature parameter.
setTopP(float) - Method in class ai.picovoice.picollm.PicoLLMGenerateParams.Builder: Sets the top-p parameter.
setTopP(float) - Method in class ai.picovoice.picollm.PicoLLMGenerateParams: Sets the top-p parameter.
STOP_PHRASE_ENCOUNTERED - Enum constant in enum class ai.picovoice.picollm.PicoLLMCompletion.Endpoint
system - Variable in class ai.picovoice.picollm.PicoLLMDialog.Builder
system - Variable in class ai.picovoice.picollm.PicoLLMDialog

T

Token(String, float) - Constructor for class ai.picovoice.picollm.PicoLLMCompletion.Token: Constructor for the Token class.
tokenize(String, boolean, boolean) - Method in class ai.picovoice.picollm.PicoLLM: Tokenizes a given text using the model's tokenizer.

U

Usage(int, int) - Constructor for class ai.picovoice.picollm.PicoLLMCompletion.Usage: Constructor for the Usage class.

V

valueOf(String) - Static method in enum class ai.picovoice.picollm.PicoLLMCompletion.Endpoint: Returns the enum constant of this class with the specified name.
values() - Static method in enum class ai.picovoice.picollm.PicoLLMCompletion.Endpoint: Returns an array containing the constants of this enum class, in the order they are declared.

A B C D E F G H I L M P R S T U V
All Classes and Interfaces|All Packages|Serialized Form