Module org.elasticsearch.server

Package org.elasticsearch.inference.completion

Record Class ContentObject.ContentObjectFile.ContentObjectFileFields

java.lang.Object

java.lang.Record

org.elasticsearch.inference.completion.ContentObject.ContentObjectFile.ContentObjectFileFields

Record Components:

fileData - the data of the file

fileId - the ID of the file

filename - the name of the file

All Implemented Interfaces:

Writeable, ToXContent, ToXContentObject

Enclosing class:

ContentObject.ContentObjectFile

public static record ContentObject.ContentObjectFile.ContentObjectFileFields(String fileData, String fileId, String filename)
extends Record
implements Writeable, ToXContentObject

Represents the fields of a file content object in a unified completion request. Includes the file data, file ID, and filename. The file_id field is not currently supported, but is part of the OpenAI schema, so it is treated as optional for serialization. Since file_id is not supported, file_data and filename are effectively required, even though they are optional in the OpenAI schema. They are also treated as optional for serialization, to allow future support for file_id without needing a new transport version or worrying about backward compatibility.

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
ContentObjectFileFields(String fileData, String fileId, String filename)	Creates an instance of a ContentObjectFileFields record class.
ContentObjectFileFields(StreamInput in)

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
String	fileData()	Returns the value of the fileData record component.
String	fileId()	Returns the value of the fileId record component.
String	filename()	Returns the value of the filename record component.
static ContentObject.ContentObjectFile.ContentObjectFileFields	fromMap(Map<String,Object> map)
final int	hashCode()	Returns a hash code value for this object.
final String	toString()	Returns a string representation of this record class.
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Constructor Details

ContentObjectFileFields

public ContentObjectFileFields(StreamInput in)
                        throws IOException

Throws:

IOException

ContentObjectFileFields

public ContentObjectFileFields(@Nullable
 String fileData,
 @Nullable
 String fileId,
 @Nullable
 String filename)

Creates an instance of a ContentObjectFileFields record class.

Parameters:

fileData - the value for the fileData record component

fileId - the value for the fileId record component

filename - the value for the filename record component

Method Details

fromMap

public static ContentObject.ContentObjectFile.ContentObjectFileFields fromMap(Map<String,Object> map)

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.

fileData

@Nullable
public String fileData()

Returns the value of the fileData record component.

Returns:

the value of the fileData record component

fileId

@Nullable
public String fileId()

Returns the value of the fileId record component.

Returns:

the value of the fileId record component

filename

@Nullable
public String filename()

Returns the value of the filename record component.

Returns:

the value of the filename record component