Make mypy happy

Author: pamelafox

CHANGELOG.md

@@ -2,6 +2,14 @@
 
 All notable changes to this project will be documented in this file.
 
+## [0.1.7] - Aug 3, 2024
+
+- Fix bug where you couldn't pass in example tool calls in `few_shots` to `build_messages`.
+
+## [0.1.6] - Aug 2, 2024
+
+- Fix bug where you couldn't pass in `tools` and `default_to_cl100k` to True with a non-OpenAI model.
+
 ## [0.1.5] - June 4, 2024
 
 - Remove spurious `print` call when counting tokens for function calling.

CONTRIBUTING.md

@@ -17,11 +17,13 @@ python3 -m pytest
 
 ## Publishing
 
-1. Update the version number in pyproject.toml
+1. Update the CHANGELOG with description of changes
 
-2. Push the changes to the main branch
+2. Update the version number in pyproject.toml
 
-3. Publish to PyPi:
+3. Push the changes to the main branch
+
+4. Publish to PyPi:
 
     ```shell
     export FLIT_USERNAME=__token__

pyproject.toml

@@ -1,7 +1,7 @@
 [project]
 name = "openai-messages-token-helper"
 description = "A helper library for estimating tokens used by messages sent through OpenAI Chat Completions API."
-version = "0.1.6"
+version = "0.1.7"
 authors = [{name = "Pamela Fox"}]
 requires-python = ">=3.9"
 readme = "README.md"

src/openai_messages_token_helper/message_builder.py

@@ -7,6 +7,7 @@
     ChatCompletionAssistantMessageParam,
     ChatCompletionContentPartParam,
     ChatCompletionMessageParam,
+    ChatCompletionMessageToolCallParam,
     ChatCompletionNamedToolChoiceParam,
     ChatCompletionRole,
     ChatCompletionSystemMessageParam,
@@ -18,7 +19,9 @@
 from .model_helper import count_tokens_for_message, count_tokens_for_system_and_tools, get_token_limit
 
 
-def normalize_content(content: Union[str, Iterable[ChatCompletionContentPartParam]]):
+def normalize_content(content: Union[str, Iterable[ChatCompletionContentPartParam], None]):
+    if content is None:
+        return None
     if isinstance(content, str):
         return unicodedata.normalize("NFC", content)
     else:
@@ -51,9 +54,9 @@ def all_messages(self) -> list[ChatCompletionMessageParam]:
     def insert_message(
         self,
         role: ChatCompletionRole,
-        content: Union[str, Iterable[ChatCompletionContentPartParam]],
+        content: Union[str, Iterable[ChatCompletionContentPartParam], None],
         index: int = 0,
-        tool_calls: Optional[list[ChatCompletionToolParam]] = None,
+        tool_calls: Optional[Iterable[ChatCompletionMessageToolCallParam]] = None,
         tool_call_id: Optional[str] = None,
     ):
         """
@@ -116,8 +119,14 @@ def build_messages(
     for shot in reversed(few_shots):
         if shot["role"] is None or (shot.get("content") is None and shot.get("tool_calls") is None):
             raise ValueError("Few-shot messages must have role and either content or tool_calls")
+        tool_call_id = shot.get("tool_call_id")
+        if tool_call_id is not None and not isinstance(tool_call_id, str):
+            raise ValueError("tool_call_id must be a string value")
+        tool_calls = shot.get("tool_calls")
+        if tool_calls is not None and not isinstance(tool_calls, Iterable):
+            raise ValueError("tool_calls must be a list of tool calls")
         message_builder.insert_message(
-            shot["role"], shot.get("content"), tool_calls=shot.get("tool_calls"), tool_call_id=shot.get("tool_call_id")
+            shot["role"], shot.get("content"), tool_calls=tool_calls, tool_call_id=tool_call_id
         )
 
     append_index = len(few_shots)