Package com.microsoft.semantickernel.services.chatcompletion

Interface ChatCompletionService

All Superinterfaces:

AIService, TextAIService

public interface ChatCompletionService
extends TextAIService

Chat completion service interface.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ChatCompletionService.Builder	Builder API for creating a ChatCompletionService.

Field Summary

Fields inherited from interface com.microsoft.semantickernel.services.TextAIService

MAX_RESULTS_PER_PROMPT, MAXIMUM_INFLIGHT_AUTO_INVOKES

Method Summary

Modifier and Type	Method	Description
static ChatCompletionService.Builder	builder()	Get a builder for creating a ChatCompletionService.
reactor.core.publisher.Mono<List<ChatMessageContent<?>>>	getChatMessageContentsAsync(ChatHistory chatHistory, Kernel kernel, InvocationContext invocationContext)	Gets the chat message contents asynchronously using ChatHistory to support a turn-based conversation.
reactor.core.publisher.Mono<List<ChatMessageContent<?>>>	getChatMessageContentsAsync(String prompt, Kernel kernel, InvocationContext invocationContext)	Gets the chat message contents asynchronously using a prompt.

Methods inherited from interface com.microsoft.semantickernel.services.AIService

getModelId, getServiceId

Method Detail

builder

static ChatCompletionService.Builder builder()

Get a builder for creating a ChatCompletionService. The builder loads a service that implements the ChatCompletionService.Builder interface.

Returns:

a builder for creating a ChatCompletionService

getChatMessageContentsAsync

reactor.core.publisher.Mono<List<ChatMessageContent<?>>> getChatMessageContentsAsync(ChatHistory chatHistory,
                                                                                     @Nullable
                                                                                     Kernel kernel,
                                                                                     @Nullable
                                                                                     InvocationContext invocationContext)

Gets the chat message contents asynchronously using ChatHistory to support a turn-based conversation. Typically, the resulting chat message contents is appended to the chatHistory to continue the conversation.

Parameters:

chatHistory - the chat history

kernel - the kernel

invocationContext - the invocation context

Returns:

the chat message contents

getChatMessageContentsAsync

reactor.core.publisher.Mono<List<ChatMessageContent<?>>> getChatMessageContentsAsync(String prompt,
                                                                                     @Nullable
                                                                                     Kernel kernel,
                                                                                     @Nullable
                                                                                     InvocationContext invocationContext)

Gets the chat message contents asynchronously using a prompt.

Parameters:

prompt - the prompt

kernel - the kernel

invocationContext - the invocation context

Returns:

the chat message contents