Package org.springframework.ai.vertexai.palm2.api

Record Class VertexAiPaLm2Api.Message.CitationSource

java.lang.Object

java.lang.Record

org.springframework.ai.vertexai.palm2.api.VertexAiPaLm2Api.Message.CitationSource

Record Components:

startIndex - (optional) Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.

endIndex - (optional) End of the attributed segment, exclusive.

uri - (optional) URI that is attributed as a source for a portion of the text.

license - (optional) License for the GitHub project that is attributed as a source for segment.License info is required for code citations.

Enclosing class:

VertexAiPaLm2Api.Message

public static record VertexAiPaLm2Api.Message.CitationSource(Integer startIndex, Integer endIndex, String uri, String license)
extends Record

A citation to a source for a portion of a specific response.

Constructor Summary

Constructors

Constructor	Description
CitationSource(Integer startIndex, Integer endIndex, String uri, String license)	Creates an instance of a CitationSource record class.

Method Summary

Modifier and Type	Method	Description
Integer	endIndex()	Returns the value of the endIndex 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.
String	license()	Returns the value of the license record component.
Integer	startIndex()	Returns the value of the startIndex record component.
final String	toString()	Returns a string representation of this record class.
String	uri()	Returns the value of the uri record component.

Methods inherited from class java.lang.Object

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

Constructor Details

CitationSource

public CitationSource(Integer startIndex,
 Integer endIndex,
 String uri,
 String license)

Creates an instance of a CitationSource record class.

Parameters:

startIndex - the value for the startIndex record component

endIndex - the value for the endIndex record component

uri - the value for the uri record component

license - the value for the license 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.

startIndex

public Integer startIndex()

Returns the value of the startIndex record component.

Returns:

the value of the startIndex record component

endIndex

public Integer endIndex()

Returns the value of the endIndex record component.

Returns:

the value of the endIndex record component

uri

public String uri()

Returns the value of the uri record component.

Returns:

the value of the uri record component

license

public String license()

Returns the value of the license record component.

Returns:

the value of the license record component