Package io.github.stefanbratanov.jvm.openai

Record Class ThreadMessage.Content.TextContent.Text.Annotation.FileCitationAnnotation

java.lang.Object

java.lang.Record

io.github.stefanbratanov.jvm.openai.ThreadMessage.Content.TextContent.Text.Annotation.FileCitationAnnotation

All Implemented Interfaces:

ThreadMessage.Content.TextContent.Text.Annotation

Enclosing interface:

ThreadMessage.Content.TextContent.Text.Annotation

public static record ThreadMessage.Content.TextContent.Text.Annotation.FileCitationAnnotation(String text, ThreadMessage.Content.TextContent.Text.Annotation.FileCitationAnnotation.FileCitation fileCitation, int startIndex, int endIndex)
extends Record
implements ThreadMessage.Content.TextContent.Text.Annotation

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	ThreadMessage.Content.TextContent.Text.Annotation.FileCitationAnnotation.FileCitation

Nested classes/interfaces inherited from interface io.github.stefanbratanov.jvm.openai.ThreadMessage.Content.TextContent.Text.Annotation

ThreadMessage.Content.TextContent.Text.Annotation.FileCitationAnnotation, ThreadMessage.Content.TextContent.Text.Annotation.FilePathAnnotation

Constructor Summary

Constructors

Constructor	Description
FileCitationAnnotation(String text, ThreadMessage.Content.TextContent.Text.Annotation.FileCitationAnnotation.FileCitation fileCitation, int startIndex, int endIndex)	Creates an instance of a FileCitationAnnotation record class.

Method Summary

Modifier and Type	Method	Description
int	endIndex()	Returns the value of the endIndex record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
ThreadMessage.Content.TextContent.Text.Annotation.FileCitationAnnotation.FileCitation	fileCitation()	Returns the value of the fileCitation record component.
final int	hashCode()	Returns a hash code value for this object.
int	startIndex()	Returns the value of the startIndex record component.
String	text()	Returns the value of the text record component.
final String	toString()	Returns a string representation of this record class.
String	type()

Methods inherited from class java.lang.Object

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

Constructor Details

FileCitationAnnotation

public FileCitationAnnotation(String text,
 ThreadMessage.Content.TextContent.Text.Annotation.FileCitationAnnotation.FileCitation fileCitation,
 int startIndex,
 int endIndex)

Creates an instance of a FileCitationAnnotation record class.

Parameters:

text - the value for the text record component

fileCitation - the value for the fileCitation record component

startIndex - the value for the startIndex record component

endIndex - the value for the endIndex record component

Method Details

type

public String type()

Specified by:

type in interface ThreadMessage.Content.TextContent.Text.Annotation

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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.

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.

text

public String text()

Returns the value of the text record component.

Specified by:

text in interface ThreadMessage.Content.TextContent.Text.Annotation

Returns:

the value of the text record component

fileCitation

public ThreadMessage.Content.TextContent.Text.Annotation.FileCitationAnnotation.FileCitation fileCitation()

Returns the value of the fileCitation record component.

Returns:

the value of the fileCitation record component

startIndex

public int startIndex()

Returns the value of the startIndex record component.

Specified by:

startIndex in interface ThreadMessage.Content.TextContent.Text.Annotation

Returns:

the value of the startIndex record component

endIndex

public int endIndex()

Returns the value of the endIndex record component.

Specified by:

endIndex in interface ThreadMessage.Content.TextContent.Text.Annotation

Returns:

the value of the endIndex record component