Package dev.langchain4j.adaptiverag

Record Class Generation

java.lang.Object
java.lang.Record
dev.langchain4j.adaptiverag.Generation
All Implemented Interfaces:
BiFunction<String,List<String>,String>
public record Generation(String openApiKey) extends Record implements BiFunction<String,List<String>,String>
This class provides a service for generating answers to questions using natural language processing. It implements the BiFunction interface to process question and context inputs and produce an answer.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static interface 
    Generation.Service
    Interface for service implementation that provides capabilities to answer questions based on given context.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Generation(String openApiKey)
    Creates an instance of a Generation record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    apply(String question, List<String> context)
    Apply a text-based query to an AI model and retrieve the model's response.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    String
    openApiKey()
    Returns the value of the openApiKey record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface java.util.function.BiFunction

    andThen

  • Constructor Details

    • Generation

      public Generation(String openApiKey)
      Creates an instance of a Generation record class.
      Parameters:
      openApiKey - the value for the openApiKey record component

  • Method Details

    • apply

      public String apply(String question, List<String> context)
      Apply a text-based query to an AI model and retrieve the model's response.
      Specified by:
      apply in interface BiFunction<String,List<String>,String>
      Parameters:
      question - The text query to be processed by the AI model.
      context - A list of strings providing additional context to the query.
      Returns:
      The response from the AI model as a string.

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • openApiKey

      public String openApiKey()
      Returns the value of the openApiKey record component.
      Returns:
      the value of the openApiKey record component