Record Class OpenAiSdkChatOptions.StreamOptions

java.lang.Object

java.lang.Record

org.springframework.ai.openaisdk.OpenAiSdkChatOptions.StreamOptions

Enclosing class:

OpenAiSdkChatOptions

public static record OpenAiSdkChatOptions.StreamOptions(Boolean includeObfuscation, Boolean includeUsage, Map<String,Object> additionalProperties)
extends Record

Author:

Julien Dubois, Christian Tzolov

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	OpenAiSdkChatOptions.StreamOptions.Builder

Constructor Summary

Constructors

Constructor	Description
StreamOptions(Boolean includeObfuscation, Boolean includeUsage, Map<String,Object> additionalProperties)	Creates an instance of a StreamOptions record class.

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	additionalProperties()	Returns the value of the additionalProperties record component.
static OpenAiSdkChatOptions.StreamOptions.Builder	builder()
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.
Boolean	includeObfuscation()	Returns the value of the includeObfuscation record component.
Boolean	includeUsage()	Returns the value of the includeUsage 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

StreamOptions

public StreamOptions(Boolean includeObfuscation,
 Boolean includeUsage,
 Map<String,Object> additionalProperties)

Creates an instance of a StreamOptions record class.

Parameters:

includeObfuscation - the value for the includeObfuscation record component

includeUsage - the value for the includeUsage record component

additionalProperties - the value for the additionalProperties record component

Method Details

builder

public static OpenAiSdkChatOptions.StreamOptions.Builder builder()

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.

includeObfuscation

public Boolean includeObfuscation()

Returns the value of the includeObfuscation record component.

Returns:

the value of the includeObfuscation record component

includeUsage

public Boolean includeUsage()

Returns the value of the includeUsage record component.

Returns:

the value of the includeUsage record component

additionalProperties

public Map<String,Object> additionalProperties()

Returns the value of the additionalProperties record component.

Returns:

the value of the additionalProperties record component