Record Class ToolBinaryResult

java.lang.Object

java.lang.Record

com.github.copilot.rpc.ToolBinaryResult

Record Components:

data - the base64-encoded binary data

mimeType - the MIME type (e.g., "image/png", "application/pdf")

type - the content type (e.g., "image", "file")

description - the content description, helps the assistant understand the content

public record ToolBinaryResult(String data, String mimeType, String type, String description)
extends Record

Binary result from a tool execution.

This record represents binary data (such as images) returned by a tool. The data is base64-encoded for JSON transmission.

Example Usage

var binaryResult = new ToolBinaryResult(Base64.getEncoder().encodeToString(imageBytes), "image/png", "image",
		"Generated chart");

Since:

1.0.0

See Also:

• invalid reference

  ToolResultObject#setBinaryResultsForLlm(java.util.List)

Constructor Summary

Constructors

Constructor	Description
ToolBinaryResult(String data, String mimeType, String type, String description)	Creates an instance of a ToolBinaryResult record class.

Method Summary

Modifier and Type	Method	Description
String	data()	Returns the value of the data record component.
String	description()	Returns the value of the description 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.
String	mimeType()	Returns the value of the mimeType record component.
final String	toString()	Returns a string representation of this record class.
String	type()	Returns the value of the type record component.

Methods inherited from class Object

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

Constructor Details

ToolBinaryResult

public ToolBinaryResult(String data,
 String mimeType,
 String type,
 String description)

Creates an instance of a ToolBinaryResult record class.

Parameters:

data - the value for the data record component

mimeType - the value for the mimeType record component

type - the value for the type record component

description - the value for the description record component

Method Details

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.

data

public String data()

Returns the value of the data record component.

Returns:

the value of the data record component

mimeType

public String mimeType()

Returns the value of the mimeType record component.

Returns:

the value of the mimeType record component

type

public String type()

Returns the value of the type record component.

Returns:

the value of the type record component

description

public String description()

Returns the value of the description record component.

Returns:

the value of the description record component