@Generated(value="OracleSDKGenerator", comments="API Version: 20231130") public final class Citation extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
A section of the generated reply which cites external knowledge.
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
).
Modifier and Type | Class and Description |
---|---|
static class |
Citation.Builder |
EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME
Constructor and Description |
---|
Citation(Integer start,
Integer end,
String text,
List<String> documentIds)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
static Citation.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
List<String> |
getDocumentIds()
Identifiers of documents cited by this section of the generated reply.
|
Integer |
getEnd()
The index of text that the citation ends after, counting from zero.
|
Integer |
getStart()
The index of text that the citation starts at, counting from zero.
|
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.
|
markPropertyAsExplicitlySet, wasPropertyExplicitlySet
@Deprecated @ConstructorProperties(value={"start","end","text","documentIds"}) public Citation(Integer start, Integer end, String text, List<String> documentIds)
public static Citation.Builder builder()
Create a new builder.
public Citation.Builder toBuilder()
public Integer getStart()
The index of text that the citation starts at, counting from zero.
public Integer getEnd()
The index of text that the citation ends after, counting from zero.
public String getText()
The text of the citation
public List<String> getDocumentIds()
Identifiers of documents cited by this section of the generated reply.
public String toString()
toString
in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
public String toString(boolean includeByteArrayContents)
Return a string representation of the object.
includeByteArrayContents
- true to include the full contents of byte arrayspublic boolean equals(Object o)
equals
in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
public int hashCode()
hashCode
in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
Copyright © 2016–2024. All rights reserved.