Package com.axelor.ai.chat.stream

Record Class StreamEvent.ToolOutputAvailable

java.lang.Object

java.lang.Record

com.axelor.ai.chat.stream.StreamEvent.ToolOutputAvailable

All Implemented Interfaces:

StreamEvent

Enclosing interface:

StreamEvent

public static record StreamEvent.ToolOutputAvailable(String toolCallId, Object output, Boolean providerExecuted, Map<String,Object> providerMetadata, Map<String,Object> toolMetadata, Boolean dynamic, Boolean preliminary)
extends Record
implements StreamEvent

Nested Class Summary

Nested classes/interfaces inherited from interface com.axelor.ai.chat.stream.StreamEvent

StreamEvent.Abort, StreamEvent.Custom, StreamEvent.Data, StreamEvent.Error, StreamEvent.File, StreamEvent.Finish, StreamEvent.FinishStep, StreamEvent.MessageMetadata, StreamEvent.ReasoningDelta, StreamEvent.ReasoningEnd, StreamEvent.ReasoningFile, StreamEvent.ReasoningStart, StreamEvent.ResetStep, StreamEvent.SourceDocument, StreamEvent.SourceUrl, StreamEvent.Start, StreamEvent.StartStep, StreamEvent.TextDelta, StreamEvent.TextEnd, StreamEvent.TextStart, StreamEvent.ToolApprovalRequest, StreamEvent.ToolApprovalResponse, StreamEvent.ToolInputAvailable, StreamEvent.ToolInputDelta, StreamEvent.ToolInputError, StreamEvent.ToolInputStart, StreamEvent.ToolOutputAvailable, StreamEvent.ToolOutputDenied, StreamEvent.ToolOutputError, StreamEvent.TypeResolver

Constructor Summary

Constructors

Constructor	Description
ToolOutputAvailable(String toolCallId, Object output, Boolean providerExecuted, Map<String,Object> providerMetadata, Map<String,Object> toolMetadata, Boolean dynamic, Boolean preliminary)	Creates an instance of a ToolOutputAvailable record class.

Method Summary

Modifier and Type	Method	Description
Boolean	dynamic()	Returns the value of the dynamic 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.
Object	output()	Returns the value of the output record component.
Boolean	preliminary()	Returns the value of the preliminary record component.
Boolean	providerExecuted()	Returns the value of the providerExecuted record component.
Map<String,Object>	providerMetadata()	Returns the value of the providerMetadata record component.
String	toolCallId()	Returns the value of the toolCallId record component.
Map<String,Object>	toolMetadata()	Returns the value of the toolMetadata 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

ToolOutputAvailable

public ToolOutputAvailable(String toolCallId,
 Object output,
 Boolean providerExecuted,
 Map<String,Object> providerMetadata,
 Map<String,Object> toolMetadata,
 Boolean dynamic,
 Boolean preliminary)

Creates an instance of a ToolOutputAvailable record class.

Parameters:

toolCallId - the value for the toolCallId record component

output - the value for the output record component

providerExecuted - the value for the providerExecuted record component

providerMetadata - the value for the providerMetadata record component

toolMetadata - the value for the toolMetadata record component

dynamic - the value for the dynamic record component

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

toolCallId

public String toolCallId()

Returns the value of the toolCallId record component.

Returns:

the value of the toolCallId record component

output

public Object output()

Returns the value of the output record component.

Returns:

the value of the output record component

providerExecuted

public Boolean providerExecuted()

Returns the value of the providerExecuted record component.

Returns:

the value of the providerExecuted record component

providerMetadata

public Map<String,Object> providerMetadata()

Returns the value of the providerMetadata record component.

Returns:

the value of the providerMetadata record component

toolMetadata

public Map<String,Object> toolMetadata()

Returns the value of the toolMetadata record component.

Returns:

the value of the toolMetadata record component

dynamic

public Boolean dynamic()

Returns the value of the dynamic record component.

Returns:

the value of the dynamic record component

preliminary

public Boolean preliminary()

Returns the value of the preliminary record component.

Returns:

the value of the preliminary record component