Package com.oracle.bmc.generativeaiinference.model

Class UrlCitation

java.lang.Object

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

com.oracle.bmc.generativeaiinference.model.UrlCitation

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

Contains metadata for a cited URL included in the assistant\u2019s response.

Includes the cited URL and title, and the character range (start and end indices) in the response content where the citation applies.
Note: Objects should always be created or deserialized using the UrlCitation.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 UrlCitation.Builder, which maintain a set of all explicitly set fields called UrlCitation.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	UrlCitation.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	Description
UrlCitation(Integer startIndex, Integer endIndex, String title, String url)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static UrlCitation.Builder	builder()	Create a new builder.
boolean	equals(Object o)
Integer	getEndIndex()	End character index in the response where the citation ends.
Integer	getStartIndex()	Start character index in the response where the citation begins.
String	getTitle()	Title of the cited source.
String	getUrl()	URL of the cited source.
int	hashCode()
UrlCitation.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

UrlCitation

@Deprecated
@ConstructorProperties({"startIndex","endIndex","title","url"})
public UrlCitation(Integer startIndex,
                   Integer endIndex,
                   String title,
                   String url)

Deprecated.

Method Detail

builder

public static UrlCitation.Builder builder()

Create a new builder.

toBuilder

public UrlCitation.Builder toBuilder()

getStartIndex

public Integer getStartIndex()

Start character index in the response where the citation begins.

Returns:

the value

getEndIndex

public Integer getEndIndex()

End character index in the response where the citation ends.

Returns:

the value

getTitle

public String getTitle()

Title of the cited source.

Returns:

the value

getUrl

public String getUrl()

URL of the cited source.

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