Package com.oracle.bmc.generativeaiagentruntime.model

Class RetrievalTrace

java.lang.Object

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

com.oracle.bmc.generativeaiagentruntime.model.Trace

com.oracle.bmc.generativeaiagentruntime.model.RetrievalTrace

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

The trace that displays the retrieval information.
Note: Objects should always be created or deserialized using the RetrievalTrace.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 RetrievalTrace.Builder, which maintain a set of all explicitly set fields called RetrievalTrace.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	RetrievalTrace.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
RetrievalTrace(String key, String parentKey, SourceDetails source, Date timeCreated, Date timeFinished, String retrievalInput, List<Citation> citations, List<Usage> usage)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static RetrievalTrace.Builder	builder()	Create a new builder.
boolean	equals(Object o)
List<Citation>	getCitations()	A list of citations retrieved from data sources.
String	getRetrievalInput()	The agent’s search string for getting the displayed information.
List<Usage>	getUsage()	Details of model and its usage.
int	hashCode()
RetrievalTrace.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

RetrievalTrace

@Deprecated
public RetrievalTrace(String key,
                      String parentKey,
                      SourceDetails source,
                      Date timeCreated,
                      Date timeFinished,
                      String retrievalInput,
                      List<Citation> citations,
                      List<Usage> usage)

Deprecated.

Method Detail

builder

public static RetrievalTrace.Builder builder()

Create a new builder.

toBuilder

public RetrievalTrace.Builder toBuilder()

getRetrievalInput

public String getRetrievalInput()

The agent’s search string for getting the displayed information.

Returns:

the value

getCitations

public List<Citation> getCitations()

A list of citations retrieved from data sources.

Returns:

the value

getUsage

public List<Usage> getUsage()

Details of model and its usage.

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