パッケージ org.nkjmlab.util.openai.chat.model

Record Class ChatRequest

java.lang.Object

java.lang.Record

org.nkjmlab.util.openai.chat.model.ChatRequest

public record ChatRequest(String model, Float temperature, Float top_p, Integer n, Integer max_tokens, Float presence_penalty, Float frequency_penalty, String user, List<ChatRequest.ChatMessage> messages)
extends Record

ネストされたクラスの概要

ネストされたクラス

修飾子とタイプ	クラス	説明
static class	ChatRequest.Builder
static final record	ChatRequest.ChatMessage	Chat completion - OpenAI API
static enum	ChatRequest.Model	Models - OpenAI API

コンストラクタの概要

コンストラクタ

コンストラクタ	説明
ChatRequest(String model, Float temperature, Float top_p, Integer n, Integer max_tokens, Float presence_penalty, Float frequency_penalty, String user, List<ChatRequest.ChatMessage> messages)	ChatRequestレコードのインスタンスを作成します。

メソッドの概要

修飾子とタイプ	メソッド	説明
static ChatRequest.Builder	builder()
final boolean	equals(Object o)	他のオブジェクトがこれと"等しい"かどうかを示します。
Float	frequency_penalty()	frequency_penaltyレコード・コンポーネントの値が返されます。
final int	hashCode()	このオブジェクトのハッシュ・コード値を返します。
Integer	max_tokens()	max_tokensレコード・コンポーネントの値が返されます。
List<ChatRequest.ChatMessage>	messages()	messagesレコード・コンポーネントの値が返されます。
String	model()	modelレコード・コンポーネントの値が返されます。
Integer	n()	nレコード・コンポーネントの値が返されます。
Float	presence_penalty()	presence_penaltyレコード・コンポーネントの値が返されます。
Float	temperature()	temperatureレコード・コンポーネントの値が返されます。
Float	top_p()	top_pレコード・コンポーネントの値が返されます。
final String	toString()	このレコードの文字列表現を返します。
String	user()	userレコード・コンポーネントの値が返されます。

クラスから継承されたメソッド java.lang.Object

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

コンストラクタの詳細

ChatRequest

public ChatRequest(String model,
 Float temperature,
 Float top_p,
 Integer n,
 Integer max_tokens,
 Float presence_penalty,
 Float frequency_penalty,
 String user,
 List<ChatRequest.ChatMessage> messages)

ChatRequestレコードのインスタンスを作成します。

パラメータ:

model - modelレコード・コンポーネントの値

temperature - temperatureレコード・コンポーネントの値

top_p - top_pレコード・コンポーネントの値

n - nレコード・コンポーネントの値

max_tokens - max_tokensレコード・コンポーネントの値

presence_penalty - presence_penaltyレコード・コンポーネントの値

frequency_penalty - frequency_penaltyレコード・コンポーネントの値

user - userレコード・コンポーネントの値

messages - messagesレコード・コンポーネントの値

メソッドの詳細

builder

public static ChatRequest.Builder builder()

toString

public final String toString()

このレコードの文字列表現を返します。表現には、型の名前に続けて各レコード・コンポーネントの名前と値が含まれます。

定義:

toString クラス内 Record

戻り値:

このオブジェクトの文字列表現

hashCode

public final int hashCode()

このオブジェクトのハッシュ・コード値を返します。値は、各レコード・コンポーネントのハッシュ・コードから導出されます。

定義:

hashCode クラス内 Record

戻り値:

このオブジェクトのハッシュ・コード値

equals

public final boolean equals(Object o)

他のオブジェクトがこれと"等しい"かどうかを示します。他のオブジェクトが同じクラスであり、すべてのレコード・コンポーネントが等しい場合、オブジェクトは等しくなります。 このレコード内のすべてのコンポーネントはObjects::equals(Object,Object)と比較されます。

定義:

equals クラス内 Record

パラメータ:

o - 比較するオブジェクト

戻り値:

このオブジェクトがo引数と同じである場合はtrue、それ以外の場合はfalse。

model

public String model()

modelレコード・コンポーネントの値が返されます。

戻り値:

modelレコード・コンポーネントの値

temperature

public Float temperature()

temperatureレコード・コンポーネントの値が返されます。

戻り値:

temperatureレコード・コンポーネントの値

top_p

public Float top_p()

top_pレコード・コンポーネントの値が返されます。

戻り値:

top_pレコード・コンポーネントの値

n

public Integer n()

nレコード・コンポーネントの値が返されます。

戻り値:

nレコード・コンポーネントの値

max_tokens

public Integer max_tokens()

max_tokensレコード・コンポーネントの値が返されます。

戻り値:

max_tokensレコード・コンポーネントの値

presence_penalty

public Float presence_penalty()

presence_penaltyレコード・コンポーネントの値が返されます。

戻り値:

presence_penaltyレコード・コンポーネントの値

frequency_penalty

public Float frequency_penalty()

frequency_penaltyレコード・コンポーネントの値が返されます。

戻り値:

frequency_penaltyレコード・コンポーネントの値

user

public String user()

userレコード・コンポーネントの値が返されます。

戻り値:

userレコード・コンポーネントの値

messages

public List<ChatRequest.ChatMessage> messages()

messagesレコード・コンポーネントの値が返されます。

戻り値:

messagesレコード・コンポーネントの値