com.oracle.bmc.generativeaiagentruntime.model

Class Citation

java.lang.Object

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

com.oracle.bmc.generativeaiagentruntime.model.Citation

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20240531")
public final class Citation
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

The citation displays the location of source text that is the agent uses to create the responses.
Note: Objects should always be created or deserialized using the Citation.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 Citation.Builder, which maintain a set of all explicitly set fields called Citation.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 and Description
static class	Citation.Builder

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 and Description
Citation(String sourceText, SourceLocation sourceLocation, String title, String docId, List<Integer> pageNumbers) Deprecated.

Method Summary

Modifier and Type	Method and Description
static Citation.Builder	builder() Create a new builder.
boolean	equals(Object o)
String	getDocId() The id of the retrieved document, if available.
List<Integer>	getPageNumbers() The page numbers on the retrieved document, if available.
SourceLocation	getSourceLocation()
String	getSourceText() The text that’s the source for the agent’s response.
String	getTitle() The title of the source text, if available.
int	hashCode()
Citation.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents) Return a string representation of the object.

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

Citation

@Deprecated
 @ConstructorProperties(value={"sourceText","sourceLocation","title","docId","pageNumbers"})
public Citation(String sourceText,
                                                                                                                         SourceLocation sourceLocation,
                                                                                                                         String title,
                                                                                                                         String docId,
                                                                                                                         List<Integer> pageNumbers)

Deprecated.

Method Detail

builder

public static Citation.Builder builder()

Create a new builder.

toBuilder

public Citation.Builder toBuilder()

getSourceText

public String getSourceText()

The text that’s the source for the agent’s response.

Returns:

the value

getSourceLocation

public SourceLocation getSourceLocation()

getTitle

public String getTitle()

The title of the source text, if available.

Returns:

the value

getDocId

public String getDocId()

The id of the retrieved document, if available.

Returns:

the value

getPageNumbers

public List<Integer> getPageNumbers()

The page numbers on the retrieved document, if available.

Returns:

the value

toString

public String toString()

Overrides:

toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

hashCode

public int hashCode()

Overrides:

hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel