Index (Spring AI RAG 1.0.3 API)

A B C D E F G H I J M N O P Q R S T V
All Classes and Interfaces|All Packages|Constant Field Values

A

after(ChatClientResponse, AdvisorChain) - Method in class org.springframework.ai.rag.advisor.RetrievalAugmentationAdvisor
allowEmptyContext(Boolean) - Method in class org.springframework.ai.rag.generation.augmentation.ContextualQueryAugmenter.Builder
apply(Map<Query, List<List<Document>>>) - Method in interface org.springframework.ai.rag.retrieval.join.DocumentJoiner
apply(Query) - Method in interface org.springframework.ai.rag.preretrieval.query.expansion.QueryExpander
apply(Query) - Method in interface org.springframework.ai.rag.preretrieval.query.transformation.QueryTransformer
apply(Query) - Method in interface org.springframework.ai.rag.retrieval.search.DocumentRetriever
apply(Query, List<Document>) - Method in interface org.springframework.ai.rag.generation.augmentation.QueryAugmenter
apply(Query, List<Document>) - Method in interface org.springframework.ai.rag.postretrieval.document.DocumentPostProcessor
augment(Query, List<Document>) - Method in class org.springframework.ai.rag.generation.augmentation.ContextualQueryAugmenter
augment(Query, List<Document>) - Method in interface org.springframework.ai.rag.generation.augmentation.QueryAugmenter: Augments the user query with contextual data.

B

before(ChatClientRequest, AdvisorChain) - Method in class org.springframework.ai.rag.advisor.RetrievalAugmentationAdvisor
build() - Method in class org.springframework.ai.rag.advisor.RetrievalAugmentationAdvisor.Builder
build() - Method in class org.springframework.ai.rag.generation.augmentation.ContextualQueryAugmenter.Builder
build() - Method in class org.springframework.ai.rag.preretrieval.query.expansion.MultiQueryExpander.Builder
build() - Method in class org.springframework.ai.rag.preretrieval.query.transformation.CompressionQueryTransformer.Builder
build() - Method in class org.springframework.ai.rag.preretrieval.query.transformation.RewriteQueryTransformer.Builder
build() - Method in class org.springframework.ai.rag.preretrieval.query.transformation.TranslationQueryTransformer.Builder
build() - Method in class org.springframework.ai.rag.Query.Builder
build() - Method in class org.springframework.ai.rag.retrieval.search.VectorStoreDocumentRetriever.Builder
builder() - Static method in class org.springframework.ai.rag.advisor.RetrievalAugmentationAdvisor
builder() - Static method in class org.springframework.ai.rag.generation.augmentation.ContextualQueryAugmenter
builder() - Static method in class org.springframework.ai.rag.preretrieval.query.expansion.MultiQueryExpander
builder() - Static method in class org.springframework.ai.rag.preretrieval.query.transformation.CompressionQueryTransformer
builder() - Static method in class org.springframework.ai.rag.preretrieval.query.transformation.RewriteQueryTransformer
builder() - Static method in class org.springframework.ai.rag.preretrieval.query.transformation.TranslationQueryTransformer
builder() - Static method in record class org.springframework.ai.rag.Query
builder() - Static method in class org.springframework.ai.rag.retrieval.search.VectorStoreDocumentRetriever
Builder() - Constructor for class org.springframework.ai.rag.generation.augmentation.ContextualQueryAugmenter.Builder

C

chatClientBuilder(ChatClient.Builder) - Method in class org.springframework.ai.rag.preretrieval.query.expansion.MultiQueryExpander.Builder
chatClientBuilder(ChatClient.Builder) - Method in class org.springframework.ai.rag.preretrieval.query.transformation.CompressionQueryTransformer.Builder
chatClientBuilder(ChatClient.Builder) - Method in class org.springframework.ai.rag.preretrieval.query.transformation.RewriteQueryTransformer.Builder
chatClientBuilder(ChatClient.Builder) - Method in class org.springframework.ai.rag.preretrieval.query.transformation.TranslationQueryTransformer.Builder
CompressionQueryTransformer - Class in org.springframework.ai.rag.preretrieval.query.transformation: Uses a large language model to compress a conversation history and a follow-up query into a standalone query that captures the essence of the conversation.
CompressionQueryTransformer(ChatClient.Builder, PromptTemplate) - Constructor for class org.springframework.ai.rag.preretrieval.query.transformation.CompressionQueryTransformer
CompressionQueryTransformer.Builder - Class in org.springframework.ai.rag.preretrieval.query.transformation
ConcatenationDocumentJoiner - Class in org.springframework.ai.rag.retrieval.join: Combines documents retrieved based on multiple queries and from multiple data sources by concatenating them into a single collection of documents.
ConcatenationDocumentJoiner() - Constructor for class org.springframework.ai.rag.retrieval.join.ConcatenationDocumentJoiner
context() - Method in record class org.springframework.ai.rag.Query: Returns the value of the context record component.
context(Map<String, Object>) - Method in class org.springframework.ai.rag.Query.Builder
ContextualQueryAugmenter - Class in org.springframework.ai.rag.generation.augmentation: Augments the user query with contextual data from the content of the provided documents.
ContextualQueryAugmenter(PromptTemplate, PromptTemplate, Boolean, Function<List<Document>, String>) - Constructor for class org.springframework.ai.rag.generation.augmentation.ContextualQueryAugmenter
ContextualQueryAugmenter.Builder - Class in org.springframework.ai.rag.generation.augmentation

