Allow Github Copilot to be used with Terminal Chat

src/cascadia/QueryExtension/AzureLLMProvider.cpp

@@ -175,7 +175,7 @@ namespace winrt::Microsoft::Terminal::Query::Extension::implementation
         responseMessageObject.Insert(contentString, WDJ::JsonValue::CreateStringValue(message));
         _jsonMessages.Append(responseMessageObject);
 
-        co_return winrt::make<AzureResponse>(message, errorType);
+        co_return winrt::make<AzureResponse>(message, errorType, L"");
     }
 
     bool AzureLLMProvider::_verifyModelIsValidHelper(const WDJ::JsonObject jsonResponse)

src/cascadia/QueryExtension/AzureLLMProvider.h

@@ -11,13 +11,20 @@ namespace winrt::Microsoft::Terminal::Query::Extension::implementation
     {
         AzureBranding() = default;
 
-        WINRT_PROPERTY(winrt::hstring, Name, L"Azure OpenAI");
-        WINRT_PROPERTY(winrt::hstring, HeaderIconPath);
-        WINRT_PROPERTY(winrt::hstring, HeaderText);
-        WINRT_PROPERTY(winrt::hstring, SubheaderText);
-        WINRT_PROPERTY(winrt::hstring, BadgeIconPath);
-        WINRT_PROPERTY(winrt::hstring, ResponseMetaData);
-        WINRT_PROPERTY(winrt::hstring, QueryMetaData);
+        winrt::hstring Name() { return _name; };
+        winrt::hstring HeaderIconPath() { return _headerIconPath; };
+        winrt::hstring HeaderText() { return _headerText; };
+        winrt::hstring SubheaderText() { return _subheaderText; };
+        winrt::hstring BadgeIconPath() { return _badgeIconPath; };
+        winrt::hstring QueryAttribution() { return _queryAttribution; };
+
+    private:
+        winrt::hstring _name{ L"Azure OpenAI" };
+        winrt::hstring _headerIconPath;
+        winrt::hstring _headerText;
+        winrt::hstring _subheaderText;
+        winrt::hstring _badgeIconPath;
+        winrt::hstring _queryAttribution;
     };
 
     struct AzureLLMProvider : AzureLLMProviderT<AzureLLMProvider>
@@ -28,17 +35,18 @@ namespace winrt::Microsoft::Terminal::Query::Extension::implementation
         void SetSystemPrompt(const winrt::hstring& systemPrompt);
         void SetContext(Extension::IContext context);
 
+        IBrandingData BrandingData() { return _brandingData; };
+
         winrt::Windows::Foundation::IAsyncOperation<Extension::IResponse> GetResponseAsync(const winrt::hstring& userPrompt);
 
         void SetAuthentication(const Windows::Foundation::Collections::ValueSet& authValues);
         TYPED_EVENT(AuthChanged, winrt::Microsoft::Terminal::Query::Extension::ILMProvider, winrt::Microsoft::Terminal::Query::Extension::IAuthenticationResult);
 
-        WINRT_PROPERTY(IBrandingData, BrandingData, winrt::make<AzureBranding>());
-
     private:
         winrt::hstring _azureEndpoint;
         winrt::hstring _azureKey;
         winrt::Windows::Web::Http::HttpClient _httpClient{ nullptr };
+        IBrandingData _brandingData{ winrt::make<AzureBranding>() };
 
         Extension::IContext _context;
 
@@ -49,12 +57,14 @@ namespace winrt::Microsoft::Terminal::Query::Extension::implementation
 
     struct AzureResponse : public winrt::implements<AzureResponse, winrt::Microsoft::Terminal::Query::Extension::IResponse>
     {
-        AzureResponse(const winrt::hstring& message, const winrt::Microsoft::Terminal::Query::Extension::ErrorTypes errorType) :
+        AzureResponse(const winrt::hstring& message, const winrt::Microsoft::Terminal::Query::Extension::ErrorTypes errorType, const winrt::hstring& responseAttribution) :
             Message{ message },
-            ErrorType{ errorType } {}
+            ErrorType{ errorType },
+            ResponseAttribution{ responseAttribution } {}
 
         til::property<winrt::hstring> Message;
         til::property<winrt::Microsoft::Terminal::Query::Extension::ErrorTypes> ErrorType;
+        til::property<winrt::hstring> ResponseAttribution;
     };
 }
 

