Package com.oracle.bmc.generativeaiagentruntime.model

Class RagToolOutput

java.lang.Object

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

com.oracle.bmc.generativeaiagentruntime.model.ToolOutput

com.oracle.bmc.generativeaiagentruntime.model.RagToolOutput

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

Specifies the output format for RAG tool, including the generated answer and citations.
Note: Objects should always be created or deserialized using the RagToolOutput.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 RagToolOutput.Builder, which maintain a set of all explicitly set fields called RagToolOutput.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	RagToolOutput.Builder

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

ToolOutput.ToolOutputType

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
RagToolOutput(String toolId, String toolName, String text, List<Citation> citations, List<ParagraphCitation> paragraphCitations)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static RagToolOutput.Builder	builder()	Create a new builder.
boolean	equals(Object o)
List<Citation>	getCitations()	Citations to data sources used for tool’s generated answer.
List<ParagraphCitation>	getParagraphCitations()	A list of citations used to generate the paragraphs of the tool’s generated answer.
String	getText()	Specifies the generated answer from the RAG tool.
int	hashCode()
RagToolOutput.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents)	Return a string representation of the object.

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

getToolId, getToolName

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

RagToolOutput

@Deprecated
public RagToolOutput(String toolId,
                     String toolName,
                     String text,
                     List<Citation> citations,
                     List<ParagraphCitation> paragraphCitations)

Deprecated.

Method Detail

builder

public static RagToolOutput.Builder builder()

Create a new builder.

toBuilder

public RagToolOutput.Builder toBuilder()

getText

public String getText()

Specifies the generated answer from the RAG tool.

Returns:

the value

getCitations

public List<Citation> getCitations()

Citations to data sources used for tool’s generated answer.

Returns:

the value

getParagraphCitations

public List<ParagraphCitation> getParagraphCitations()

A list of citations used to generate the paragraphs of the tool’s generated answer.

Returns:

the value

toString

public String toString()

Overrides:

toString in class ToolOutput

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Overrides:

toString in class ToolOutput

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class ToolOutput

hashCode

public int hashCode()

Overrides:

hashCode in class ToolOutput