Module org.elasticsearch.server
Package org.elasticsearch.inference

Record Class InferenceString

java.lang.Object
java.lang.Record
org.elasticsearch.inference.InferenceString
All Implemented Interfaces:
Writeable, ToXContent, ToXContentObject
public record InferenceString(DataType dataType, DataFormat dataFormat, String value) extends Record implements Writeable, ToXContentObject
This class represents a String which may be raw text, or the String representation of some other data such as an image in base64

  • Field Details

  • Constructor Details

    • InferenceString

      public InferenceString(DataType dataType, String value)
      Constructs an InferenceString with the given value and DataType, using the default DataFormat for the data type
      Parameters:
      dataType - the type of data that the String represents
      value - the String value

    • InferenceString

      public InferenceString(DataType dataType, @Nullable DataFormat dataFormat, String value)
      Constructs an InferenceString with the given value, DataType and DataFormat
      Parameters:
      dataType - the type of data that the String represents
      dataFormat - the format of the data. If null, the default data format for the given type is used
      value - the String value

    • InferenceString

      public InferenceString(StreamInput in) throws IOException
      Throws:
      IOException

  • Method Details

    • isImage

      public boolean isImage()

    • isText

      public boolean isText()

    • toStringList

      public static List<String> toStringList(List<InferenceString> inferenceStrings)
      Converts a list of InferenceString to a list of String.

      This method should only be called in code paths that do not deal with multimodal inputs, i.e. code paths where all inputs are guaranteed to be raw text, since it discards the DataType associated with each input.

      Parameters:
      inferenceStrings - The list of InferenceString to convert to a list of String
      Returns:
      a list of String inference inputs that do not contain any non-text inputs

    • textValue

      public static String textValue(InferenceString inferenceString)
      Converts a single InferenceString to a String.

      This method should only be called in code paths that do not deal with multimodal inputs, i.e. code paths where all inputs are guaranteed to be raw text, since it discards the DataType associated with each input.

      Parameters:
      inferenceString - The InferenceString to convert to a String
      Returns:
      a String inference input

    • writeTo

      public void writeTo(StreamOutput out) throws IOException
      Description copied from interface: Writeable
      Write this into the StreamOutput.
      Specified by:
      writeTo in interface Writeable
      Throws:
      IOException

    • toXContent

      public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws IOException
      Specified by:
      toXContent in interface ToXContent
      Throws:
      IOException

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

    • dataType

      public DataType dataType()
      Returns the value of the dataType record component.
      Returns:
      the value of the dataType record component

    • dataFormat

      public DataFormat dataFormat()
      Returns the value of the dataFormat record component.
      Returns:
      the value of the dataFormat record component

    • value

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