Package com.oracle.bmc.generativeaiinference.model

Class CohereCitationV2

java.lang.Object

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

com.oracle.bmc.generativeaiinference.model.CohereCitationV2

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

A source reference or citation for a piece of content.
Note: Objects should always be created or deserialized using the CohereCitationV2.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 CohereCitationV2.Builder, which maintain a set of all explicitly set fields called CohereCitationV2.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	CohereCitationV2.Builder
static class	CohereCitationV2.Type	The type of citation indicating what part of the response it is for.

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
CohereCitationV2(Integer start, Integer end, String text, Integer contentIndex, CohereCitationV2.Type type, List<CohereCitationSourceV2> sources)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static CohereCitationV2.Builder	builder()	Create a new builder.
boolean	equals(Object o)
Integer	getContentIndex()	Index of the content block in which this citation appears.
Integer	getEnd()	End index of the cited snippet in the original source text.
List<CohereCitationSourceV2>	getSources()	List of source objects for this citation.
Integer	getStart()	Start index of the cited snippet in the original source text.
String	getText()	Text snippet that is being cited.
CohereCitationV2.Type	getType()	The type of citation indicating what part of the response it is for.
int	hashCode()
CohereCitationV2.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

CohereCitationV2

@Deprecated
@ConstructorProperties({"start","end","text","contentIndex","type","sources"})
public CohereCitationV2(Integer start,
                        Integer end,
                        String text,
                        Integer contentIndex,
                        CohereCitationV2.Type type,
                        List<CohereCitationSourceV2> sources)

Deprecated.

Method Detail

builder

public static CohereCitationV2.Builder builder()

Create a new builder.

toBuilder

public CohereCitationV2.Builder toBuilder()

getStart

public Integer getStart()

Start index of the cited snippet in the original source text.

Returns:

the value

getEnd

public Integer getEnd()

End index of the cited snippet in the original source text.

Returns:

the value

getText

public String getText()

Text snippet that is being cited.

Returns:

the value

getContentIndex

public Integer getContentIndex()

Index of the content block in which this citation appears.

Returns:

the value

getType

public CohereCitationV2.Type getType()

The type of citation indicating what part of the response it is for.

Returns:

the value

getSources

public List<CohereCitationSourceV2> getSources()

List of source objects for this citation.

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