Files
semantic-kernel/dotnet/samples/Demos/FunctionInvocationApproval/Options/OpenAIOptions.cs
T
Dmytro Struk 26ad632c85 .Net: Added function invocation approval demo app (#6109)
### Motivation and Context

<!-- Thank you for your contribution to the semantic-kernel repo!
Please help reviewers and future users, providing the following
information:
  1. Why is this change required?
  2. What problem does it solve?
  3. What scenario does it contribute to?
  4. If it fixes an open issue, please link to the issue here.
-->

This PR contains demo console application that shows how to use function
invocation filter to invoke function only if such operation was
approved. If function invocation was rejected, the result will contain
an information about this, so LLM can react accordingly. Application
uses a `SoftwareBuilderPlugin` that allows to build a software by
following main development stages: collection of requirements, design,
implementation, testing and deployment. Each step can be approved or
rejected. Based on that, LLM will decide how to proceed.

One of the possible outputs:
```
====================
Function name: CollectRequirements
Plugin name: SoftwareBuilderPlugin

Arguments: N/A

Approve invocation? (yes/no)
yes
Collecting requirements...
====================
Function name: Design
Plugin name: SoftwareBuilderPlugin

Arguments:
requirements: Requirements

Approve invocation? (yes/no)
yes
Designing based on: Requirements
====================
Function name: Implement
Plugin name: SoftwareBuilderPlugin

Arguments:
requirements: Requirements
design: Design

Approve invocation? (yes/no)
no

I'm sorry, but the implementation phase was rejected. It seems there might be an issue with the requirements or design. Let's review them and try again.
```

### Description

<!-- Describe your changes, the overall approach, the underlying design.
These notes will help understanding how your code works. Thanks! -->

### Contribution Checklist

<!-- Before submitting this PR, please make sure: -->

- [x] The code builds clean without any errors or warnings
- [x] The PR follows the [SK Contribution
Guidelines](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md)
and the [pre-submission formatting
script](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md#development-scripts)
raises no violations
- [x] All unit tests pass, and I have added new tests where possible
- [x] I didn't break anyone 😄
2024-05-08 13:48:48 +00:00

26 lines
697 B
C#

// Copyright (c) Microsoft. All rights reserved.
namespace FunctionInvocationApproval.Options;
/// <summary>
/// Configuration for OpenAI chat completion service.
/// </summary>
public class OpenAIOptions
{
public const string SectionName = "OpenAI";
/// <summary>
/// OpenAI model ID, see https://platform.openai.com/docs/models.
/// </summary>
public string ChatModelId { get; set; }
/// <summary>
/// OpenAI API key, see https://platform.openai.com/account/api-keys
/// </summary>
public string ApiKey { get; set; }
public bool IsValid =>
!string.IsNullOrWhiteSpace(this.ChatModelId) &&
!string.IsNullOrWhiteSpace(this.ApiKey);
}