All Classes and Interfaces

Class	Description
AiMessage	Represents a response message from an AI (language model).
And
AugmentationRequest	Represents a request for ChatMessage augmentation.
AugmentationResult	Represents the result of a ChatMessage augmentation.
BlankDocumentException
Chain<Input,Output>	Represents a chain step that takes an input and produces an output.
ChatLanguageModel	Represents a language model that has a chat interface.
ChatMemory	Represents the memory (history) of a chat conversation.
ChatMemoryStore	Represents a store for the ChatMemory state.
ChatMessage	A chat message.
ChatMessageDeserializer	A deserializer for ChatMessage objects.
ChatMessageJsonCodec	A codec for serializing and deserializing ChatMessage objects to and from JSON.
ChatMessageJsonCodecFactory	A factory for creating ChatMessageJsonCodec objects.
ChatMessageSerializer
ChatMessageType	The type of content, e.g.
ChatModelErrorContext	The error context.
ChatModelListener	A ChatLanguageModel listener that listens for requests, responses and errors.
ChatModelRequest	A request to the ChatLanguageModel or StreamingChatLanguageModel, intended to be used with ChatModelListener.
ChatModelRequestContext	The request context.
ChatModelResponse	A response from the ChatLanguageModel or StreamingChatLanguageModel, intended to be used with ChatModelListener.
ChatModelResponseContext	The response context.
CodeExecutionEngine	Interface for executing code.
CompressingQueryTransformer	A QueryTransformer that leverages a ChatLanguageModel to condense a given Query along with a chat memory (previous conversation history) into a concise Query.
Content	Abstract base interface for message content.
Content	Represents content relevant to a user Query with the potential to enhance and ground the LLM's response.
ContentAggregator	Aggregates all Contents retrieved from all ContentRetrievers using all Querys.
ContentInjector	Injects given Contents into a given UserMessage.
ContentRetriever	Retrieves Contents from an underlying data source using a given Query.
ContentType	The type of content, e.g.
CosineSimilarity	Utility class for calculating cosine similarity between two vectors.
DefaultContentAggregator	Default implementation of ContentAggregator intended to be suitable for the majority of use cases.
DefaultContentInjector	Default implementation of ContentInjector intended to be suitable for the majority of use cases.
DefaultQueryRouter	Default implementation of QueryRouter intended to be suitable for the majority of use cases.
DefaultQueryTransformer	Default implementation of QueryTransformer intended to be suitable for the majority of use cases.
DefaultRetrievalAugmentor	The default implementation of RetrievalAugmentor intended to be suitable for the majority of use cases.
DefaultRetrievalAugmentor.DefaultRetrievalAugmentorBuilder
DefaultStructuredPromptFactory	Default implementation of StructuredPromptFactory.
Description	Annotation to attach a description to a class field.
DimensionAwareEmbeddingModel	A dimension aware embedding model
DisabledChatLanguageModel	A ChatLanguageModel which throws a ModelDisabledException for all of its methods
DisabledEmbeddingModel	An EmbeddingModel which throws a ModelDisabledException for all of its methods
DisabledImageModel	An ImageModel which throws a ModelDisabledException for all of its methods
DisabledLanguageModel	A LanguageModel which throws a ModelDisabledException for all of its methods
DisabledModerationModel	A ModerationModel which throws a ModelDisabledException for all of its methods
DisabledStreamingChatLanguageModel	A StreamingChatLanguageModel which throws a ModelDisabledException for all of its methods
DisabledStreamingLanguageModel	A StreamingLanguageModel which throws a ModelDisabledException for all of its methods
Document	Represents an unstructured piece of text that usually corresponds to a content of a single file.
DocumentLoader	Utility class for loading documents.
DocumentParser	Defines the interface for parsing an InputStream into a Document.
DocumentParserFactory	A factory for creating DocumentParser instances through SPI.
DocumentSource	Defines the interface for a Document source.
DocumentSplitter	Defines the interface for splitting a document into text segments.
DocumentSplitterFactory	A factory for creating DocumentSplitter instances through SPI.
DocumentTransformer	Defines the interface for transforming a Document.
Embedding	Represents a dense vector embedding of a text.
EmbeddingMatch<Embedded>	Represents a matched embedding along with its relevance score (derivative of cosine distance), ID, and original embedded content.
EmbeddingModel	Represents a model that can convert a given text into an embedding (vector representation of the text).
EmbeddingModelFactory	A factory for creating EmbeddingModel instances through SPI.
EmbeddingSearchRequest	Represents a request to search in an EmbeddingStore.
EmbeddingSearchResult<Embedded>	Represents a result of a search in an EmbeddingStore.
EmbeddingStore<Embedded>	Represents a store for embeddings, also known as a vector database.
EmbeddingStoreContentRetriever	A ContentRetriever that retrieves from an EmbeddingStore.
EmbeddingStoreContentRetriever.EmbeddingStoreContentRetrieverBuilder
EmbeddingStoreIngestor	The EmbeddingStoreIngestor represents an ingestion pipeline and is responsible for ingesting Documents into an EmbeddingStore.
EmbeddingStoreIngestor.Builder	EmbeddingStoreIngestor builder.
Exceptions	Utility methods for creating common exceptions.
ExpandingQueryTransformer	A QueryTransformer that utilizes a ChatLanguageModel to expand a given Query.
Experimental	Indicates that a class/constructor/method is experimental and might change in the future.
Filter	This class represents a filter that can be applied during search in an EmbeddingStore.
FilterParser	Parses a filter expression string into a Filter object.
FinishReason	The reason why a model call finished.
GsonChatMessageJsonCodec	A codec for serializing and deserializing ChatMessage objects to and from JSON.
Image	Represents an image as a URL or as a Base64-encoded string.
Image.Builder	Builder for Image.
ImageContent	Represents an image with a DetailLevel.
ImageContent.DetailLevel	The detail level of an Image.
ImageModel	Text to Image generator model.
InMemoryChatMemoryStore	Implementation of ChatMemoryStore that stores state of ChatMemory (chat messages) in-memory.
IsEqualTo
IsGreaterThan
IsGreaterThanOrEqualTo
IsIn
IsLessThan
IsLessThanOrEqualTo
IsNotEqualTo
IsNotIn
JacocoIgnoreCoverageGenerated	Annotation to mark methods where JaCoCo coverage should be ignored.
Json	A utility class for JSON.
Json.JsonCodec	The abstract JSON codec interface.
JsonCodecFactory	A factory for creating Json.JsonCodec instances through SPI.
JsonSchemaProperty	Represents a property in a JSON schema.
LambdaStreamingResponseHandler<T>	Utility class with lambda-based streaming response handlers.
LanguageModel	Represents a language model that has a simple text interface (as opposed to a chat interface).
LanguageModelQueryRouter	A QueryRouter that utilizes a ChatLanguageModel to make a routing decision.
LanguageModelQueryRouter.FallbackStrategy	Strategy applied if the call to the LLM fails of if LLM does not return a valid response.
Metadata	Represents metadata of a Document or a TextSegment.
Metadata	Represents metadata that may be useful or necessary for retrieval or augmentation purposes.
MetadataFilterBuilder	A helper class for building a Filter for Metadata key.
ModelDisabledException	An exception thrown by a model that could be disabled by a user.
Moderation	Represents moderation status.
ModerationModel	Represents a model that can moderate text.
Not
Or
OutputParser<T>	Represents an output parser.
P	Parameter of a Tool
Prompt	Represents a prompt (an input text sent to the LLM).
PromptTemplate	Represents a template of a prompt that can be reused multiple times.
PromptTemplateFactory	A factory for creating prompt templates.
PromptTemplateFactory.Input	Interface for input for the factory.
PromptTemplateFactory.Template	Interface for a prompt template.
Query	Represents a query from the user intended for retrieving relevant Contents.
QueryRouter	Routes the given Query to one or multiple ContentRetrievers.
QueryTransformer	Transforms the given Query into one or multiple Querys.
ReciprocalRankFuser	Implementation of Reciprocal Rank Fusion.
RelevanceScore	Utility class for converting between cosine similarity and relevance score.
ReRankingContentAggregator	A ContentAggregator that performs re-ranking using a ScoringModel, such as Cohere.
Response<T>	Represents the response from various types of models, including language, chat, embedding, and moderation models.
RetrievalAugmentor	Augments the provided ChatMessage with retrieved Contents.
Retriever<T>	Deprecated.
RetryUtils	Utility class for retrying actions.
RetryUtils.RetryPolicy	This class encapsulates a retry policy.
RetryUtils.RetryPolicy.Builder	This class encapsulates a retry policy builder.
ScoringModel	Represents a model capable of scoring a text against a query.
ServiceHelper	Utility wrapper around ServiceLoader.load().
StreamingChatLanguageModel	Represents a language model that has a chat interface and can stream a response one token at a time.
StreamingLanguageModel	Represents a language model that has a simple text interface (as opposed to a chat interface) and can stream a response one token at a time.
StreamingResponseHandler<T>	Represents a handler for streaming responses from a language model.
StructuredPrompt	Represents a structured prompt.
StructuredPrompt.Util	Utility class for StructuredPrompt.
StructuredPromptFactory	Represents a factory for structured prompts.
StructuredPromptProcessor	Utility class for structured prompts.
SystemMessage	Represents a system message, typically defined by a developer.
TextClassifier<E>	Classifies given text according to specified enum.
TextContent	Represents a text content.
TextSegment	Represents a semantically meaningful segment (chunk/piece/fragment) of a larger entity such as a document or chat conversation.
TextSegmentTransformer	Defines the interface for transforming a TextSegment.
TokenCountEstimator	Represents an interface for estimating the count of tokens in various text types such as a text, message, prompt, text segment, etc.
TokenCountEstimator	Represents an interface for estimating the count of tokens in various texts, text segments, etc.
TokenCountEstimator	Represents an interface for estimating the count of tokens in various text types such as a text, prompt, text segment, etc.
Tokenizer	Represents an interface for estimating the count of tokens in various text types such as a text, prompt, text segment, etc.
TokenUsage	Represents the token usage of a response.
Tool	Java methods annotated with @Tool are considered tools/functions that language model can execute/call.
ToolExecutionRequest	Represents an LLM-generated request to execute a tool.
ToolExecutionRequest.Builder	ToolExecutionRequest builder static inner class.
ToolExecutionRequestUtil	Utility class for ToolExecutionRequest.
ToolExecutionResultMessage	Represents the result of a tool execution in response to a ToolExecutionRequest.
ToolMemoryId	If a Tool method parameter is annotated with this annotation, memory id (parameter annotated with @MemoryId in AI Service) will be injected automatically.
ToolParameters	Represents the parameters of a tool.
ToolParameters.Builder	ToolParameters builder static inner class.
ToolSpecification	Describes a Tool.
ToolSpecification.Builder	ToolSpecification builder static inner class.
ToolSpecifications	Utility methods for ToolSpecifications.
UserMessage	Represents a message from a user, typically an end user of the application.
Utils	Utility methods.
ValidationUtils	Utility class for validating method arguments.
WebSearchContentRetriever	A ContentRetriever that retrieves relevant Content from the web using a WebSearchEngine.
WebSearchEngine	Represents a web search engine that can be used to perform searches on the Web in response to a user query.
WebSearchInformationResult	Represents general information about the web search performed.
WebSearchOrganicResult	Represents an organic search results are the web pages that are returned by the search engine in response to a search query.
WebSearchRequest	Represents a search request that can be made by the user to perform searches in any implementation of WebSearchEngine.
WebSearchRequest.Builder
WebSearchResults	Represents the response of a web search performed.
WebSearchTool