OpenAIChatCompletionService Class

Reference

Definition

Namespace:: Microsoft.SemanticKernel.Connectors.OpenAI

Assembly:: Microsoft.SemanticKernel.Connectors.OpenAI.dll

Package:: Microsoft.SemanticKernel.Connectors.OpenAI v1.20.0

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

OpenAI chat completion service.

public sealed class OpenAIChatCompletionService : Microsoft.SemanticKernel.ChatCompletion.IChatCompletionService, Microsoft.SemanticKernel.TextGeneration.ITextGenerationService

type OpenAIChatCompletionService = class
    interface IChatCompletionService
    interface IAIService
    interface ITextGenerationService

Public NotInheritable Class OpenAIChatCompletionService
Implements IChatCompletionService, ITextGenerationService

Inheritance: Object
OpenAIChatCompletionService

Implements: IChatCompletionService IAIService ITextGenerationService

Constructors

OpenAIChatCompletionService(String, OpenAIClient, ILoggerFactory)	Create an instance of the OpenAI chat completion connector
OpenAIChatCompletionService(String, String, String, HttpClient, ILoggerFactory)	Create an instance of the OpenAI chat completion connector
OpenAIChatCompletionService(String, Uri, String, String, HttpClient, ILoggerFactory)	Create an instance of the Custom Message API OpenAI chat completion connector

Properties

Attributes

Gets the AI service attributes.

Methods

GetChatMessageContentsAsync(ChatHistory, PromptExecutionSettings, Kernel, CancellationToken)	Get chat multiple chat content choices for the prompt and settings.
GetStreamingChatMessageContentsAsync(ChatHistory, PromptExecutionSettings, Kernel, CancellationToken)	Get streaming chat contents for the chat history provided using the specified settings.
GetStreamingTextContentsAsync(String, PromptExecutionSettings, Kernel, CancellationToken)	Get streaming results for the prompt using the specified execution settings. Each modality may support for different types of streaming contents.
GetTextContentsAsync(String, PromptExecutionSettings, Kernel, CancellationToken)	Get completion results for the prompt and settings.

Extension Methods

GetChatMessageContentAsync(IChatCompletionService, ChatHistory, PromptExecutionSettings, Kernel, CancellationToken)	Get a single chat message content for the chat history and settings provided.
GetChatMessageContentAsync(IChatCompletionService, String, PromptExecutionSettings, Kernel, CancellationToken)	Get a single chat message content for the prompt and settings.
GetChatMessageContentsAsync(IChatCompletionService, String, PromptExecutionSettings, Kernel, CancellationToken)	Get chat multiple chat message content choices for the prompt and settings.
GetStreamingChatMessageContentsAsync(IChatCompletionService, String, PromptExecutionSettings, Kernel, CancellationToken)	Get streaming chat message contents for the chat history provided using the specified settings.
GetApiVersion(IAIService)	Gets the API version from `service`'s Attributes
GetEndpoint(IAIService)	Gets the endpoint from `service`'s Attributes.
GetModelId(IAIService)	Gets the model identifier from `service`'s Attributes.
GetTextContentAsync(ITextGenerationService, String, PromptExecutionSettings, Kernel, CancellationToken)	Get a single text generation result for the prompt and settings.

Applies to

Freigeben über