Uses of Record Class
org.springframework.ai.rag.Query

Packages that use Query

Package	Description
org.springframework.ai.rag	This package contains the core interfaces and classes supporting Retrieval Augmented Generation flows.
org.springframework.ai.rag.generation.augmentation	RAG Sub-Module: Query Augmentation.
org.springframework.ai.rag.postretrieval.document
org.springframework.ai.rag.preretrieval.query.expansion	RAG Sub-Module: Query Expansion.
org.springframework.ai.rag.preretrieval.query.transformation	RAG Sub-Module: Query Transformation.
org.springframework.ai.rag.retrieval.join	RAG Sub-Module: Document Join.
org.springframework.ai.rag.retrieval.search	RAG Sub-Module: Document Search.

Uses of Query in org.springframework.ai.rag

Methods in org.springframework.ai.rag that return Query

Modifier and Type	Method	Description
Query	Query.Builder.build()

Uses of Query in org.springframework.ai.rag.generation.augmentation

Subinterfaces with type arguments of type Query in org.springframework.ai.rag.generation.augmentation

Modifier and Type	Interface	Description
interface	QueryAugmenter	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.
interface	QueryAugmenter	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.

Methods in org.springframework.ai.rag.generation.augmentation that return Query

Modifier and Type	Method	Description
default Query	QueryAugmenter.apply(Query query, List<Document> documents)
Query	ContextualQueryAugmenter.augment(Query query, List<Document> documents)
Query	QueryAugmenter.augment(Query query, List<Document> documents)	Augments the user query with contextual data.

Methods in org.springframework.ai.rag.generation.augmentation with parameters of type Query

Modifier and Type	Method	Description
default Query	QueryAugmenter.apply(Query query, List<Document> documents)
Query	ContextualQueryAugmenter.augment(Query query, List<Document> documents)
Query	QueryAugmenter.augment(Query query, List<Document> documents)	Augments the user query with contextual data.

Uses of Query in org.springframework.ai.rag.postretrieval.document

Subinterfaces with type arguments of type Query in org.springframework.ai.rag.postretrieval.document

Modifier and Type	Interface	Description
interface	DocumentPostProcessor	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.

Methods in org.springframework.ai.rag.postretrieval.document with parameters of type Query

Modifier and Type	Method	Description
default List<Document>	DocumentPostProcessor.apply(Query query, List<Document> documents)
List<Document>	DocumentPostProcessor.process(Query query, List<Document> documents)

Uses of Query in org.springframework.ai.rag.preretrieval.query.expansion

Subinterfaces with type arguments of type Query in org.springframework.ai.rag.preretrieval.query.expansion

Modifier and Type	Interface	Description
interface	QueryExpander	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.
interface	QueryExpander	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.

Methods in org.springframework.ai.rag.preretrieval.query.expansion that return types with arguments of type Query

Modifier and Type	Method	Description
default List<Query>	QueryExpander.apply(Query query)
List<Query>	MultiQueryExpander.expand(Query query)
List<Query>	QueryExpander.expand(Query query)	Expands the given query into a list of queries.

Methods in org.springframework.ai.rag.preretrieval.query.expansion with parameters of type Query

Modifier and Type	Method	Description
default List<Query>	QueryExpander.apply(Query query)
List<Query>	MultiQueryExpander.expand(Query query)
List<Query>	QueryExpander.expand(Query query)	Expands the given query into a list of queries.

Uses of Query in org.springframework.ai.rag.preretrieval.query.transformation

Subinterfaces with type arguments of type Query in org.springframework.ai.rag.preretrieval.query.transformation

Modifier and Type	Interface	Description
interface	QueryTransformer	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.
interface	QueryTransformer	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.

Methods in org.springframework.ai.rag.preretrieval.query.transformation that return Query

Modifier and Type	Method	Description
default Query	QueryTransformer.apply(Query query)
Query	CompressionQueryTransformer.transform(Query query)
Query	QueryTransformer.transform(Query query)	Transforms the given query according to the implemented strategy.
Query	RewriteQueryTransformer.transform(Query query)
Query	TranslationQueryTransformer.transform(Query query)

Methods in org.springframework.ai.rag.preretrieval.query.transformation with parameters of type Query

Modifier and Type	Method	Description
default Query	QueryTransformer.apply(Query query)
Query	CompressionQueryTransformer.transform(Query query)
Query	QueryTransformer.transform(Query query)	Transforms the given query according to the implemented strategy.
Query	RewriteQueryTransformer.transform(Query query)
Query	TranslationQueryTransformer.transform(Query query)

Uses of Query in org.springframework.ai.rag.retrieval.join

Subinterfaces with type arguments of type Query in org.springframework.ai.rag.retrieval.join

Modifier and Type	Interface	Description
interface	DocumentJoiner	A component for combining documents retrieved based on multiple queries and from multiple data sources into a single collection of documents.

Method parameters in org.springframework.ai.rag.retrieval.join with type arguments of type Query

Modifier and Type	Method	Description
default List<Document>	DocumentJoiner.apply(Map<Query, List<List<Document>>> documentsForQuery)
List<Document>	ConcatenationDocumentJoiner.join(Map<Query, List<List<Document>>> documentsForQuery)
List<Document>	DocumentJoiner.join(Map<Query, List<List<Document>>> documentsForQuery)	Joins documents retrieved across multiple queries and daa sources.

Uses of Query in org.springframework.ai.rag.retrieval.search

Subinterfaces with type arguments of type Query in org.springframework.ai.rag.retrieval.search

Modifier and Type	Interface	Description
interface	DocumentRetriever	Component responsible for retrieving Documents from an underlying data source, such as a search engine, a vector store, a database, or a knowledge graph.

Methods in org.springframework.ai.rag.retrieval.search with parameters of type Query

Modifier and Type	Method	Description
default List<Document>	DocumentRetriever.apply(Query query)
List<Document>	DocumentRetriever.retrieve(Query query)	Retrieves relevant documents from an underlying data source based on the given query.
List<Document>	VectorStoreDocumentRetriever.retrieve(Query query)