D

DOCUMENT_CONTEXT - Static variable in class org.springframework.ai.rag.advisor.RetrievalAugmentationAdvisor
documentFormatter(Function<List<Document>, String>) - Method in class org.springframework.ai.rag.generation.augmentation.ContextualQueryAugmenter.Builder
documentJoiner(DocumentJoiner) - Method in class org.springframework.ai.rag.advisor.RetrievalAugmentationAdvisor.Builder
DocumentJoiner - Interface in org.springframework.ai.rag.retrieval.join: A component for combining documents retrieved based on multiple queries and from multiple data sources into a single collection of documents.
DocumentPostProcessor - Interface in org.springframework.ai.rag.postretrieval.document: A component for post-processing retrieved documents based on a query, addressing challenges such as "lost-in-the-middle", context length restrictions from the model, and the need to reduce noise and redundancy in the retrieved information.
documentPostProcessors(List<DocumentPostProcessor>) - Method in class org.springframework.ai.rag.advisor.RetrievalAugmentationAdvisor.Builder
documentPostProcessors(DocumentPostProcessor...) - Method in class org.springframework.ai.rag.advisor.RetrievalAugmentationAdvisor.Builder
documentRetriever(DocumentRetriever) - Method in class org.springframework.ai.rag.advisor.RetrievalAugmentationAdvisor.Builder
DocumentRetriever - Interface in org.springframework.ai.rag.retrieval.search: Component responsible for retrieving Documents from an underlying data source, such as a search engine, a vector store, a database, or a knowledge graph.

E

emptyContextPromptTemplate(PromptTemplate) - Method in class org.springframework.ai.rag.generation.augmentation.ContextualQueryAugmenter.Builder
equals(Object) - Method in record class org.springframework.ai.rag.Query: Indicates whether some other object is "equal to" this one.
expand(Query) - Method in class org.springframework.ai.rag.preretrieval.query.expansion.MultiQueryExpander
expand(Query) - Method in interface org.springframework.ai.rag.preretrieval.query.expansion.QueryExpander: Expands the given query into a list of queries.

F

FILTER_EXPRESSION - Static variable in class org.springframework.ai.rag.retrieval.search.VectorStoreDocumentRetriever
filterExpression(Supplier<Filter.Expression>) - Method in class org.springframework.ai.rag.retrieval.search.VectorStoreDocumentRetriever.Builder
filterExpression(Filter.Expression) - Method in class org.springframework.ai.rag.retrieval.search.VectorStoreDocumentRetriever.Builder

G

getOrder() - Method in class org.springframework.ai.rag.advisor.RetrievalAugmentationAdvisor
getScheduler() - Method in class org.springframework.ai.rag.advisor.RetrievalAugmentationAdvisor

H

hashCode() - Method in record class org.springframework.ai.rag.Query: Returns a hash code value for this object.
history() - Method in record class org.springframework.ai.rag.Query: Returns the value of the history record component.
history(List<Message>) - Method in class org.springframework.ai.rag.Query.Builder
history(Message...) - Method in class org.springframework.ai.rag.Query.Builder

I

includeOriginal(Boolean) - Method in class org.springframework.ai.rag.preretrieval.query.expansion.MultiQueryExpander.Builder

J

join(Map<Query, List<List<Document>>>) - Method in class org.springframework.ai.rag.retrieval.join.ConcatenationDocumentJoiner
join(Map<Query, List<List<Document>>>) - Method in interface org.springframework.ai.rag.retrieval.join.DocumentJoiner: Joins documents retrieved across multiple queries and daa sources.

M

