com.oracle.bmc.generativeaiinference.model

Class Citation

java.lang.Object

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

com.oracle.bmc.generativeaiinference.model.Citation

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

A section of the generated response which cites the documents that were used for generating the response.
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(Integer start, Integer end, String text, List<String> documentIds) Deprecated.

Method Summary

Modifier and Type	Method and Description
static Citation.Builder	builder() Create a new builder.
boolean	equals(Object o)
List<String>	getDocumentIds() Identifiers for the documents cited in the current generated response.
Integer	getEnd() Counting from zero, the index of the text that the citation ends after.
Integer	getStart() Counting from zero, the index of the text where the citation starts.
String	getText() The text of the citation.
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={"start","end","text","documentIds"})
public Citation(Integer start,
                                                                                                Integer end,
                                                                                                String text,
                                                                                                List<String> documentIds)

Deprecated.

Method Detail

builder

public static Citation.Builder builder()

Create a new builder.

toBuilder

public Citation.Builder toBuilder()

getStart

public Integer getStart()

Counting from zero, the index of the text where the citation starts.

Returns:

the value

getEnd

public Integer getEnd()

Counting from zero, the index of the text that the citation ends after.

Returns:

the value

getText

public String getText()

The text of the citation.

Returns:

the value

getDocumentIds

public List<String> getDocumentIds()

Identifiers for the documents cited in the current generated response.

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