Package org.springframework.ai.model

Interface ModelDescription

All Known Subinterfaces:
ChatModelDescription, EmbeddingModelDescription
All Known Implementing Classes:
AnthropicApi.ChatModel, MiniMaxApi.ChatModel, MistralAiApi.ChatModel, MoonshotApi.ChatModel, OllamaModel, OpenAiApi.ChatModel, VertexAiGeminiChatModel.ChatModel, VertexAiMultimodalEmbeddingModelName, VertexAiTextEmbeddingModelName, ZhiPuAiApi.ChatModel
public interface ModelDescription
Describes an AI model's basic characteristics. Provides methods to retrieve the model's name, description, and version.
Since:
1.0.0
Author:
Christian Tzolov

  • Method Summary

    Modifier and Type
    Method
    Description
    default String
    getDescription()
    Returns the description of the model.
    String
    getName()
    Returns the name of the model.
    default String
    getVersion()
    Returns the version of the model.

  • Method Details

    • getName

      String getName()
      Returns the name of the model.
      Returns:
      the name of the model

    • getDescription

      default String getDescription()
      Returns the description of the model.
      Returns:
      the description of the model

    • getVersion

      default String getVersion()
      Returns the version of the model.
      Returns:
      the version of the model