Package io.github.stefanbratanov.jvm.openai

Class AssistantsClient

java.lang.Object

io.github.stefanbratanov.jvm.openai.AssistantsClient

public final class AssistantsClient
extends Object

Build assistants that can call models and use tools to perform tasks.

Based on Assistants

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	AssistantsClient.PaginatedAssistantFiles
static final record	AssistantsClient.PaginatedAssistants

Method Summary

Modifier and Type	Method	Description
Assistant	createAssistant(CreateAssistantRequest request)	Create an assistant with a model and instructions.
AssistantFile	createAssistantFile(String assistantId, String fileId)	Create an assistant file by attaching a File to an assistant.
DeletionStatus	deleteAssistant(String assistantId)	Delete an assistant.
DeletionStatus	deleteAssistantFile(String assistantId, String fileId)	Delete an assistant file.
AssistantsClient.PaginatedAssistantFiles	listAssistantFiles(String assistantId, PaginationQueryParameters paginationQueryParameters)	Returns a list of assistant files.
AssistantsClient.PaginatedAssistants	listAssistants(PaginationQueryParameters paginationQueryParameters)	Returns a list of assistants.
Assistant	modifyAssistant(String assistantId, ModifyAssistantRequest request)	Modifies an assistant.
Assistant	retrieveAssistant(String assistantId)	Retrieves an assistant.
AssistantFile	retrieveAssistantFile(String assistantId, String fileId)	Retrieves an AssistantFile.

Methods inherited from class java.lang.Object

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

Method Details

createAssistant

public Assistant createAssistant(CreateAssistantRequest request)

Create an assistant with a model and instructions.

Throws:

OpenAIException - in case of API errors

createAssistantFile

public AssistantFile createAssistantFile(String assistantId,
 String fileId)

Create an assistant file by attaching a File to an assistant.

Throws:

OpenAIException - in case of API errors

listAssistants

public AssistantsClient.PaginatedAssistants listAssistants(PaginationQueryParameters paginationQueryParameters)

Returns a list of assistants.

Throws:

OpenAIException - in case of API errors

listAssistantFiles

public AssistantsClient.PaginatedAssistantFiles listAssistantFiles(String assistantId,
 PaginationQueryParameters paginationQueryParameters)

Returns a list of assistant files.

Throws:

OpenAIException - in case of API errors

retrieveAssistant

public Assistant retrieveAssistant(String assistantId)

Retrieves an assistant.

Throws:

OpenAIException - in case of API errors

retrieveAssistantFile

public AssistantFile retrieveAssistantFile(String assistantId,
 String fileId)

Retrieves an AssistantFile.

Throws:

OpenAIException - in case of API errors

modifyAssistant

public Assistant modifyAssistant(String assistantId,
 ModifyAssistantRequest request)

Modifies an assistant.

Throws:

OpenAIException - in case of API errors

deleteAssistant

public DeletionStatus deleteAssistant(String assistantId)

Delete an assistant.

Throws:

OpenAIException - in case of API errors

deleteAssistantFile

public DeletionStatus deleteAssistantFile(String assistantId,
 String fileId)

Delete an assistant file.

Throws:

OpenAIException - in case of API errors