Allow OpenAI to be used with Terminal Chat #17540

PankajBhojwani · 2024-07-09T22:04:12Z

Implements OpenAILLMProvider, which is an implementation of ILMProvider that uses OpenAI
Implements an AIConfig on the settings model side, to allow the user to specify which AI provider to use as their current active one (in the case that they have configured more than one LMProvider)

The OpenAI implementation is largely the same as the Azure OpenAI one. The more "new" change in this PR is the AIConfig struct on the settings model side that allows the user to specify which provider is the active one, as well as the logic in TerminalPage for how we update the current active provider based on settings changes

Validation Steps Performed

Able to set OpenAI as the active provider
OpenAI works in Terminal Chat

src/cascadia/QueryExtension/Microsoft.Terminal.Query.Extension.vcxproj

@@ -56,6 +56,9 @@
    <ClInclude Include="AzureLLMProvider.h">
      <DependentUpon>AzureLLMProvider.idl</DependentUpon>
    </ClInclude>
+    <ClInclude Include="OpenAILLMProvider.h">


src/cascadia/TerminalSettingsEditor/AISettingsViewModel.cpp

+        _NotifyChanges(L"IsOpenAIKeySet");
+    }
+
+    bool AISettingsViewModel::AzureOpenAIIsActive()


src/cascadia/QueryExtension/OpenAILLMProvider.cpp

@@ -0,0 +1,129 @@
+// Copyright (c) Microsoft Corporation.


src/cascadia/QueryExtension/OpenAILLMProvider.h

@@ -0,0 +1,48 @@
+// Copyright (c) Microsoft Corporation.


src/cascadia/QueryExtension/OpenAILLMProvider.idl

@@ -0,0 +1,17 @@
+// Copyright (c) Microsoft Corporation.


src/cascadia/QueryExtension/Microsoft.Terminal.Query.Extension.vcxproj

@@ -96,6 +102,9 @@
    <Midl Include="AzureLLMProvider.idl">
      <SubType>Code</SubType>
    </Midl>
+    <Midl Include="OpenAILLMProvider.idl">


src/cascadia/TerminalSettingsEditor/AISettings.xaml

+                                </Button>
+                                <Button Click="SetAzureOpenAIActive_Click"
+                                        HorizontalAlignment="Center"
+                                        Visibility="{x:Bind mtu:Converters.InvertedBooleanToVisibility(ViewModel.AzureOpenAIIsActive), Mode=OneWay}">


src/cascadia/TerminalSettingsEditor/AISettings.xaml

+                                </Button>
+                                <Button Click="SetOpenAIActive_Click"
+                                        HorizontalAlignment="Center"
+                                        Visibility="{x:Bind mtu:Converters.InvertedBooleanToVisibility(ViewModel.OpenAIIsActive), Mode=OneWay}">


src/cascadia/TerminalSettingsEditor/AISettingsViewModel.cpp

+    void AISettingsViewModel::SetAzureOpenAIActive()
+    {
+        _Settings.GlobalSettings().AIInfo().ActiveProvider(Model::LLMProvider::AzureOpenAI);
+        _NotifyChanges(L"AzureOpenAIIsActive");


src/cascadia/TerminalSettingsEditor/AISettingsViewModel.cpp

+    {
+        _Settings.GlobalSettings().AIInfo().ActiveProvider(Model::LLMProvider::AzureOpenAI);
+        _NotifyChanges(L"AzureOpenAIIsActive");
+        _NotifyChanges(L"OpenAIIsActive");


src/cascadia/QueryExtension/OpenAILLMProvider.cpp

PankajBhojwani · 2024-07-09T23:54:17Z

src/cascadia/TerminalSettingsModel/AIConfig.cpp

+    const auto val{ _getActiveProviderImpl() };
+    if (val)
+    {
+        // an active provider was explicitly set, return that
+        return *val;
+    }


This does mean that you can set an active provider even if you have not configured that provider - in this case when you try to use the Chat the provider will return the appropriate error. For example, the OpenAI provider will still make the http request and we get an error message back that no api key was provided.

src/cascadia/TerminalSettingsModel/GlobalAppSettings.cpp

src/cascadia/TerminalSettingsModel/AIConfig.cpp

src/cascadia/QueryExtension/OpenAILLMProvider.cpp

src/cascadia/TerminalSettingsEditor/AISettingsViewModel.idl

src/cascadia/TerminalSettingsEditor/AISettings.xaml

…nto dev/pabhoj/llm_provider_interface

lhecker

Biggest concern: The strong-this issue. Otherwise, it seems fine - just some smaller issues.

src/cascadia/QueryExtension/OpenAILLMProvider.cpp

src/cascadia/TerminalApp/TerminalPage.cpp

src/cascadia/TerminalSettingsEditor/AISettings.cpp

src/cascadia/TerminalSettingsModel/AIConfig.cpp

DHowett · 2024-10-23T22:35:17Z

src/cascadia/TerminalSettingsModel/AIConfig.idl

+{
+    enum LLMProvider
+    {
+        AzureOpenAI,


you need a None option to return in case none are set - otherwise, the zero value is AzureOpenAI

Yeah I realized this in #18095 and added it there, I'll bring that change forward to here

DHowett · 2024-10-23T22:35:35Z

src/cascadia/TerminalSettingsModel/AIConfig.cpp

+    }
+    else
+    {
+        return LLMProvider{};


(The note about having a zero value applies here!)

PankajBhojwani added 15 commits June 6, 2024 14:40

got an idl

b44216b

works

e78e4d0

allow

ac83d76

conflict

4b944e9

use id here too

ef406ee

have terminal page initialize the llmprovider

4fb4ca4

format

e5afbae

consts

32b3d68

works on palette side

1700a92

open ai in settings, llmprovider enum

08dd951

aiconfig struct

1934b30

move more things to ai info

96a489a

active provider buttons

8e560e2

rename to lmprovider

f9e9326

spelling conflict

4133239

github-advanced-security bot found potential problems Jul 9, 2024

View reviewed changes

PankajBhojwani added 2 commits July 9, 2024 15:33

conflicts

e545ca2

spell

dfad8d9

github-advanced-security bot found potential problems Jul 9, 2024

View reviewed changes

src/cascadia/QueryExtension/OpenAILLMProvider.cpp Fixed Show fixed Hide fixed