Package org.springframework.ai.vertex.api

Record Class VertexAiApi.MessagePrompt.Example

java.lang.Object

java.lang.Record

org.springframework.ai.vertex.api.VertexAiApi.MessagePrompt.Example

Record Components:

input - An example of an input Message from the user.

output - An example of an output Message from the model.

Enclosing class:

VertexAiApi.MessagePrompt

public static record VertexAiApi.MessagePrompt.Example(VertexAiApi.Message input, VertexAiApi.Message output)
extends Record

An input/output example used to instruct the Model. It demonstrates how the model should respond or format its response.

Constructor Summary

Constructors

Constructor	Description
Example(VertexAiApi.Message input, VertexAiApi.Message output)	Creates an instance of a Example record class.

Method Summary

Modifier and Type	Method	Description
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.
VertexAiApi.Message	input()	Returns the value of the input record component.
VertexAiApi.Message	output()	Returns the value of the output record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

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

Constructor Details

Example

public Example(VertexAiApi.Message input,
 VertexAiApi.Message output)

Creates an instance of a Example record class.

Parameters:

input - the value for the input record component

output - the value for the output 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.

input

public VertexAiApi.Message input()

Returns the value of the input record component.

Returns:

the value of the input record component

output

public VertexAiApi.Message output()

Returns the value of the output record component.

Returns:

the value of the output record component