src/cascadia/QueryExtension/ExtensionPalette.cpp

@@ -118,8 +118,8 @@ namespace winrt::Microsoft::Terminal::Query::Extension::implementation
     {
         const auto userMessage = winrt::make<ChatMessage>(prompt, true, false);
         std::vector<IInspectable> userMessageVector{ userMessage };
-        const auto queryMetaData = _lmProvider ? _lmProvider.BrandingData().QueryMetaData() : L"";
-        const auto userGroupedMessages = winrt::make<GroupedChatMessages>(currentLocalTime, true, _ProfileName, winrt::single_threaded_vector(std::move(userMessageVector)), queryMetaData);
+        const auto queryAttribution = _lmProvider ? _lmProvider.BrandingData().QueryAttribution() : L"";
+        const auto userGroupedMessages = winrt::make<GroupedChatMessages>(currentLocalTime, true, winrt::single_threaded_vector(std::move(userMessageVector)), queryAttribution);
         _messages.Append(userGroupedMessages);
         _queryBox().Text(L"");
 
@@ -152,7 +152,7 @@ namespace winrt::Microsoft::Terminal::Query::Extension::implementation
         }
         else
         {
-            result = winrt::make<SystemResponse>(RS_(L"CouldNotFindKeyErrorMessage"), ErrorTypes::InvalidAuth);
+            result = winrt::make<SystemResponse>(RS_(L"CouldNotFindKeyErrorMessage"), ErrorTypes::InvalidAuth, L"");
         }
 
         // Switch back to the foreground thread because we are changing the UI now
@@ -164,7 +164,7 @@ namespace winrt::Microsoft::Terminal::Query::Extension::implementation
             IsProgressRingActive(false);
 
             // Append the result to our list, clear the query box
-            _splitResponseAndAddToChatHelper(result.Message(), result.ErrorType());
+            _splitResponseAndAddToChatHelper(result);
         }
 
         co_return;
@@ -184,12 +184,12 @@ namespace winrt::Microsoft::Terminal::Query::Extension::implementation
         return winrt::to_hstring(time_str);
     }
 
-    void ExtensionPalette::_splitResponseAndAddToChatHelper(const winrt::hstring& response, const ErrorTypes errorType)
+    void ExtensionPalette::_splitResponseAndAddToChatHelper(const IResponse response)
     {
         // this function is dependent on the AI response separating code blocks with
         // newlines and "```". OpenAI seems to naturally conform to this, though
         // we could probably engineer the prompt to specify this if we need to.
-        std::wstringstream ss(response.c_str());
+        std::wstringstream ss(response.Message().c_str());
         std::wstring line;
         std::wstring codeBlock;
         bool inCodeBlock = false;
@@ -230,17 +230,17 @@ namespace winrt::Microsoft::Terminal::Query::Extension::implementation
         }
 
         const auto brandingData = _lmProvider.BrandingData();
-        const auto responseMetaData = _lmProvider ? brandingData.ResponseMetaData() : L"";
+        const auto responseAttribution = response.ResponseAttribution().empty() ? _ProfileName : response.ResponseAttribution();
         const auto badgeUriPath = _lmProvider ? brandingData.BadgeIconPath() : L"";
-        const auto responseGroupedMessages = winrt::make<GroupedChatMessages>(time, false, _ProfileName, winrt::single_threaded_vector(std::move(messageParts)), responseMetaData, badgeUriPath);
+        const auto responseGroupedMessages = winrt::make<GroupedChatMessages>(time, false, winrt::single_threaded_vector(std::move(messageParts)), responseAttribution, badgeUriPath);
         _messages.Append(responseGroupedMessages);
 
         const auto lmProviderName = _lmProvider ? _lmProvider.BrandingData().Name() : L"";
         TraceLoggingWrite(
             g_hQueryExtensionProvider,
             "AIResponseReceived",
             TraceLoggingDescription("Event emitted when the user receives a response to their query"),
-            TraceLoggingBoolean(errorType == ErrorTypes::None, "ResponseReceivedFromAI", "True if the response came from the AI, false if the response was generated in Terminal or was a server error"),
+            TraceLoggingBoolean(response.ErrorType() == ErrorTypes::None, "ResponseReceivedFromAI", "True if the response came from the AI, false if the response was generated in Terminal or was a server error"),
             TraceLoggingWideString(lmProviderName.c_str(), "LMProviderName", "The name of the connected service provider, if present"),
             TraceLoggingKeyword(MICROSOFT_KEYWORD_CRITICAL_DATA),
             TelemetryPrivacyDataTag(PDT_ProductAndServiceUsage));

