Package com.oracle.bmc.generativeaiagentruntime.model

Class ToolInvocationTrace

java.lang.Object

com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

com.oracle.bmc.generativeaiagentruntime.model.Trace

com.oracle.bmc.generativeaiagentruntime.model.ToolInvocationTrace

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20240531")
public final class ToolInvocationTrace
extends Trace

Pre-General Availability: 2024-01-24 |Important| |- |*The following legal notice applies to Oracle pre-GA releases.

For copyright and other applicable notices, see Oracle Legal Notices.*

|*Pre-General Availability Draft Documentation Notice*| |- |*This documentation is in pre-General Availability status and is intended for demonstration and preliminary use only. It may not be specific to the hardware on which you are using the software. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to this documentation and will not be responsible for any loss, costs, or damages incurred due to the use of this documentation. This documentation is not a commitment by Oracle to deliver any material, code, functionality or services. This documentation, and Oracle Pre-GA programs and services are subject to change at any time without notice and, accordingly, should not be relied upon in making purchasing decisions. The development, release, and timing of any features or functionality for Oracle's Pre-GA programs and services remains at the sole discretion of Oracle. All release dates or other predictions of future events are subject to change. The future availability of any future Oracle program or service should not be relied on in entering into any license or service agreement with Oracle.* **GenerationTrace**

The trace information about the tool selection from multiple tools.
Note: Objects should always be created or deserialized using the ToolInvocationTrace.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the ToolInvocationTrace.Builder, which maintain a set of all explicitly set fields called ToolInvocationTrace.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ToolInvocationTrace.Builder

Nested classes/interfaces inherited from class com.oracle.bmc.generativeaiagentruntime.model.Trace

Trace.TraceType

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors

Constructor	Description
ToolInvocationTrace(String key, String parentKey, SourceDetails source, Date timeCreated, Date timeFinished, String toolId, String toolName, String invocationDetails)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static ToolInvocationTrace.Builder	builder()	Create a new builder.
boolean	equals(Object o)
String	getInvocationDetails()	The invocation details related to the selected tool.
String	getToolId()	The ID of the selected tool based on the user query.
String	getToolName()	The display name of the selected tool.
int	hashCode()
ToolInvocationTrace.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents)	Return a string representation of the object.

Methods inherited from class com.oracle.bmc.generativeaiagentruntime.model.Trace

getKey, getParentKey, getSource, getTimeCreated, getTimeFinished

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

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

Constructor Detail

ToolInvocationTrace

@Deprecated
public ToolInvocationTrace(String key,
                           String parentKey,
                           SourceDetails source,
                           Date timeCreated,
                           Date timeFinished,
                           String toolId,
                           String toolName,
                           String invocationDetails)

Deprecated.

Method Detail

builder

public static ToolInvocationTrace.Builder builder()

Create a new builder.

toBuilder

public ToolInvocationTrace.Builder toBuilder()

getToolId

public String getToolId()

The ID of the selected tool based on the user query.

Returns:

the value

getToolName

public String getToolName()

The display name of the selected tool.

Returns:

the value

getInvocationDetails

public String getInvocationDetails()

The invocation details related to the selected tool.

Returns:

the value

toString

public String toString()

Overrides:

toString in class Trace

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Overrides:

toString in class Trace

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class Trace

hashCode

public int hashCode()

Overrides:

hashCode in class Trace