Package org.springframework.ai.model

package org.springframework.ai.model

Provides a set of interfaces and classes for a generic API designed to interact with various AI models. This package includes interfaces for handling AI model calls, requests, responses, results, and associated metadata. It is designed to offer a flexible and adaptable framework for interacting with different types of AI models, abstracting the complexities involved in model invocation and result processing. The use of generics enhances the API's capability to work with a wide range of models, ensuring a broad applicability across diverse AI scenarios.

Related Packages

Package	Description
org.springframework.ai
org.springframework.ai.model.function
org.springframework.ai.model.observation	Provides classes for observing model data.

Class	Description
AbstractResponseMetadata
ChatModelDescription	Marker interface, to be used to store info on the model such as the current context length.
Content	Data structure that contains content and metadata.
EmbeddingModelDescription	Description of an embedding model.
EmbeddingUtils	Utility methods for embedding related operations.
KotlinModule
Media	The Media class represents the data and metadata of a media attachment in a message.
Media.Builder	Builder class for Media.
Media.Format	Common media formats.
MediaContent
Model<TReq extends ModelRequest<?>,TRes extends ModelResponse<?>>	The Model interface provides a generic API for invoking AI models.
ModelDescription	Describes an AI model's basic characteristics.
ModelOptions	Interface representing the customizable options for AI model interactions.
ModelOptionsUtils	Utility class for manipulating ModelOptions objects.
ModelRequest<T>	Interface representing a request to an AI model.
ModelResponse<T extends ModelResult<?>>	Interface representing the response received from an AI model.
ModelResult<T>	This interface provides methods to access the main output of the AI model and the metadata associated with this result.
MutableResponseMetadata
ResponseMetadata	Interface representing metadata associated with an AI model's response.
ResultMetadata	Interface representing metadata associated with the results of an AI model.
StreamingModel<TReq extends ModelRequest<?>,TResChunk extends ModelResponse<?>>	The StreamingModel interface provides a generic API for invoking an AI models with streaming response.