src/cascadia/QueryExtension/ExtensionPalette.h

@@ -43,7 +43,7 @@ namespace winrt::Microsoft::Terminal::Query::Extension::implementation
         winrt::fire_and_forget _getSuggestions(const winrt::hstring& prompt, const winrt::hstring& currentLocalTime);
 
         winrt::hstring _getCurrentLocalTimeHelper();
-        void _splitResponseAndAddToChatHelper(const winrt::hstring& response, const winrt::Microsoft::Terminal::Query::Extension::ErrorTypes errorType);
+        void _splitResponseAndAddToChatHelper(const winrt::Microsoft::Terminal::Query::Extension::IResponse response);
         void _setFocusAndPlaceholderTextHelper();
 
         void _clearAndInitializeMessages(const Windows::Foundation::IInspectable& sender, const Windows::UI::Xaml::RoutedEventArgs& args);
@@ -79,16 +79,14 @@ namespace winrt::Microsoft::Terminal::Query::Extension::implementation
     {
         GroupedChatMessages(winrt::hstring key,
                             bool isQuery,
-                            winrt::hstring profileName,
                             const Windows::Foundation::Collections::IVector<Windows::Foundation::IInspectable>& messages,
-                            winrt::hstring metaData = L"",
+                            winrt::hstring attribution = L"",
                             winrt::hstring badgeImagePath = L"")
         {
             _Key = key;
             _isQuery = isQuery;
-            _ProfileName = profileName;
             _messages = messages;
-            _MetaData = metaData.empty() ? _ProfileName : metaData;
+            _Attribution = attribution;
 
             if (!badgeImagePath.empty())
             {
@@ -152,7 +150,7 @@ namespace winrt::Microsoft::Terminal::Query::Extension::implementation
         bool IsQuery() const { return _isQuery; };
         WINRT_PROPERTY(winrt::hstring, Key);
         WINRT_PROPERTY(winrt::hstring, ProfileName);
-        WINRT_PROPERTY(winrt::hstring, MetaData);
+        WINRT_PROPERTY(winrt::hstring, Attribution);
         WINRT_PROPERTY(winrt::Windows::UI::Xaml::Media::Imaging::BitmapImage, BadgeBitmapImage, nullptr);
 
     private:
@@ -170,12 +168,14 @@ namespace winrt::Microsoft::Terminal::Query::Extension::implementation
 
     struct SystemResponse : public winrt::implements<SystemResponse, winrt::Microsoft::Terminal::Query::Extension::IResponse>
     {
-        SystemResponse(const winrt::hstring& message, const winrt::Microsoft::Terminal::Query::Extension::ErrorTypes errorType) :
+        SystemResponse(const winrt::hstring& message, const winrt::Microsoft::Terminal::Query::Extension::ErrorTypes errorType, const winrt::hstring& responseAttribution) :
             Message{ message },
-            ErrorType{ errorType } {}
+            ErrorType{ errorType },
+            ResponseAttribution{ responseAttribution } {}
 
         til::property<winrt::hstring> Message;
         til::property<winrt::Microsoft::Terminal::Query::Extension::ErrorTypes> ErrorType;
+        til::property<winrt::hstring> ResponseAttribution;
     };
 }
 

src/cascadia/QueryExtension/ExtensionPalette.idl

@@ -15,9 +15,9 @@ namespace Microsoft.Terminal.Query.Extension
 
     runtimeclass GroupedChatMessages : Windows.Foundation.Collections.IVector<IInspectable>
     {
-        GroupedChatMessages(String key, Boolean isQuery, String profileName, Windows.Foundation.Collections.IVector<IInspectable> messages, String MetaData, String badgeImagePath);
+        GroupedChatMessages(String key, Boolean isQuery, Windows.Foundation.Collections.IVector<IInspectable> messages, String Attribution, String badgeImagePath);
         String Key;
-        String MetaData;
+        String Attribution;
         Windows.UI.Xaml.Media.Imaging.BitmapImage BadgeBitmapImage;
         Boolean IsQuery { get; };
     }

src/cascadia/QueryExtension/ExtensionPalette.xaml

@@ -170,7 +170,7 @@
                             Spacing="4">
                     <TextBlock FontFamily="Segoe UI"
                                FontSize="12">
-                        <Run Text="{x:Bind MetaData}" />
+                        <Run Text="{x:Bind Attribution}" />
                     </TextBlock>
                     <TextBlock FontFamily="Segoe UI"
                                FontSize="12"
@@ -189,7 +189,7 @@
                     <mux:ImageIcon Source="{x:Bind BadgeBitmapImage}"/>
                     <TextBlock FontFamily="Segoe UI"
                                FontSize="12">
-                        <Run Text="{x:Bind MetaData}" />
+                        <Run Text="{x:Bind Attribution}" />
                     </TextBlock>
                     <TextBlock FontFamily="Segoe UI"
                                FontSize="12"

src/cascadia/QueryExtension/GithubCopilotLLMProvider.cpp

@@ -68,11 +68,10 @@ namespace winrt::Microsoft::Terminal::Query::Extension::implementation
 {
     GithubCopilotBranding::GithubCopilotBranding()
     {
-        _HeaderIconPath = headerIconPath;
-        _HeaderText = RS_(L"GithubCopilot_HeaderText");
-        _SubheaderText = RS_(L"GithubCopilot_SubheaderText");
-        _BadgeIconPath = badgeIconPath;
-        _ResponseMetaData = RS_(L"GithubCopilot_ResponseMetaData");
+        _headerIconPath = headerIconPath;
+        _headerText = RS_(L"GithubCopilot_HeaderText");
+        _subheaderText = RS_(L"GithubCopilot_SubheaderText");
+        _badgeIconPath = badgeIconPath;
     }
 
     void GithubCopilotLLMProvider::SetAuthentication(const Windows::Foundation::Collections::ValueSet& authValues)
@@ -129,8 +128,8 @@ namespace winrt::Microsoft::Terminal::Query::Extension::implementation
                 const auto copilotEndpoint = viewerObject.GetNamedObject(copilotEndpointsKey).GetNamedString(apiKey);
 
                 _endpointUri = copilotEndpoint + chatCompletionSuffix;
-                const auto brandingData{ get_self<GithubCopilotBranding>(_BrandingData) };
-                brandingData->QueryMetaData(userName);
+                const auto brandingData{ get_self<GithubCopilotBranding>(_brandingData) };
+                brandingData->QueryAttribution(userName);
                 break;
             }
             CATCH_LOG();
@@ -300,7 +299,7 @@ namespace winrt::Microsoft::Terminal::Query::Extension::implementation
         responseMessageObject.Insert(contentKey, WDJ::JsonValue::CreateStringValue(message));
         _jsonMessages.Append(responseMessageObject);
 
-        co_return winrt::make<GithubCopilotResponse>(message, errorType);
+        co_return winrt::make<GithubCopilotResponse>(message, errorType, RS_(L"GithubCopilot_ResponseMetaData"));
     }
 
     void GithubCopilotLLMProvider::_refreshAuthTokens()

src/cascadia/QueryExtension/GithubCopilotLLMProvider.h

@@ -11,13 +11,19 @@ namespace winrt::Microsoft::Terminal::Query::Extension::implementation
     {
         GithubCopilotBranding();
 
-        WINRT_PROPERTY(winrt::hstring, Name, L"GitHub Copilot");
-        WINRT_PROPERTY(winrt::hstring, HeaderIconPath);
-        WINRT_PROPERTY(winrt::hstring, HeaderText);
-        WINRT_PROPERTY(winrt::hstring, SubheaderText);
-        WINRT_PROPERTY(winrt::hstring, BadgeIconPath);
-        WINRT_PROPERTY(winrt::hstring, ResponseMetaData);
-        WINRT_PROPERTY(winrt::hstring, QueryMetaData);
+        winrt::hstring Name() { return _name; };
+        winrt::hstring HeaderIconPath() { return _headerIconPath; };
+        winrt::hstring HeaderText() { return _headerText; };
+        winrt::hstring SubheaderText() { return _subheaderText; };
+        winrt::hstring BadgeIconPath() { return _badgeIconPath; };
+        WINRT_PROPERTY(winrt::hstring, QueryAttribution);
+
+    private:
+        winrt::hstring _name{ L"GitHub Copilot" };
+        winrt::hstring _headerIconPath;
+        winrt::hstring _headerText;
+        winrt::hstring _subheaderText;
+        winrt::hstring _badgeIconPath;
     };
 
     struct GithubCopilotAuthenticationResult : public winrt::implements<GithubCopilotAuthenticationResult, winrt::Microsoft::Terminal::Query::Extension::IAuthenticationResult>
@@ -38,18 +44,19 @@ namespace winrt::Microsoft::Terminal::Query::Extension::implementation
         void SetSystemPrompt(const winrt::hstring& systemPrompt);
         void SetContext(const Extension::IContext context);
 
+        IBrandingData BrandingData() { return _brandingData; };
+
         winrt::Windows::Foundation::IAsyncOperation<Extension::IResponse> GetResponseAsync(const winrt::hstring& userPrompt);
 
         void SetAuthentication(const Windows::Foundation::Collections::ValueSet& authValues);
         TYPED_EVENT(AuthChanged, winrt::Microsoft::Terminal::Query::Extension::ILMProvider, winrt::Microsoft::Terminal::Query::Extension::IAuthenticationResult);
 
-        WINRT_PROPERTY(IBrandingData, BrandingData, winrt::make<GithubCopilotBranding>());
-
     private:
         winrt::hstring _authToken;
         winrt::hstring _refreshToken;
         winrt::hstring _endpointUri;
         winrt::Windows::Web::Http::HttpClient _httpClient{ nullptr };
+        IBrandingData _brandingData{ winrt::make<GithubCopilotBranding>() };
         winrt::hstring _lastResponse;
 
         Extension::IContext _context;
@@ -64,12 +71,14 @@ namespace winrt::Microsoft::Terminal::Query::Extension::implementation
 
     struct GithubCopilotResponse : public winrt::implements<GithubCopilotResponse, winrt::Microsoft::Terminal::Query::Extension::IResponse>
     {
-        GithubCopilotResponse(const winrt::hstring& message, const winrt::Microsoft::Terminal::Query::Extension::ErrorTypes errorType) :
+        GithubCopilotResponse(const winrt::hstring& message, const winrt::Microsoft::Terminal::Query::Extension::ErrorTypes errorType, const winrt::hstring& responseAttribution) :
             Message{ message },
-            ErrorType{ errorType } {}
+            ErrorType{ errorType },
+            ResponseAttribution{ responseAttribution } {}
 
         til::property<winrt::hstring> Message;
         til::property<winrt::Microsoft::Terminal::Query::Extension::ErrorTypes> ErrorType;
+        til::property<winrt::hstring> ResponseAttribution;
     };
 }
 

src/cascadia/QueryExtension/ILMProvider.idl

@@ -10,8 +10,7 @@ namespace Microsoft.Terminal.Query.Extension
         String HeaderText { get; };
         String SubheaderText { get; };
         String BadgeIconPath { get; };
-        String ResponseMetaData { get; };
-        String QueryMetaData { get; };
+        String QueryAttribution { get; };
     };
 
     interface IAuthenticationResult
@@ -50,6 +49,7 @@ namespace Microsoft.Terminal.Query.Extension
     {
         String Message { get; };
         ErrorTypes ErrorType { get; };
+        String ResponseAttribution { get; };
     };
 
     interface IContext

src/cascadia/QueryExtension/OpenAILLMProvider.cpp

@@ -121,6 +121,6 @@ namespace winrt::Microsoft::Terminal::Query::Extension::implementation
         responseMessageObject.Insert(L"content", WDJ::JsonValue::CreateStringValue(message));
         _jsonMessages.Append(responseMessageObject);
 
-        co_return winrt::make<OpenAIResponse>(message, errorType);
+        co_return winrt::make<OpenAIResponse>(message, errorType, L"");
     }
 }