Package com.oracle.bmc.generativeaiinference.model

Class CitationOptionsV2

java.lang.Object

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

com.oracle.bmc.generativeaiinference.model.CitationOptionsV2

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

Options for controlling citation generation in RAG flows.
Note: Objects should always be created or deserialized using the CitationOptionsV2.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 CitationOptionsV2.Builder, which maintain a set of all explicitly set fields called CitationOptionsV2.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	CitationOptionsV2.Builder
static class	CitationOptionsV2.Mode	Dictates the approach taken to generating citations as part of the RAG flow.

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
CitationOptionsV2(CitationOptionsV2.Mode mode)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static CitationOptionsV2.Builder	builder()	Create a new builder.
boolean	equals(Object o)
CitationOptionsV2.Mode	getMode()	Dictates the approach taken to generating citations as part of the RAG flow.
int	hashCode()
CitationOptionsV2.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

CitationOptionsV2

@Deprecated
@ConstructorProperties("mode")
public CitationOptionsV2(CitationOptionsV2.Mode mode)

Deprecated.

Method Detail

builder

public static CitationOptionsV2.Builder builder()

Create a new builder.

toBuilder

public CitationOptionsV2.Builder toBuilder()

getMode

public CitationOptionsV2.Mode getMode()

Dictates the approach taken to generating citations as part of the RAG flow.

Defaults to “accurate”. - “ACCURATE”: More precise citation generation. - “FAST”: Faster but may be less precise. - “OFF”: Disables citation generation. Note: command-r7b-12-2024 and command-a-03-2025 only support “FAST” and “OFF”.

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