Package org.springframework.ai.model

Interface ModelResult<T>

Type Parameters:
T - the type of the output generated by the AI model
All Known Implementing Classes:
AudioTranscription, Embedding, Generation, ImageGeneration
public interface ModelResult<T>
This interface provides methods to access the main output of the AI model and the metadata associated with this result. It is designed to offer a standardized and comprehensive way to handle and interpret the outputs generated by AI models, catering to diverse AI applications and use cases.
Since:
0.8.0
Author:
Mark Pollack

  • Method Summary

    Modifier and Type
    Method
    Description
    ResultMetadata
    getMetadata()
    Retrieves the metadata associated with the result of an AI model.
    T
    getOutput()
    Retrieves the output generated by the AI model.

  • Method Details

    • getOutput

      T getOutput()
      Retrieves the output generated by the AI model.
      Returns:
      the output generated by the AI model

    • getMetadata

      ResultMetadata getMetadata()
      Retrieves the metadata associated with the result of an AI model.
      Returns:
      the metadata associated with the result