default to None for all Optional fields explicitly

Author: dlqqq

packages/jupyter-ai-magics/jupyter_ai_magics/models/completion.py

@@ -21,12 +21,12 @@ class InlineCompletionRequest(BaseModel):
     # whether to stream the response (if supported by the model)
     stream: bool
     # path to the notebook of file for which the completions are generated
-    path: Optional[str]
+    path: Optional[str] = None
     # language inferred from the document mime type (if possible)
-    language: Optional[str]
+    language: Optional[str] = None
     # identifier of the cell for which the completions are generated if in a notebook
     # previous cells and following cells can be used to learn the wider context
-    cell_id: Optional[str]
+    cell_id: Optional[str] = None
 
 
 class InlineCompletionItem(BaseModel):
@@ -36,9 +36,9 @@ class InlineCompletionItem(BaseModel):
     """
 
     insertText: str
-    filterText: Optional[str]
-    isIncomplete: Optional[bool]
-    token: Optional[str]
+    filterText: Optional[str] = None
+    isIncomplete: Optional[bool] = None
+    token: Optional[str] = None
 
 
 class CompletionError(BaseModel):
@@ -59,7 +59,7 @@ class InlineCompletionReply(BaseModel):
     list: InlineCompletionList
     # number of request for which we are replying
     reply_to: int
-    error: Optional[CompletionError]
+    error: Optional[CompletionError] = None
 
 
 class InlineCompletionStreamChunk(BaseModel):
@@ -69,7 +69,7 @@ class InlineCompletionStreamChunk(BaseModel):
     response: InlineCompletionItem
     reply_to: int
     done: bool
-    error: Optional[CompletionError]
+    error: Optional[CompletionError] = None
 
 
 __all__ = [

packages/jupyter-ai-magics/jupyter_ai_magics/parsers.py

@@ -46,23 +46,23 @@ class CellArgs(BaseModel):
     type: Literal["root"] = "root"
     model_id: str
     format: FORMAT_CHOICES_TYPE
-    model_parameters: Optional[str]
+    model_parameters: Optional[str] = None
     # The following parameters are required only for SageMaker models
-    region_name: Optional[str]
-    request_schema: Optional[str]
-    response_path: Optional[str]
+    region_name: Optional[str] = None
+    request_schema: Optional[str] = None
+    response_path: Optional[str] = None
 
 
 # Should match CellArgs
 class ErrorArgs(BaseModel):
     type: Literal["error"] = "error"
     model_id: str
     format: FORMAT_CHOICES_TYPE
-    model_parameters: Optional[str]
+    model_parameters: Optional[str] = None
     # The following parameters are required only for SageMaker models
-    region_name: Optional[str]
-    request_schema: Optional[str]
-    response_path: Optional[str]
+    region_name: Optional[str] = None
+    request_schema: Optional[str] = None
+    response_path: Optional[str] = None
 
 
 class HelpArgs(BaseModel):
@@ -75,7 +75,7 @@ class VersionArgs(BaseModel):
 
 class ListArgs(BaseModel):
     type: Literal["list"] = "list"
-    provider_id: Optional[str]
+    provider_id: Optional[str] = None
 
 
 class RegisterArgs(BaseModel):

packages/jupyter-ai/jupyter_ai/chat_handlers/base.py

@@ -68,7 +68,7 @@ class HandlerRoutingType(BaseModel):
 class SlashCommandRoutingType(HandlerRoutingType):
     routing_method = "slash_command"
 
-    slash_id: Optional[str]
+    slash_id: Optional[str] = None
     """Slash ID for routing a chat command to this handler. Only one handler
     may declare a particular slash ID. Must contain only alphanumerics and
     underscores."""

packages/jupyter-ai/jupyter_ai/config_manager.py

@@ -98,9 +98,9 @@ class ConfigManager(Configurable):
         config=True,
     )
 
-    model_provider_id: Optional[str]
-    embeddings_provider_id: Optional[str]
-    completions_model_provider_id: Optional[str]
+    model_provider_id: Optional[str] = None
+    embeddings_provider_id: Optional[str] = None
+    completions_model_provider_id: Optional[str] = None
 
     def __init__(
         self,

packages/jupyter-ai/jupyter_ai/models.py

@@ -37,7 +37,7 @@ class CellWithErrorSelection(BaseModel):
 # the type of message used to chat with the agent
 class ChatRequest(BaseModel):
     prompt: str
-    selection: Optional[Selection]
+    selection: Optional[Selection] = None
 
 
 class StopRequest(BaseModel):
@@ -54,7 +54,7 @@ class StopRequest(BaseModel):
 
 class ClearRequest(BaseModel):
     type: Literal["clear"] = "clear"
-    target: Optional[str]
+    target: Optional[str] = None
     """
     Message ID of the HumanChatMessage to delete an exchange at.
     If not provided, this requests the backend to clear all messages.
