Interface ChatCompletionClient

All Known Implementing Classes:

OpenAiCompatibleChatCompletionClient

public interface ChatCompletionClient

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final record	ChatCompletionClient.Turn

Method Summary

Modifier and Type	Method	Description
@Nullable String	complete(String systemPrompt, List<ChatCompletionClient.Turn> conversation)
@Nullable String	complete(String systemPrompt, List<ChatCompletionClient.Turn> conversation, TextResourceSearchTool tool)	Same as complete(String, List), but the LLM has to call the tool before it answers.

Method Details

complete

@Nullable String complete(String systemPrompt,
 List<ChatCompletionClient.Turn> conversation)

Parameters:

systemPrompt - instructions for the assistant (grounding, citation, language)

conversation - ordered turns, each authored by the Role.USER or Role.ASSISTANT

Returns:

the assistant's answer text, or null if the provider returned no content

Throws:

AiAssistantException - if the generation provider is unreachable or returns an error

complete

@Nullable String complete(String systemPrompt,
 List<ChatCompletionClient.Turn> conversation,
 TextResourceSearchTool tool)

Same as complete(String, List), but the LLM has to call the tool before it answers.