Record Class OpenAiApi.ChatCompletionMessage.Annotation

java.lang.Object

java.lang.Record

org.springframework.ai.openai.api.OpenAiApi.ChatCompletionMessage.Annotation

Enclosing class:

OpenAiApi.ChatCompletionMessage

public static record OpenAiApi.ChatCompletionMessage.Annotation(String type, OpenAiApi.ChatCompletionMessage.Annotation.UrlCitation urlCitation)
extends Record

Represents an annotation within a message, specifically for URL citations.

Author:

Christian Tzolov, Michael Lavelle, Mariusz Bernacki, Thomas Vitale, David Frizelle, Alexandros Pappas, Filip Hrisafov

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	OpenAiApi.ChatCompletionMessage.Annotation.UrlCitation	A URL citation when using web search.

Constructor Summary

Constructors

Constructor	Description
Annotation(String type, OpenAiApi.ChatCompletionMessage.Annotation.UrlCitation urlCitation)	Creates an instance of a Annotation record class.

Method Summary

Modifier and Type	Method	Description
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.
final String	toString()	Returns a string representation of this record class.
String	type()	Returns the value of the type record component.
OpenAiApi.ChatCompletionMessage.Annotation.UrlCitation	urlCitation()	Returns the value of the urlCitation record component.

Methods inherited from class Object

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

Constructor Details

Annotation

public Annotation(String type,
 OpenAiApi.ChatCompletionMessage.Annotation.UrlCitation urlCitation)

Creates an instance of a Annotation record class.

Parameters:

type - the value for the type record component

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

type

public String type()

Returns the value of the type record component.

Returns:

the value of the type record component

urlCitation

public OpenAiApi.ChatCompletionMessage.Annotation.UrlCitation urlCitation()

Returns the value of the urlCitation record component.

Returns:

the value of the urlCitation record component