@@ -67,8 +67,8 @@ class ChatUser(BaseModel):
     initials: str
     name: str
     display_name: str
-    color: Optional[str]
-    avatar_url: Optional[str]
+    color: Optional[str] = None
+    avatar_url: Optional[str] = None
 
 
 class ChatClient(ChatUser):
@@ -148,7 +148,7 @@ class HumanChatMessage(BaseModel):
     `prompt` and `selection`."""
     prompt: str
     """The prompt typed into the chat input by the user."""
-    selection: Optional[Selection]
+    selection: Optional[Selection] = None
     """The selection included with the prompt, if any."""
     client: ChatClient
 
@@ -238,8 +238,8 @@ class IndexMetadata(BaseModel):
 
 
 class DescribeConfigResponse(BaseModel):
-    model_provider_id: Optional[str]
-    embeddings_provider_id: Optional[str]
+    model_provider_id: Optional[str] = None
+    embeddings_provider_id: Optional[str] = None
     send_with_shift_enter: bool
     fields: Dict[str, Dict[str, Any]]
     # when sending config over REST API, do not include values of the API keys,
@@ -248,7 +248,7 @@ class DescribeConfigResponse(BaseModel):
     # timestamp indicating when the configuration file was last read. should be
     # passed to the subsequent UpdateConfig request.
     last_read: int
-    completions_model_provider_id: Optional[str]
+    completions_model_provider_id: Optional[str] = None
     completions_fields: Dict[str, Dict[str, Any]]
 
 
@@ -258,16 +258,16 @@ def forbid_none(cls, v):
 
 
 class UpdateConfigRequest(BaseModel):
-    model_provider_id: Optional[str]
-    embeddings_provider_id: Optional[str]
-    send_with_shift_enter: Optional[bool]
-    api_keys: Optional[Dict[str, str]]
-    fields: Optional[Dict[str, Dict[str, Any]]]
+    model_provider_id: Optional[str] = None
+    embeddings_provider_id: Optional[str] = None
+    send_with_shift_enter: Optional[bool] = None
+    api_keys: Optional[Dict[str, str]] = None
+    fields: Optional[Dict[str, Dict[str, Any]]] = None
     # if passed, this will raise an Error if the config was written to after the
     # time specified by `last_read` to prevent write-write conflicts.
-    last_read: Optional[int]
-    completions_model_provider_id: Optional[str]
-    completions_fields: Optional[Dict[str, Dict[str, Any]]]
+    last_read: Optional[int] = None
+    completions_model_provider_id: Optional[str] = None
+    completions_fields: Optional[Dict[str, Dict[str, Any]]] = None
 
     _validate_send_wse = validator("send_with_shift_enter", allow_reuse=True)(
         forbid_none
@@ -280,12 +280,12 @@ class GlobalConfig(BaseModel):
     """Model used to represent the config by ConfigManager. This is exclusive to
     the backend and should never be sent to the client."""
 
-    model_provider_id: Optional[str]
-    embeddings_provider_id: Optional[str]
+    model_provider_id: Optional[str] = None
+    embeddings_provider_id: Optional[str] = None
     send_with_shift_enter: bool
     fields: Dict[str, Dict[str, Any]]
     api_keys: Dict[str, str]
-    completions_model_provider_id: Optional[str]
+    completions_model_provider_id: Optional[str] = None
     completions_fields: Dict[str, Dict[str, Any]]
 
 

packages/jupyter-ai/jupyter_ai/tests/test_handlers.py

@@ -34,7 +34,7 @@ class MockProvider(BaseProvider, FakeListLLM):
     name = "My Provider"
     model_id_key = "model"
     models = ["model"]
-    should_raise: Optional[bool]
+    should_raise: Optional[bool] = None
 
     def __init__(self, **kwargs):
         if "responses" not in kwargs: