Package org.springframework.ai.model

Interface ModelRequest<T>

Type Parameters:
T - the type of instructions or input required by the AI model
All Known Implementing Classes:
AudioTranscriptionPrompt, DocumentEmbeddingRequest, EmbeddingRequest, ImagePrompt, ModerationPrompt, Prompt, SpeechPrompt
public interface ModelRequest<T>
Interface representing a request to an AI model. This interface encapsulates the necessary information required to interact with an AI model, including instructions or inputs (of generic type T) and additional model options. It provides a standardized way to send requests to AI models, ensuring that all necessary details are included and can be easily managed.
Since:
0.8.0
Author:
Mark Pollack

  • Method Summary

    Modifier and Type
    Method
    Description
    T
    getInstructions()
    Retrieves the instructions or input required by the AI model.
    ModelOptions
    getOptions()
    Retrieves the customizable options for AI model interactions.

  • Method Details

    • getInstructions

      T getInstructions()
      Retrieves the instructions or input required by the AI model.
      Returns:
      the instructions or input required by the AI model

    • getOptions

      ModelOptions getOptions()
      Retrieves the customizable options for AI model interactions.
      Returns:
      the customizable options for AI model interactions