Package dev.braintrust.api

Record Class BraintrustApiClient.FunctionInvokeRequest

java.lang.Object

java.lang.Record

dev.braintrust.api.BraintrustApiClient.FunctionInvokeRequest

Enclosing interface:

BraintrustApiClient

public static record BraintrustApiClient.FunctionInvokeRequest(@Nullable Object input, @Nullable String version)
extends Record

Request body for invoking a function. The input field wraps the function arguments.

For remote Python/TypeScript scorers, the scorer handler parameters (input, output, expected, metadata) must be wrapped in the outer input field.

Constructor Summary

Constructors

Constructor	Description
FunctionInvokeRequest(Object input, String version)	Creates an instance of a FunctionInvokeRequest record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
static BraintrustApiClient.FunctionInvokeRequest	forScorer(Object input, Object output, Object expected, Object metadata)	Create an invoke request for a scorer with input, output, expected, and metadata.
static BraintrustApiClient.FunctionInvokeRequest	forScorer(Object input, Object output, Object expected, Object metadata, String version)	Create an invoke request for a scorer with input, output, expected, metadata, and version.
final int	hashCode()	Returns a hash code value for this object.
Object	input()	Returns the value of the input record component.
static BraintrustApiClient.FunctionInvokeRequest	of(Object input)	Create a simple invoke request with just input
static BraintrustApiClient.FunctionInvokeRequest	of(Object input, String version)	Create a simple invoke request with input and version
final String	toString()	Returns a string representation of this record class.
String	version()	Returns the value of the version record component.

Methods inherited from class java.lang.Object

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

Constructor Details

FunctionInvokeRequest

public FunctionInvokeRequest(@Nullable
 Object input,
 @Nullable
 String version)

Creates an instance of a FunctionInvokeRequest record class.

Parameters:

input - the value for the input record component

version - the value for the version record component

Method Details

of

public static BraintrustApiClient.FunctionInvokeRequest of(Object input)

Create a simple invoke request with just input

of

public static BraintrustApiClient.FunctionInvokeRequest of(Object input,
 @Nullable
 String version)

Create a simple invoke request with input and version

forScorer

public static BraintrustApiClient.FunctionInvokeRequest forScorer(Object input,
 Object output,
 Object expected,
 Object metadata)

Create an invoke request for a scorer with input, output, expected, and metadata. This maps to the standard scorer handler signature: handler(input, output, expected, metadata)

The scorer args are wrapped in the outer input field as required by the invoke API.

forScorer

public static BraintrustApiClient.FunctionInvokeRequest forScorer(Object input,
 Object output,
 Object expected,
 Object metadata,
 @Nullable
 String version)

Create an invoke request for a scorer with input, output, expected, metadata, and version. This maps to the standard scorer handler signature: handler(input, output, expected, metadata)

The scorer args are wrapped in the outer input field as required by the invoke API.

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.

input

@Nullable
public Object input()

Returns the value of the input record component.

Returns:

the value of the input record component

version

@Nullable
public String version()

Returns the value of the version record component.

Returns:

the value of the version record component