Package io.github.stefanbratanov.jvm.openai

Class MessagesClient

java.lang.Object

io.github.stefanbratanov.jvm.openai.MessagesClient

public final class MessagesClient
extends Object

Create messages within threads

Based on Messages

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	MessagesClient.PaginatedThreadMessageFiles
static final record	MessagesClient.PaginatedThreadMessages

Method Summary

Modifier and Type	Method	Description
ThreadMessage	createMessage(String threadId, CreateMessageRequest request)	Create a message.
MessagesClient.PaginatedThreadMessageFiles	listMessageFiles(String threadId, String messageId, PaginationQueryParameters paginationQueryParameters)	Returns a list of message files.
MessagesClient.PaginatedThreadMessages	listMessages(String threadId, PaginationQueryParameters paginationQueryParameters, Optional<String> runId)	Returns a list of messages for a given thread.
ThreadMessage	modifyMessage(String threadId, String messageId, ModifyMessageRequest request)	Modifies a message.
ThreadMessage	retrieveMessage(String threadId, String messageId)	Retrieve a message.
ThreadMessageFile	retrieveMessageFile(String threadId, String messageId, String fileId)	Retrieves a message file.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

createMessage

public ThreadMessage createMessage(String threadId,
 CreateMessageRequest request)

Create a message.

Throws:

OpenAIException - in case of API errors

listMessages

public MessagesClient.PaginatedThreadMessages listMessages(String threadId,
 PaginationQueryParameters paginationQueryParameters,
 Optional<String> runId)

Returns a list of messages for a given thread.

Parameters:

runId - Filter messages by the run ID that generated them.

Throws:

OpenAIException - in case of API errors

listMessageFiles

public MessagesClient.PaginatedThreadMessageFiles listMessageFiles(String threadId,
 String messageId,
 PaginationQueryParameters paginationQueryParameters)

Returns a list of message files.

Throws:

OpenAIException - in case of API errors

retrieveMessage

public ThreadMessage retrieveMessage(String threadId,
 String messageId)

Retrieve a message.

Throws:

OpenAIException - in case of API errors

retrieveMessageFile

public ThreadMessageFile retrieveMessageFile(String threadId,
 String messageId,
 String fileId)

Retrieves a message file.

Throws:

OpenAIException - in case of API errors

modifyMessage

public ThreadMessage modifyMessage(String threadId,
 String messageId,
 ModifyMessageRequest request)

Modifies a message.

Throws:

OpenAIException - in case of API errors