PromptExecutionSettings Class
Definition
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.
Provides execution settings for an AI request.
public class PromptExecutionSettingstype PromptExecutionSettings = classPublic Class PromptExecutionSettings- Inheritance
-
PromptExecutionSettings
- Derived
Remarks
Implementors of ITextGenerationService or IChatCompletionService can extend this if the service they are calling supports additional properties. For an example, please reference the Microsoft.SemanticKernel.Connectors.OpenAI.OpenAIPromptExecutionSettings implementation.
Constructors
| PromptExecutionSettings() |
Properties
| DefaultServiceId |
Gets the default service identifier. |
| ExtensionData |
Extra properties that may be included in the serialized execution settings. |
| FunctionChoiceBehavior |
Gets or sets the behavior defining the way functions are chosen by LLM and how they are invoked by AI connectors. |
| IsFrozen |
Gets a value that indicates whether the PromptExecutionSettings are currently modifiable. |
| ModelId |
Model identifier. This identifies the AI model these settings are configured for e.g., gpt-4, gpt-3.5-turbo |
| ServiceId |
Service identifier. This identifies the service these settings are configured for e.g., azure_openai_eastus, openai, ollama, huggingface, etc. |
Methods
| Clone() |
Creates a new PromptExecutionSettings object that is a copy of the current instance. |
| Freeze() |
Makes the current PromptExecutionSettings unmodifiable and sets its IsFrozen property to true. |
| ThrowIfFrozen() |
Throws an InvalidOperationException if the PromptExecutionSettings are frozen. |