Record Class CitationReference

java.lang.Object

java.lang.Record

com.github.copilot.generated.CitationReference

@Generated("copilot-sdk-codegen")
public record CitationReference(String sourceId, String citedText, Object location, Object providerMetadata)
extends Record

A single citation occurrence linking a span of generated text to a supporting source.

Since:

1.0.0

Constructor Summary

Constructors

Constructor	Description
CitationReference(String sourceId, String citedText, Object location, Object providerMetadata)	Creates an instance of a CitationReference record class.

Method Summary

Modifier and Type	Method	Description
String	citedText()	Returns the value of the citedText record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
Object	location()	Returns the value of the location record component.
Object	providerMetadata()	Returns the value of the providerMetadata record component.
String	sourceId()	Returns the value of the sourceId record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

CitationReference

public CitationReference(String sourceId,
 String citedText,
 Object location,
 Object providerMetadata)

Creates an instance of a CitationReference record class.

Parameters:

sourceId - the value for the sourceId record component

citedText - the value for the citedText record component

location - the value for the location record component

providerMetadata - the value for the providerMetadata record component

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

sourceId

public String sourceId()

Returns the value of the sourceId record component.

Returns:

the value of the sourceId record component

citedText

public String citedText()

Returns the value of the citedText record component.

Returns:

the value of the citedText record component

location

public Object location()

Returns the value of the location record component.

Returns:

the value of the location record component

providerMetadata

public Object providerMetadata()

Returns the value of the providerMetadata record component.

Returns:

the value of the providerMetadata record component