MultiQueryExpander - Class in org.springframework.ai.rag.preretrieval.query.expansion: Uses a large language model to expand a query into multiple semantically diverse variations to capture different perspectives, useful for retrieving additional contextual information and increasing the chances of finding relevant results.
MultiQueryExpander(ChatClient.Builder, PromptTemplate, Boolean, Integer) - Constructor for class org.springframework.ai.rag.preretrieval.query.expansion.MultiQueryExpander
MultiQueryExpander.Builder - Class in org.springframework.ai.rag.preretrieval.query.expansion
mutate() - Method in record class org.springframework.ai.rag.Query

N

numberOfQueries(Integer) - Method in class org.springframework.ai.rag.preretrieval.query.expansion.MultiQueryExpander.Builder

O

order(Integer) - Method in class org.springframework.ai.rag.advisor.RetrievalAugmentationAdvisor.Builder
org.springframework.ai.rag - package org.springframework.ai.rag: This package contains the core interfaces and classes supporting Retrieval Augmented Generation flows.
org.springframework.ai.rag.advisor - package org.springframework.ai.rag.advisor
org.springframework.ai.rag.generation - package org.springframework.ai.rag.generation: RAG Module: Generation.
org.springframework.ai.rag.generation.augmentation - package org.springframework.ai.rag.generation.augmentation: RAG Sub-Module: Query Augmentation.
org.springframework.ai.rag.postretrieval - package org.springframework.ai.rag.postretrieval: RAG Module: Post-Retrieval.
org.springframework.ai.rag.postretrieval.document - package org.springframework.ai.rag.postretrieval.document
org.springframework.ai.rag.preretrieval - package org.springframework.ai.rag.preretrieval: RAG Module: Pre-Retrieval.
org.springframework.ai.rag.preretrieval.query.expansion - package org.springframework.ai.rag.preretrieval.query.expansion: RAG Sub-Module: Query Expansion.
org.springframework.ai.rag.preretrieval.query.transformation - package org.springframework.ai.rag.preretrieval.query.transformation: RAG Sub-Module: Query Transformation.
org.springframework.ai.rag.retrieval.join - package org.springframework.ai.rag.retrieval.join: RAG Sub-Module: Document Join.
org.springframework.ai.rag.retrieval.search - package org.springframework.ai.rag.retrieval.search: RAG Sub-Module: Document Search.
org.springframework.ai.rag.util - package org.springframework.ai.rag.util

P

process(Query, List<Document>) - Method in interface org.springframework.ai.rag.postretrieval.document.DocumentPostProcessor
PromptAssert - Class in org.springframework.ai.rag.util: Assertion utility class that assists in validating arguments for prompt-related operations.
promptTemplate(PromptTemplate) - Method in class org.springframework.ai.rag.generation.augmentation.ContextualQueryAugmenter.Builder
promptTemplate(PromptTemplate) - Method in class org.springframework.ai.rag.preretrieval.query.expansion.MultiQueryExpander.Builder
promptTemplate(PromptTemplate) - Method in class org.springframework.ai.rag.preretrieval.query.transformation.CompressionQueryTransformer.Builder
promptTemplate(PromptTemplate) - Method in class org.springframework.ai.rag.preretrieval.query.transformation.RewriteQueryTransformer.Builder
promptTemplate(PromptTemplate) - Method in class org.springframework.ai.rag.preretrieval.query.transformation.TranslationQueryTransformer.Builder

Q

Query - Record Class in org.springframework.ai.rag: Represents a query in the context of a Retrieval Augmented Generation (RAG) flow.
Query(String) - Constructor for record class org.springframework.ai.rag.Query
Query(String, List<Message>, Map<String, Object>) - Constructor for record class org.springframework.ai.rag.Query: Creates an instance of a Query record class.
Query.Builder - Class in org.springframework.ai.rag
queryAugmenter(QueryAugmenter) - Method in class org.springframework.ai.rag.advisor.RetrievalAugmentationAdvisor.Builder
QueryAugmenter - Interface in org.springframework.ai.rag.generation.augmentation: A component for augmenting an input query with additional data, useful to provide a large language model with the necessary context to answer the user query.
queryExpander(QueryExpander) - Method in class org.springframework.ai.rag.advisor.RetrievalAugmentationAdvisor.Builder
QueryExpander - Interface in org.springframework.ai.rag.preretrieval.query.expansion: A component for expanding the input query into a list of queries, addressing challenges such as poorly formed queries by providing alternative query formulations, or by breaking down complex problems into simpler sub-queries.
QueryTransformer - Interface in org.springframework.ai.rag.preretrieval.query.transformation: A component for transforming the input query to make it more effective for retrieval tasks, addressing challenges such as poorly formed queries, ambiguous terms, complex vocabulary, or unsupported languages.
queryTransformers(List<QueryTransformer>) - Method in class org.springframework.ai.rag.advisor.RetrievalAugmentationAdvisor.Builder
queryTransformers(QueryTransformer...) - Method in class org.springframework.ai.rag.advisor.RetrievalAugmentationAdvisor.Builder

