Record Class OpenAiApi.Embedding

java.lang.Object
java.lang.Record
org.springframework.ai.openai.api.OpenAiApi.Embedding
Record Components:
index - The index of the embedding in the list of embeddings.
embedding - The embedding vector, which is a list of floats. The length of vector depends on the model.
object - The object type, which is always 'embedding'.
Enclosing class:
OpenAiApi
public static record OpenAiApi.Embedding(Integer index, float[] embedding, String object) extends Record
Represents an embedding vector returned by embedding endpoint.
Author:
Christian Tzolov, Michael Lavelle, Mariusz Bernacki, Thomas Vitale, David Frizelle, Alexandros Pappas, Filip Hrisafov

  • Constructor Summary

    Constructors
    Constructor
    Description
    Embedding(Integer index, float[] embedding)
    Create an embedding with the given index, embedding and object type set to 'embedding'.
    Embedding(Integer index, float[] embedding, String object)
    Creates an instance of a Embedding record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    float[]
    embedding()
    Returns the value of the embedding record component.
    boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    int
    hashCode()
    Returns a hash code value for this object.
    Integer
    index()
    Returns the value of the index record component.
    String
    object()
    Returns the value of the object record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class Object

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

  • Constructor Details

    • Embedding

      public Embedding(Integer index, float[] embedding)
      Create an embedding with the given index, embedding and object type set to 'embedding'.
      Parameters:
      index - The index of the embedding in the list of embeddings.
      embedding - The embedding vector, which is a list of floats. The length of vector depends on the model.

    • Embedding

      public Embedding(Integer index, float[] embedding, String object)
      Creates an instance of a Embedding record class.
      Parameters:
      index - the value for the index record component
      embedding - the value for the embedding record component
      object - the value for the object record component

  • Method Details

    • equals

      public 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.

    • hashCode

      public 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

    • 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

    • index

      public Integer index()
      Returns the value of the index record component.
      Returns:
      the value of the index record component

    • embedding

      public float[] embedding()
      Returns the value of the embedding record component.
      Returns:
      the value of the embedding record component

    • object

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