Module org.elasticsearch.server

Package org.elasticsearch.inference

Record Class InferenceString

java.lang.Object

java.lang.Record

org.elasticsearch.inference.InferenceString

public record InferenceString(String value, InferenceString.DataType dataType)
extends Record

This class represents a String which may be raw text, or the String representation of some other data such as an image in base64

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	InferenceString.DataType	Describes the type of data represented by an InferenceString

Constructor Summary

Constructors

Constructor	Description
InferenceString(String value, InferenceString.DataType dataType)	Constructs an InferenceString with the given value and InferenceString.DataType

Method Summary

Modifier and Type	Method	Description
InferenceString.DataType	dataType()	Returns the value of the dataType record component.
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.
boolean	isImage()
boolean	isText()
final String	toString()	Returns a string representation of this record class.
static List<String>	toStringList(List<InferenceString> inferenceStrings)	Converts a list of InferenceString to a list of String.
String	value()	Returns the value of the value record component.

Methods inherited from class java.lang.Object

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

Constructor Details

InferenceString

public InferenceString(String value,
 InferenceString.DataType dataType)

Constructs an InferenceString with the given value and InferenceString.DataType

Parameters:

value - the String value

dataType - the type of data that the String represents

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; where all inputs are guaranteed to be raw text, since it discards the InferenceString.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

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.

value

public String value()

Returns the value of the value record component.

Returns:

the value of the value record component

dataType

public InferenceString.DataType dataType()

Returns the value of the dataType record component.

Returns:

the value of the dataType record component