R

RetrievalAugmentationAdvisor - Class in org.springframework.ai.rag.advisor: Advisor that implements common Retrieval Augmented Generation (RAG) flows using the building blocks defined in the org.springframework.ai.rag package and following the Modular RAG Architecture.
RetrievalAugmentationAdvisor.Builder - Class in org.springframework.ai.rag.advisor
retrieve(Query) - Method in interface org.springframework.ai.rag.retrieval.search.DocumentRetriever: Retrieves relevant documents from an underlying data source based on the given query.
retrieve(Query) - Method in class org.springframework.ai.rag.retrieval.search.VectorStoreDocumentRetriever
RewriteQueryTransformer - Class in org.springframework.ai.rag.preretrieval.query.transformation: Uses a large language model to rewrite a user query to provide better results when querying a target system, such as a vector store or a web search engine.
RewriteQueryTransformer(ChatClient.Builder, PromptTemplate, String) - Constructor for class org.springframework.ai.rag.preretrieval.query.transformation.RewriteQueryTransformer
RewriteQueryTransformer.Builder - Class in org.springframework.ai.rag.preretrieval.query.transformation

S

scheduler(Scheduler) - Method in class org.springframework.ai.rag.advisor.RetrievalAugmentationAdvisor.Builder
similarityThreshold(Double) - Method in class org.springframework.ai.rag.retrieval.search.VectorStoreDocumentRetriever.Builder

T

targetLanguage(String) - Method in class org.springframework.ai.rag.preretrieval.query.transformation.TranslationQueryTransformer.Builder
targetSearchSystem(String) - Method in class org.springframework.ai.rag.preretrieval.query.transformation.RewriteQueryTransformer.Builder
taskExecutor(TaskExecutor) - Method in class org.springframework.ai.rag.advisor.RetrievalAugmentationAdvisor.Builder
templateHasRequiredPlaceholders(PromptTemplate, String...) - Static method in class org.springframework.ai.rag.util.PromptAssert: Assert that the given prompt template contains the required placeholders.
text() - Method in record class org.springframework.ai.rag.Query: Returns the value of the text record component.
text(String) - Method in class org.springframework.ai.rag.Query.Builder
topK(Integer) - Method in class org.springframework.ai.rag.retrieval.search.VectorStoreDocumentRetriever.Builder
toString() - Method in record class org.springframework.ai.rag.Query: Returns a string representation of this record class.
transform(Query) - Method in class org.springframework.ai.rag.preretrieval.query.transformation.CompressionQueryTransformer
transform(Query) - Method in interface org.springframework.ai.rag.preretrieval.query.transformation.QueryTransformer: Transforms the given query according to the implemented strategy.
transform(Query) - Method in class org.springframework.ai.rag.preretrieval.query.transformation.RewriteQueryTransformer
transform(Query) - Method in class org.springframework.ai.rag.preretrieval.query.transformation.TranslationQueryTransformer
TranslationQueryTransformer - Class in org.springframework.ai.rag.preretrieval.query.transformation: Uses a large language model to translate a query to a target language that is supported by the embedding model used to generate the document embeddings.
TranslationQueryTransformer(ChatClient.Builder, PromptTemplate, String) - Constructor for class org.springframework.ai.rag.preretrieval.query.transformation.TranslationQueryTransformer
TranslationQueryTransformer.Builder - Class in org.springframework.ai.rag.preretrieval.query.transformation

V

vectorStore(VectorStore) - Method in class org.springframework.ai.rag.retrieval.search.VectorStoreDocumentRetriever.Builder
VectorStoreDocumentRetriever - Class in org.springframework.ai.rag.retrieval.search: Retrieves documents from a vector store that are semantically similar to the input query.
VectorStoreDocumentRetriever(VectorStore, Double, Integer, Supplier<Filter.Expression>) - Constructor for class org.springframework.ai.rag.retrieval.search.VectorStoreDocumentRetriever
VectorStoreDocumentRetriever.Builder - Class in org.springframework.ai.rag.retrieval.search: Builder for VectorStoreDocumentRetriever.

A B C D E F G H I J M N O P Q R S T V
All Classes and Interfaces|All Packages|Constant Field Values