Spring AI 1.0.0-M4 API

This document is the API specification for Spring AI

For further API reference and developer documentation, see the Spring AI reference documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, and working code examples.

Packages
Package
Description
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
Auto-configuration for chat observation.
Auto-configuration for embedding observation.
 
Auto-configuration for image observation.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
Auto-configuration for observation vector store.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
The org.sf.ai.chat package represents the bounded context for the Chat Model within the AI generative model domain.
Chat client.
Provides classes for advising chat clients.
Provides the API for chat client advisors.
Provides the API for chat client advisors observations.
Provides classes for observing chat data.
 
 
 
 
Provides the API for chat observations.
 
 
 
 
 
 
 
 
 
 
 
 
 
Provides the API for embedding observations.
 
 
 
 
 
 
 
Provides classes for observing image data.
 
 
 
 
 
 
 
 
Provides a set of interfaces and classes for a generic API designed to interact with various AI models.
 
Provides classes for observing model data.
 
 
 
 
 
Provides classes for observing events in the system.
Conventions for observation-based AI.
 
 
 
 
 
 
Management support for Ollama.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
This package contains the core interfaces and classes supporting Retrieval Augmented Generation flows.
RAG Module: Generation.
RAG Sub-Module: Query Augmentation.
RAG Module: Orchestration.
RAG Sub-Module: Query Router.
RAG Module: Post-Retrieval.
RAG Sub-Module: Document Compression.
RAG Sub-Module: Document Ranking.
RAG Sub-Module: Document Selection.
RAG Module: Pre-Retrieval.
RAG Sub-Module: Query Expansion.
RAG Sub-Module: Query Transformation.
RAG Module: Information Retrieval.
RAG Sub-Module: Document Join.
RAG Sub-Module: Document Search.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
Provides classes for observing and storing vector data.