Fix key error (#152)

- Fix key error that happens when citations are enabled and `altText` is provided instead of `text` - Format code to have longer line length
vsakkas · Feb 10, 2024 · ac8e480 · ac8e480
1 parent d8f3e7b
commit ac8e480
Show file tree

Hide file tree

Showing 3 changed files with 35 additions and 58 deletions.
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 # <img src="https://raw.githubusercontent.com/vsakkas/sydney.py/master/images/logo.svg" width="28px" /> Sydney.py
 
-[![Latest Release](https://img.shields.io/github/v/release/vsakkas/sydney.py.svg)](https://github.com/vsakkas/sydney.py/releases/tag/v0.20.1)
+[![Latest Release](https://img.shields.io/github/v/release/vsakkas/sydney.py.svg)](https://github.com/vsakkas/sydney.py/releases/tag/v0.20.2)
 [![Python](https://img.shields.io/badge/python-3.9+-blue.svg)](https://www.python.org/downloads/)
 [![MIT License](https://img.shields.io/badge/license-MIT-blue)](https://github.com/vsakkas/sydney.py/blob/master/LICENSE)
 

diff --git a/pyproject.toml b/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "sydney-py"
-version = "0.20.1"
+version = "0.20.2"
 description = "Python Client for Copilot (formerly named Bing Chat), also known as Sydney."
 authors = ["vsakkas <[email protected]>"]
 license = "MIT"

diff --git a/sydney/sydney.py b/sydney/sydney.py
@@ -76,9 +76,7 @@ def __init__(
         """
         self.bing_cookies = bing_cookies if bing_cookies else getenv("BING_COOKIES")
         self.use_proxy = use_proxy
-        self.conversation_style: ConversationStyle = getattr(
-            ConversationStyle, style.upper()
-        )
+        self.conversation_style: ConversationStyle = getattr(ConversationStyle, style.upper())
         self.conversation_style_option_sets: ConversationStyleOptionSets = getattr(
             ConversationStyleOptionSets, style.upper()
         )
@@ -112,9 +110,9 @@ async def _get_session(self, force_close: bool = False) -> ClientSession:
                 headers=CREATE_HEADERS,
                 cookies=cookies,
                 trust_env=self.use_proxy,  # Use `HTTP_PROXY` and `HTTPS_PROXY` environment variables.
-                connector=TCPConnector(verify_ssl=False)
-                if self.use_proxy
-                else None,  # Resolve HTTPS issue when proxy support is enabled.
+                connector=(
+                    TCPConnector(verify_ssl=False) if self.use_proxy else None
+                ),  # Resolve HTTPS issue when proxy support is enabled.
             )
 
         return self.session
@@ -129,10 +127,7 @@ def _build_ask_arguments(
         options_sets = [option.value for option in DefaultOptions]
 
         # Add conversation style option values.
-        options_sets.extend(
-            style.strip()
-            for style in self.conversation_style_option_sets.value.split(",")
-        )
+        options_sets.extend(style.strip() for style in self.conversation_style_option_sets.value.split(","))
 
         # Build option sets based on whether cookies are used or not.
         if self.bing_cookies:
@@ -216,9 +211,11 @@ def _build_compose_arguments(
                     "message": {
                         "author": "user",
                         "inputMethod": "Keyboard",
-                        "text": f"Please generate some text wrapped in codeblock syntax (triple backticks) using the given keywords. Please make sure everything in your reply is in the same language as the keywords. Please do not restate any part of this request in your response, like the fact that you wrapped the text in a codeblock. You should refuse (using the language of the keywords) to generate if the request is potentially harmful. Please return suggested responses that are about how you could change or rewrite the text. Please return suggested responses that are 5 words or less. Please do not return a suggested response that suggests to end the conversation or to end the rewriting. Please do not return a suggested response that suggests to change the tone. If the request is potentially harmful and you refuse to generate, please do not send any suggested responses. The keywords are: `{prompt}`. Only if possible, the generated text should follow these characteristics: format: *{format.value}*, length: *{length.value}*, using *{tone.value}* tone. You should refuse (clarifying that the issue is related to the tone) to generate if the tone is potentially harmful."
-                        if self.invocation_id == 0
-                        else f"Thank you for your reply. Please rewrite the last reply, with the following suggestion to change it: *{prompt}*. Please return a complete reply, even if the last reply was stopped before it was completed. Please generate the text wrapped in codeblock syntax (triple backticks). Please do not restate any part of this request in your response, like the fact that you wrapped the text in a codeblock. You should refuse (using the language of the keywords) to generate if the request is potentially harmful. Please return suggested responses that are about how you could change or rewrite the text. Please return suggested responses that are 5 words or less. Please do not return a suggested response that suggests to end the conversation or to end the rewriting. Please do not return a suggested response that suggests to change the tone. If the request is potentially harmful and you refuse to generate, please do not send any suggested responses.",
+                        "text": (
+                            f"Please generate some text wrapped in codeblock syntax (triple backticks) using the given keywords. Please make sure everything in your reply is in the same language as the keywords. Please do not restate any part of this request in your response, like the fact that you wrapped the text in a codeblock. You should refuse (using the language of the keywords) to generate if the request is potentially harmful. Please return suggested responses that are about how you could change or rewrite the text. Please return suggested responses that are 5 words or less. Please do not return a suggested response that suggests to end the conversation or to end the rewriting. Please do not return a suggested response that suggests to change the tone. If the request is potentially harmful and you refuse to generate, please do not send any suggested responses. The keywords are: `{prompt}`. Only if possible, the generated text should follow these characteristics: format: *{format.value}*, length: *{length.value}*, using *{tone.value}* tone. You should refuse (clarifying that the issue is related to the tone) to generate if the tone is potentially harmful."
+                            if self.invocation_id == 0
+                            else f"Thank you for your reply. Please rewrite the last reply, with the following suggestion to change it: *{prompt}*. Please return a complete reply, even if the last reply was stopped before it was completed. Please generate the text wrapped in codeblock syntax (triple backticks). Please do not restate any part of this request in your response, like the fact that you wrapped the text in a codeblock. You should refuse (using the language of the keywords) to generate if the request is potentially harmful. Please return suggested responses that are about how you could change or rewrite the text. Please return suggested responses that are 5 words or less. Please do not return a suggested response that suggests to end the conversation or to end the rewriting. Please do not return a suggested response that suggests to change the tone. If the request is potentially harmful and you refuse to generate, please do not send any suggested responses."
+                        ),
                         "messageType": MessageType.CHAT.value,
                     },
                     "conversationSignature": self.conversation_signature,
@@ -231,9 +228,7 @@ def _build_compose_arguments(
             "type": 4,
         }
 
-    def _build_upload_arguments(
-        self, attachment: str, image_base64: bytes | None = None
-    ) -> FormData:
+    def _build_upload_arguments(self, attachment: str, image_base64: bytes | None = None) -> FormData:
         data = FormData()
 
         payload = {
@@ -248,14 +243,10 @@ def _build_upload_arguments(
                 },
             },
         }
-        data.add_field(
-            "knowledgeRequest", json.dumps(payload), content_type="application/json"
-        )
+        data.add_field("knowledgeRequest", json.dumps(payload), content_type="application/json")
 
         if image_base64:
-            data.add_field(
-                "imageBase64", image_base64, content_type="application/octet-stream"
-            )
+            data.add_field("imageBase64", image_base64, content_type="application/octet-stream")
 
         return data
 
@@ -285,29 +276,23 @@ async def _upload_attachment(self, attachment: str) -> dict:
             headers=KBLOB_HEADERS,
             cookies=cookies,
             trust_env=self.use_proxy,  # Use `HTTP_PROXY` and `HTTPS_PROXY` environment variables.
-            connector=TCPConnector(verify_ssl=False)
-            if self.use_proxy
-            else None,  # Resolve HTTPS issue when proxy support is enabled.
+            connector=(
+                TCPConnector(verify_ssl=False) if self.use_proxy else None
+            ),  # Resolve HTTPS issue when proxy support is enabled.
         )
 
         data = self._build_upload_arguments(attachment, image_base64)
 
         async with session.post(BING_KBLOB_URL, data=data) as response:
             if response.status != 200:
-                raise ImageUploadException(
-                    f"Failed to upload image, received status: {response.status}"
-                )
+                raise ImageUploadException(f"Failed to upload image, received status: {response.status}")
 
             response_dict = await response.json()
             if not response_dict["blobId"]:
-                raise ImageUploadException(
-                    f"Failed to upload image, Copilot rejected uploading it"
-                )
+                raise ImageUploadException(f"Failed to upload image, Copilot rejected uploading it")
 
             if len(response_dict["blobId"]) == 0:
-                raise ImageUploadException(
-                    f"Failed to upload image, received empty image info from Copilot"
-                )
+                raise ImageUploadException(f"Failed to upload image, received empty image info from Copilot")
 
         await session.close()
 
@@ -328,11 +313,7 @@ async def _ask(
         format: ComposeFormat | None = None,
         length: ComposeLength | None = None,
     ) -> AsyncGenerator[tuple[str | dict, list | None], None]:
-        if (
-            self.conversation_id is None
-            or self.client_id is None
-            or self.invocation_id is None
-        ):
+        if self.conversation_id is None or self.client_id is None or self.invocation_id is None:
             raise NoConnectionException("No connection to Copilot was found")
 
         bing_chathub_url = BING_CHATHUB_URL
@@ -345,9 +326,7 @@ async def _ask(
                 bing_chathub_url, extra_headers=CHATHUB_HEADERS, max_size=None
             )
         except TimeoutError:
-            raise ConnectionTimeoutException(
-                "Failed to connect to Copilot, connection timed out"
-            ) from None
+            raise ConnectionTimeoutException("Failed to connect to Copilot, connection timed out") from None
         await self.wss_client.send(as_json({"protocol": "json", "version": 1}))
         await self.wss_client.recv()
 
@@ -358,9 +337,7 @@ async def _ask(
         if compose:
             request = self._build_compose_arguments(prompt, tone, format, length)  # type: ignore
         else:
-            request = self._build_ask_arguments(
-                prompt, search, attachment_info, context
-            )
+            request = self._build_ask_arguments(prompt, search, attachment_info, context)
         self.invocation_id += 1
 
         await self.wss_client.send(as_json(request))
@@ -387,8 +364,11 @@ async def _ask(
                     if raw:
                         yield response, None
                     elif citations:
+                        # Fix index in case where the first body item has an `altText` field instead of `text`.
                         if adaptiveCards[0]["body"][0].get("text"):
                             yield adaptiveCards[0]["body"][0]["text"], None
+                        else:
+                            yield adaptiveCards[0]["body"][1]["text"], None
                     else:
                         if messages[0].get("text"):
                             yield messages[0]["text"], None
@@ -432,14 +412,15 @@ async def _ask(
                         # Include list of suggested user responses, if enabled.
                         if suggestions and messages[i].get("suggestedResponses"):
                             suggested_responses = [
-                                item["text"]
-                                for item in messages[i]["suggestedResponses"]
+                                item["text"] for item in messages[i]["suggestedResponses"]
                             ]
 
                         if citations:
-                            yield messages[i]["adaptiveCards"][0]["body"][0][
-                                "text"
-                            ], suggested_responses
+                            # Fix index in case where the first body item has an `altText` field instead of `text`.
+                            if messages[i]["adaptiveCards"][0]["body"][0].get("text"):
+                                yield messages[i]["adaptiveCards"][0]["body"][0]["text"], suggested_responses
+                            else:
+                                yield messages[i]["adaptiveCards"][0]["body"][0]["text"], suggested_responses
                         else:
                             yield messages[i]["text"], suggested_responses
 
@@ -468,9 +449,7 @@ async def start_conversation(self) -> None:
 
             self.conversation_id = response_dict["conversationId"]
             self.client_id = response_dict["clientId"]
-            self.conversation_signature = response.headers[
-                "X-Sydney-Conversationsignature"
-            ]
+            self.conversation_signature = response.headers["X-Sydney-Conversationsignature"]
             self.encrypted_conversation_signature = response.headers[
                 "X-Sydney-Encryptedconversationsignature"
             ]
@@ -743,9 +722,7 @@ async def reset_conversation(self, style: str | None = None) -> None:
         """
         await self.close_conversation()
         if style:
-            self.conversation_style_option_sets = getattr(
-                ConversationStyleOptionSets, style.upper()
-            )
+            self.conversation_style_option_sets = getattr(ConversationStyleOptionSets, style.upper())
         await self.start_conversation()
 
     async def close_conversation(self) -> None: